tencent cloud

云点播

文档云点播服务端 API 文档Parameter Template APIsCreateImageSpriteTemplate

CreateImageSpriteTemplate

Download
聚焦模式
字号
最后更新时间： 2026-05-19 15:01:18

1. API Description

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.

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: 2018-07-17.
Region No String Common Params. This parameter is not required.
SampleType Yes String Sampling type, Valid value:
  • Percent: by percent.
  • Time: By time interval.
    		•
    SampleInterval Yes Integer Sampling interval.
  • When SampleType is Percent, specify the percentage of the sampling interval.
  • When SampleType is Time, specify the sampling interval in seconds.
    		•
    RowCount Yes Integer Number of rows of small images in sprite image.
    Note: The number of rows of subimages impacts the final height of the main image. The maximum height of the main image is 15000 pixels. The height of the main image is the product of the number of rows and the height of subimages.
    ColumnCount Yes Integer Number of columns of small images in sprite image.
    Note: The columns of small images impact the final width of the large image. The maximum width of the large image is 15000 pixels. The width of the large image is the product of the columns and width of small images.
    SubAppId No Integer On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created).
    Name No String Sprite image template name. The length cannot exceed 64 characters.
    Comment No String Template description, with a length limit of 256 characters.
    FillType No String Filling method. When video stream configuration width and height parameters are inconsistent with the aspect ratio of the original video, the processing method for transcoding is "filling". Optional filling mode:
  • stretch: Stretch each frame to fill the entire screen, possibly causing the transcoded video to be "squashed" or "stretched";
  • black: Maintain video aspect ratio with edges filled with black.
    • Default value: black.
    Width No Integer Maximum value of the width (or long edge) of small images in sprite image. Value ranges from 0 to [128, 4096]. Measurement unit: px.
  • When both Width and Height are 0, resolution is same as source.
  • When Width is 0 and Height is not 0, Width is proportionally scaled.
  • When Width is not 0 and Height is 0, Height is proportionally scaled.
  • When both Width and Height are not 0, resolution is specified by user.
    • Default value: 0. Note: The width of small images will impact the final width of the large image. The maximum width of the large image is 15000 pixels, where the width of the large image is the product of the number of columns and the width of small images.
    Height No Integer Maximum height (or short side) of small images in sprite image. Value ranges from 0 to [128, 4096]. Measurement unit: px.
  • When both Width and Height are 0, resolution is same as source.
  • When Width is 0 and Height is not 0, Width is proportionally scaled.
  • When Width is not 0 and Height is 0, Height is proportionally scaled.
  • When both Width and Height are not 0, resolution is specified by user.
    • Default value: 0. Note: The height of small images impacts the final height of the large image. The maximum height of the large image is 15000 pixels, where the height of the large image is the product of subimage rows and the height of small images.
    ResolutionAdaptive No String Resolution adaptation, available values:
  • open: enable. At this point, Width represents the long side of the video, and Height indicates the short side.
  • close: Closed. At this point, Width represents the Width of the video, and Height indicates the Height of the video.

    • Default value: open.
    Format No String Image format. Valid values:
  • jpg: JPG format;
  • png: png format.
  • WEBP: webp format.

    • Default value: jpg.

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer Unique identifier of a sprite 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.

    4. Example

    Example1 Create an image sprite template

    Create an image sprite template

    Input Example

    POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateImageSpriteTemplate
<Common request parameters>

{
    "ColumnCount": 10,
    "Name": "Sprite Sheet Template 1",
    "RowCount": 5,
    "SampleType": "Percent",
    "Height": 128,
    "Width": 128,
    "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.

    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 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.
    上一篇: CreateSampleSnapshotTemplate下一篇: CreateAnimatedGraphicsTemplate

    帮助和支持

    本页内容是否解决了您的问题？

    填写满意度调查问卷，共创更好文档体验。

    文档反馈