CreateAnimatedGraphicsTemplate

Last updated: 2020-03-27 18:45:40

1. API Description

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

This API is used to create a custom animated image generating template. Up to 16 templates can be created.

A maximum of 100 requests can be initiated per second for this API.

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 parameter. The value used for this API: CreateAnimatedGraphicsTemplate.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
Fps Yes Integer Video frame rate in Hz. Value range: [1, 30].
Width No Integer Maximum value of the width (or long side) of an animated image in px. Value range: 0 and [128, 4,096].
  • If both Width and Height are 0, the resolution will be the same as that of the source video;
  • If Width is 0, but Height is not 0, Width will be proportionally scaled;
  • If Width is not 0, but Height is 0, Height will be proportionally scaled;
  • If both Width and Height are not 0, the custom resolution will be used.

  • Default value: 0.
    Height No Integer Maximum value of the height (or short side) of an animated image in px. Value range: 0 and [128, 4,096].
  • If both Width and Height are 0, the resolution will be the same as that of the source video;
  • If Width is 0, but Height is not 0, Width will be proportionally scaled;
  • If Width is not 0, but Height is 0, Height will be proportionally scaled;
  • If both Width and Height are not 0, the custom resolution will be used.

  • Default value: 0.
    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 Animated image format. Valid values: gif; webp. Default value: gif.
    Quality No Float Image quality. Value range: [1, 100]. Default value: 75.
    Name No String Name of an animated image generating template. Length limit: 64 characters.
    Comment No String Template description. Length limit: 256 characters.
    SubAppId No Integer ID of a subapplication in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer Unique ID of an animated image generating template.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating an animated image generating template

    Input Example

    https://vod.tencentcloudapi.com/?Action=CreateAnimatedGraphicsTemplate
    &Name=Animated image generating template 1
    &Width=540
    &Height=960
    &Format=gif
    &Fps=30
    &<Common request parameters>

    Output Example

    {
      "Response": {
        "Definition": 1008,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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.Comment Invalid parameter: template description.
    InvalidParameterValue.Format Incorrect parameter value: Format.
    InvalidParameterValue.FormatWebpLackWidthAndHeight Incorrect parameter value: Format is webp, but both Width and Height are empty.
    InvalidParameterValue.FormatWebpWidthAndHeightBothZero Incorrect parameter value: when Format is webp, Width and Height cannot be both 0.
    InvalidParameterValue.Fps Invalid parameter: video frame rate.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.Quality Incorrect parameter value: Quality.
    InvalidParameterValue.Resolution Invalid parameter: incorrect resolution.
    LimitExceeded.TooMuchTemplate Limit exceeded: the number of templates exceeds the limit.
    UnauthorizedOperation Unauthorized operation.