Release Notes
お知らせ
Domain name for API request: mps.intl.tencentcloudapi.com.
This API is used to modify a custom image sprite generating template.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ModifyImageSpriteTemplate. |
| Version | Yes | String | Common Params. The value used for this API: 2019-06-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Definition | Yes | Integer | Unique ID of an image sprite generating template. |
| Name | No | String | Name of an image sprite generating template. Length limit: 64 characters. |
| Width | No | Integer | Subimage width of an image sprite in px. Value range: [128, 4,096]. |
| Height | No | Integer | Subimage height of an image sprite in px. Value range: [128, 4,096]. |
| ResolutionAdaptive | No | String | Resolution adaption. Valid values:Width represents the long side of a video, while Height the short side;Width represents the width of a video, while Height the height.Default value: open. |
| SampleType | No | String | Sampling type. Valid values: |
| SampleInterval | No | Integer | Sampling interval.SampleType is Percent, sampling will be performed at an interval of the specified percentage.SampleType is Time, sampling will be performed at the specified time interval in seconds. |
| RowCount | No | Integer | Subimage row count of an image sprite. |
| ColumnCount | No | Integer | Subimage column count of an image sprite. |
| FillType | No | String | Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: Default value: black. |
| Comment | No | String | Template description. Length limit: 256 characters. |
| Format | No | String | The image format. Valid values: jpg, png, webp. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyImageSpriteTemplate
<Common request parameters>
{
"ColumnCount": "10",
"Definition": "10001",
"Name": "Image sprite generating template 1",
"RowCount": "5",
"SampleType": "Percent",
"Height": "96",
"Width": "54",
"SampleInterval": "10"
}
{
"Response": {
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.InvalidMpsUser | Operation failed: unauthorized MPS user. |
| InternalError | Internal error. |
| InvalidParameterValue.ColumnCount | Incorrect parameter value: ColumnCount. |
| InvalidParameterValue.Height | Parameter error: height. |
| InvalidParameterValue.Name | Incorrect parameter value: Name exceeds the length limit. |
| InvalidParameterValue.Resolution | Parameter error: Incorrect resolution. |
| InvalidParameterValue.RowCount | Incorrect parameter value: RowCount. |
| InvalidParameterValue.SampleInterval | Incorrect parameter value: SampleInterval. |
| InvalidParameterValue.SampleType | Incorrect parameter value: SampleType. |
| InvalidParameterValue.Width | Parameter error: Wwdth. |
| ResourceNotFound.TemplateNotExist | The resource does not exist: the template does not exist. |
フィードバック