Overview
Menu

ModifyAnimatedGraphicsTemplate

Last updated: 2023-10-12 16:44:40Download PDF

1. API Description

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

This API is used to modify a custom animated image 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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: ModifyAnimatedGraphicsTemplate.
VersionYesStringCommon Params. The value used for this API: 2019-06-12.
RegionNoStringCommon Params. This parameter is not required for this API.
DefinitionYesIntegerUnique ID of an animated image generating template.
NameNoStringName of an animated image generating template. Length limit: 64 characters.
WidthNoIntegerMaximum 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.
    HeightNoIntegerMaximum value of the height (or short side) of a video stream 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.
    ResolutionAdaptiveNoStringResolution 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.
    FormatNoStringAnimated image format. Valid values: gif, webp.
    FpsNoIntegerVideo frame rate in Hz. Value range: [1, 30].
    QualityNoFloatImage quality. Value range: [1, 100]. Default value: 75.
    CommentNoStringTemplate description. Length limit: 256 characters.

    3. Output Parameters

    Parameter NameTypeDescription
    RequestIdStringThe unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying an animated image generating template

    Input Example

    https://mps.tencentcloudapi.com/?Action=ModifyAnimatedGraphicsTemplate
    &Definition=10001
    &Name=Animated image generating template 1
    &Width=540
    &Height=960
    &Fps=30
    &<Common request parameters>
    

    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 CodeDescription
    FailedOperation.InvalidMpsUserOperation failed: unauthorized MPS user.
    InternalErrorInternal error.
    InvalidParameterValue.CommentParameter error: template description.
    InvalidParameterValue.FormatIncorrect parameter value: Format.
    InvalidParameterValue.FormatWebpLackWidthAndHeightIncorrect parameter value: Format is webp, but both Width and Height are empty.
    InvalidParameterValue.FormatWebpWidthAndHeightBothZeroIncorrect parameter value: when Format is webp, Width and Height cannot be both 0.
    InvalidParameterValue.FpsParameter error: video frame rate.
    InvalidParameterValue.NameIncorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.QualityIncorrect parameter value: Quality.
    InvalidParameterValue.ResolutionParameter error: Incorrect resolution.
    ResourceNotFound.TemplateNotExistThe resource does not exist: the template does not exist.