CreateImageSpriteTemplate
Last updated: 2023-10-12 16:44:45Download PDF
1. API Description
Domain name for API request: mps.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 Params. The value used for this API: CreateImageSpriteTemplate. |
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. |
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. |
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. |
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 (default), png, webp. |
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
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateImageSpriteTemplate
<Common request parameters>
{
"ColumnCount": "10",
"Name": "Image sprite generating template 1",
"RowCount": "5",
"SampleType": "Percent",
"Height": "96",
"Width": "54",
"SampleInterval": "10"
}
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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
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 |
---|---|
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. |
LimitExceeded.TooMuchTemplate | Limit reached: the number of templates exceeds the limit. |