产品动态
公告
Domain name for API request: vod.intl.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 Params. The value used for this API: CreateImageSpriteTemplate. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| 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 | The number of rows of small images in the sprite image. Note: The number of rows of the small image will affect the height of the final large image. The maximum height of the large image is 15,000 pixels. The height of the large image is the product of the number of rows of the small image and the height of the small image. |
| ColumnCount | Yes | Integer | The number of columns of small images in the sprite image. Note: The number of columns of the small image will affect the width of the final large image. The maximum width of the large image is 15,000 pixels. The width of the large image is the product of the number of columns of the small image and the width of the small image. |
| SubAppId | No | Integer | The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID. |
| 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 | The maximum value of the width (or long side) of the small image in the sprite image, value range: 0 and [128, 4096], unit: px. < li>When Width is non-0 and Height is 0, the Height is scaled proportionally; Default value: 0. Note: The width of the small image will affect the width of the final large image. The maximum width of the large image is 15,000 pixels. The width of the large image is the product of the number of columns of the small image and the width of the small image. |
| Height | No | Integer | The maximum value of the height (or short side) of the small image in the sprite image, value range: 0 and [128, 4096], unit: px. < li>When Width is non-0 and Height is 0, the Height is scaled proportionally; Default value: 0. Note: The height of the small image will affect the height of the final large image. The maximum height of the large image is 15,000 pixels. The height of the large image is the product of the number of rows of the small image and the height of the small image. |
| 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. |
| Format | No | String | The image format. Valid values: Default: jpg |
| Parameter Name | Type | Description |
|---|---|---|
| Definition | Integer | Unique ID of an image sprite generating template. |
| 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. |
Create Image Sprite Template
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateImageSpriteTemplate
<Public Request Parameter>
{
"ColumnCount": "10",
"Name": "Sprite chart template 1",
"RowCount": "5",
"SampleType": "Percent",
"Height": "128",
"Width": "128",
"SampleInterval": "10"
}{
"Response": {
"Definition": 1008,
"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 | Operation failed. |
| InternalError | Internal error. |
| InvalidParameterValue.ColumnCount | Incorrect parameter value: ColumnCount. |
| InvalidParameterValue.Comment | Invalid parameter: template description. |
| 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 upper limit of 100. If you need more, pleaseSubmit a ticket. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈