tencent cloud

APIs

DokumentasiAPIsVideo on DemandParameter Template APIsModifyImageSpriteTemplate

ModifyImageSpriteTemplate

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-09-18 15:59:12

1. API Description

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

Modify a custom image sprite 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 Sprite template unique identifier.
SubAppId No Integer VOD application ID. For customers who activate VOD services from December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application).
Name No String Sprite image template name. Length limit: 64 characters.
Width No Integer Width of small images in sprite image. Value range: [32, 4096]. Unit: px.
Height No Integer Height of small images in sprite image. Value range: [32, 4096]. Unit: px.
ResolutionAdaptive No String Resolution adaptation. Available values:
  • open: enabled. At this point, Width represents the long side of the video, and Height represents the short side of the video;
  • close: closed. 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 values:
  • 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 time of the sampling interval in seconds.
    		•
    RowCount No Integer Number of rows of small images in the sprite image.
    ColumnCount No Integer Number of columns of small images in the sprite image.
    FillType No String Filling method. When the 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, which may cause the transcoded video to be "squashed" or "stretched";
  • black: keep the video aspect ratio unchanged and fill the remaining edges with black.
  • white: keep the video aspect ratio unchanged and fill the remaining edges with white.
  • gauss: keep the video aspect ratio unchanged and apply Gaussian blur to the remaining edges.
    • Default value: black.
    Comment No String Template description, with a length limit of 256 characters.
    Format No String Image format. Valid values:
  • 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 Modifying a Sprite 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 Invalid parameter value: ColumnCount.
    InvalidParameterValue.Height Parameter error: height.
    InvalidParameterValue.Name Parameter value error: Name exceeds the length limit.
    InvalidParameterValue.Resolution Parameter error: Resolution error.
    InvalidParameterValue.RowCount Invalid parameter value: RowCount.
    InvalidParameterValue.SampleInterval Invalid parameter value: SampleInterval.
    InvalidParameterValue.SampleType Parameter value error: SampleType.
    InvalidParameterValue.Width Parameter error: width.
    ResourceNotFound.TemplateNotExist Resource does not exist: template does not exist.
    UnauthorizedOperation Unauthorized operation.
    Topik sebelumnya: ModifySampleSnapshotTemplateTopik selanjutnya: ModifyAnimatedGraphicsTemplate

    Bantuan dan Dukungan

    Apakah halaman ini membantu?

    masukan

    Search
      Enter keywords to search documentation