tencent cloud



Last updated: 2022-08-23 16:02:49

1. API Description

Domain name for API request: vod.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 for this API.
Definition Yes Integer Unique ID of an image sprite generating template.
SubAppId No Integer The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.
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:
  • 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.
    SampleType No String Sampling type. Valid values:
  • Percent: by percent.
  • Time: by time interval.
  • SampleInterval No 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 No Integer Subimage row count of an image sprite.
    ColumnCount No Integer Subimage column count of an image sprite.
    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.
    Comment No String Template description. Length limit: 256 characters.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying an image sprite generating template

    Input Example

    &Name=Image sprite generating template 1
    &<Common request parameters>

    Output Example

        "Response": {
            "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"

    5. Developer Resources


    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.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support