Domain name for API request: vod.tencentcloudapi.com.
This API is used to create a custom image sprite generating template. Up to 16 templates can be created.
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 parameter. The value used for this API: CreateImageSpriteTemplate. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-07-17. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| SampleType | Yes | String | Sampling type. Valid values: |
| SampleInterval | Yes | 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 | Yes | Integer | Subimage row count of an image sprite. |
| ColumnCount | Yes | Integer | Subimage column count of an image sprite. |
| Name | No | String | Name of an image sprite generating template. Length limit: 64 characters. |
| Comment | No | String | Template description. Length limit: 256 characters. |
| 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. |
| Width | No | Integer | Maximum value of the width (or long side) of a subimage in an image sprite in px. Value range: 0 and [128, 4,096].Width and Height are 0, the resolution will be the same as that of the source video;Width is 0, but Height is not 0, Width will be proportionally scaled;Width is not 0, but Height is 0, Height will be proportionally scaled;Width and Height are not 0, the custom resolution will be used.Default value: 0. |
| Height | No | Integer | Maximum value of the height (or short side) of a subimage in an image sprite in px. Value range: 0 and [128, 4,096].Width and Height are 0, the resolution will be the same as that of the source video;Width is 0, but Height is not 0, Width will be proportionally scaled;Width is not 0, but Height is 0, Height will be proportionally scaled;Width and Height are not 0, the custom resolution will be used.Default value: 0. |
| 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. |
| SubAppId | No | Integer | ID of a subapplication in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. |
| Parameter Name | Type | Description |
|---|---|---|
| Definition | Integer | Unique ID of an image sprite generating template. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://vod.tencentcloudapi.com/?Action=CreateImageSpriteTemplate
&Name=Image sprite generating template 1
&Width=128
&Height=128
&SampleType=Percent
&SampleInterval=10
&RowCount=5
&ColumnCount=10
&<Common request parameters>{
"Response": {
"Definition": 1008,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameterValue.ColumnCount | Incorrect parameter value: ColumnCount. |
| InvalidParameterValue.Height | Invalid parameter: height. |
| InvalidParameterValue.Name | Incorrect parameter value: Name exceeds the length limit. |
| InvalidParameterValue.Resolution | Invalid parameter: incorrect resolution. |
| InvalidParameterValue.RowCount | Incorrect parameter value: RowCount. |
| InvalidParameterValue.SampleInterval | Incorrect parameter value: SampleInterval. |
| InvalidParameterValue.SampleType | Incorrect parameter value: SampleType. |
| InvalidParameterValue.Width | Invalid parameter: width. |
| LimitExceeded.TooMuchTemplate | Limit exceeded: the number of templates exceeds the limit. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?