tencent cloud

APIs

ドキュメントAPIsVideo on DemandParameter Template APIsCreateSampleSnapshotTemplate

CreateSampleSnapshotTemplate

Download
フォーカスモード
フォントサイズ
最終更新日: 2026-05-19 15:01:14

1. API Description

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

This API is used to create a custom sampled screencapturing 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: CreateSampleSnapshotTemplate.
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 screenshot type, Valid value:
  • Percent: by percent.
  • Time: By time interval.
    		•
    SampleInterval Yes Integer Sampling interval.
  • When SampleType is Percent, specify the percentage of the sampling interval.
  • When SampleType is Time, specify the sampling interval in seconds.
    		•
    SubAppId No Integer VOD application ID. Customers who activate VOD services after December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (whether default or newly created).
    Name No String Sample screenshot template name. Length limit: 64 characters.
    Width No Integer Maximum value of the screenshot width (or long edge) in px. Value range: 0 and [128, 4096].
  • If both Width and Height are 0, the resolution is the same as the source.
  • If Width is 0 but Height is not 0, the width will be proportionally scaled.
  • If Width is not 0 but Height is 0, the height will be proportionally scaled.
  • If both Width and Height are not 0, the resolution is as specified by the user.

    • The default value is 0.
    Height No Integer The maximum value of screenshot height (or short side), value ranges from 0 to [128, 4096], measurement unit: px.
  • If both Width and Height are 0, the resolution is the same as the source.
  • If Width is 0 but Height is not 0, the width will be proportionally scaled.
  • If Width is not 0 but Height is 0, the height will be proportionally scaled.
  • If both Width and Height are not 0, the resolution is as specified by the user.

    • The default value is 0.
    ResolutionAdaptive No String Resolution adaptation, available values:
  • open: start. At this point, Width represents the long side of the video, and Height indicates the short side of the video;
  • close: Close. At this point, Width represents the width of the video, and Height indicates the height of the video.

    • Default value: open.
    Format No String Image format. Value can be jpg and png. Default is jpg.
    Comment No String Template description, with a length limit of 256 characters.
    FillType No String Filling method. When the video stream configuration width and height parameters are inconsistent with the aspect ratio of the original video, the processing method for transcoding is "padding". Optional filling mode:
  • stretch: Stretch each frame to fill the entire screen, possibly causing the transcoded video to be "squashed" or "stretched";
  • black: Keep black, maintain video aspect ratio, edges filled with black.
  • white: Leave blank, maintain video aspect ratio, edge remainder filled with white.
  • gauss: Gaussian blur, maintain video aspect ratio, and use Gaussian blur for the remaining edge part.

    • Default value: black.

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer Unique identifier of the sampling screenshot 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 Creating a sampled screenshot template (with dimensions specified)

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=CreateSampleSnapshotTemplate
&Name=Screenshot with specific dimensions
&Width=540
&Height=960
&SampleType=Percent
&SampleInterval=10
&Format=jpg
&<Common request parameters>

    Output Example

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

    Example2 Creating a sampled screenshot template (with the long side of the screenshot specified)

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=CreateSampleSnapshotTemplate
&Name=Screencapture by image long side
&Width=1920
&Height=0
&SampleType=Percent
&SampleInterval=10
&Format=jpg
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Definition": 1009,
        "RequestId": "45ae8d8e-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.Comment Invalid parameter: template description.
    InvalidParameterValue.Format Incorrect parameter value: Format.
    InvalidParameterValue.Height Invalid parameter: height.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.Resolution Invalid parameter: incorrect resolution.
    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.
    前の記事へ: CreateSnapshotByTimeOffsetTemplate次の記事へ: CreateImageSpriteTemplate

    ヘルプとサポート

    この記事はお役に立ちましたか？

    フィードバック