1. API Description

Domain name for API request: mps.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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: CreateImageSpriteTemplate.
VersionYesStringCommon Params. The value used for this API: 2019-06-12.
RegionNoStringCommon Params. This parameter is not required for this API.
SampleTypeYesStringSampling type. Valid values:
  • Percent: By percent.
  • Time: By time interval.
  • SampleIntervalYesIntegerSampling 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.
  • RowCountYesIntegerSubimage row count of an image sprite.
    ColumnCountYesIntegerSubimage column count of an image sprite.
    NameNoStringName of an image sprite generating template. Length limit: 64 characters.
    WidthNoIntegerSubimage width of an image sprite in px. Value range: [128, 4,096].
    HeightNoIntegerSubimage height of an image sprite in px. Value range: [128, 4,096].
    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.
    FillTypeNoStringFill 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.
    CommentNoStringTemplate description. Length limit: 256 characters.
    FormatNoStringThe image format. Valid values: jpg (default), png, webp.

    3. Output Parameters

    Parameter NameTypeDescription
    DefinitionIntegerUnique ID of an image sprite generating template.
    RequestIdStringThe unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating an image sprite generating template

    Input Example

    POST / HTTP/1.1
    Host: mps.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateImageSpriteTemplate
    <Common request parameters>
        "ColumnCount": "10",
        "Name": "Image sprite generating template 1",
        "RowCount": "5",
        "SampleType": "Percent",
        "Height": "96",
        "Width": "54",
        "SampleInterval": "10"

    Output Example

        "Response": {
            "Definition": 1008,
            "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 CodeDescription
    FailedOperation.InvalidMpsUserOperation failed: unauthorized MPS user.
    InternalErrorInternal error.
    InvalidParameterValue.ColumnCountIncorrect parameter value: ColumnCount.
    InvalidParameterValue.HeightParameter error: height.
    InvalidParameterValue.NameIncorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.ResolutionParameter error: Incorrect resolution.
    InvalidParameterValue.RowCountIncorrect parameter value: RowCount.
    InvalidParameterValue.SampleIntervalIncorrect parameter value: SampleInterval.
    InvalidParameterValue.SampleTypeIncorrect parameter value: SampleType.
    InvalidParameterValue.WidthParameter error: Wwdth.
    LimitExceeded.TooMuchTemplateLimit reached: the number of templates exceeds the limit.