tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Video on Demand
    Documentation
    Download PDF

    CreateImageSpriteTemplate

    Last updated: 2024-03-27 16:08:22
    Download PDF

      1. API Description

      Domain name for API request: vod.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 values:
    • Percent: by percent.
    • Time: by time interval.
      		•
      SampleInterval Yes 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 Yes Integer The number of rows of small images in the sprite image.
      Note: The number of rows of the small image will affect the height of the final large image. The maximum height of the large image is 15,000 pixels. The height of the large image is the product of the number of rows of the small image and the height of the small image.
      ColumnCount Yes Integer The number of columns of small images in the sprite image.
      Note: The number of columns of the small image will affect the width of the final large image. The maximum width of the large image is 15,000 pixels. The width of the large image is the product of the number of columns of the small image and the width of the small image.
      SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
      Name No String Name of an image sprite generating template. Length limit: 64 characters.
      Comment No String Template description. Length limit: 256 characters.
      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.
      Width No Integer The maximum value of the width (or long side) of the small image in the sprite image, value range: 0 and [128, 4096], unit: px.
    • When Width and Height are both 0, the resolution is from the same source;
    • When Width is 0 and Height is non-0, Width is scaled proportionally;

      • < li>When Width is non-0 and Height is 0, the Height is scaled proportionally;
    • When both Width and Height are non-0, the resolution is specified by the user.

      • Default value: 0.
      Note: The width of the small image will affect the width of the final large image. The maximum width of the large image is 15,000 pixels. The width of the large image is the product of the number of columns of the small image and the width of the small image.
      Height No Integer The maximum value of the height (or short side) of the small image in the sprite image, value range: 0 and [128, 4096], unit: px.
    • When Width and Height are both 0, the resolution is from the same source;
    • When Width is 0 and Height is non-0, Width is scaled proportionally;

      • < li>When Width is non-0 and Height is 0, the Height is scaled proportionally;
    • When both Width and Height are non-0, the resolution is specified by the user.

      • Default value: 0.
      Note: The height of the small image will affect the height of the final large image. The maximum height of the large image is 15,000 pixels. The height of the large image is the product of the number of rows of the small image and the height of the small image.
      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.
      Format No String The image format. Valid values:
    • jpg
    • png
    • webp

      • Default: jpg

      3. Output Parameters

      Parameter Name Type Description
      Definition Integer Unique ID of an image sprite generating 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 CreateImageSpriteTemplate

      Create Image Sprite Template

      Input Example

      POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateImageSpriteTemplate
<Public Request Parameter>

{
    "ColumnCount": "10",
    "Name": "Sprite chart 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.
      Contact Us

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

      Contact Us
      Technical Support

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

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy