tencent cloud

云点播

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

ModifyImageSpriteTemplate

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

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to modify a custom image sprite generating template.

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: ModifyImageSpriteTemplate.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
Definition Yes Integer Unique identifier of the sprite template.
SubAppId No Integer VOD application ID. Customers who activate VOD services after December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (whether default or newly created).
Name No String Sprite image template name. Length limit: 64 characters.
Width No Integer Width of small images in sprite image, in the range of [32, 4096], unit: px.
Height No Integer Height of small images in sprite image, in the range of [32, 4096], unit: px.
ResolutionAdaptive No String Resolution adaptation, available values:
  • open: start. At this point, Width represents the long side of the video, and Height indicates the short side of the video;
  • close: Close. At this point, Width represents the width of the video, and Height indicates the height of the video.

    • Default value: open.
    SampleType No String Sampling type, Valid value:
  • Percent: by percent.
  • Time: By time interval.
    		•
    SampleInterval No 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 No Integer Number of rows of small images in sprite image.
    ColumnCount No Integer Number of columns of small images in sprite image.
    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 "fill". Optional filling modes:
  • stretch: stretch each frame to fill the entire screen, possibly causing the transcoded video to be squashed or stretched;
  • black: maintain video aspect ratio, remaining edge part filled with black;
  • white: maintain video aspect ratio, remaining edge part filled with white;
  • gauss: maintain video aspect ratio, remaining edge part filled with Gaussian blur.
    • Default value: black.
    Comment No String Template description, with a length limit of 256 characters.
    Format No String Image format. Value:
  • jpg: jpg format;
  • png: png format.
  • WEBP: webp format.
    		•

    3. Output Parameters

    Parameter Name Type Description
    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 Modify a sprite sheet template

    Input Example

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

{
    "ColumnCount": 10,
    "Definition": 10001,
    "Name": "Sprite sheet template 1",
    "RowCount": 5,
    "SampleType": "Percent",
    "Height": 128,
    "Width": 128,
    "SampleInterval": 10
}

    Output Example

    {
    "Response": {
        "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
    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.
    ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.
    UnauthorizedOperation Unauthorized operation.
    上一篇: ModifySampleSnapshotTemplate下一篇: ModifyAnimatedGraphicsTemplate

    帮助和支持

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

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

    文档反馈