Documentation | Tencent Cloud

search by keyword

Recent Pages

Documentation

CreateImageSpriteTemplate

Last updated: 2020-12-23 15:36:51

1. API Description

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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: Percent: by percent. Time: by time interval.
SampleInterval	Yes	Integer	Sampling interval. If `SampleType` is `Percent`, sampling will be performed at an interval of the specified percentage. If `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: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot "shorter" or "longer"; black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. 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]. If both `Width` and `Height` are 0, the resolution will be the same as that of the source video; If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled; If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled; If both `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]. If both `Width` and `Height` are 0, the resolution will be the same as that of the source video; If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled; If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled; If both `Width` and `Height` are not 0, the custom resolution will be used. Default value: 0.
ResolutionAdaptive	No	String	Resolution adaption. Valid values: open: enabled. In this case, `Width` represents the long side of a video, while `Height` the short side; close: disabled. In this case, `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.

3. Output Parameters

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.

4. Example

Example1 Creating an image sprite generating template

Input Example

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>

Output Example

{
  "Response": {
    "Definition": 1008,
    "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.