tencent cloud

APIs

文档APIsVideo on DemandParameter Template APIsCreateSampleSnapshotTemplate

CreateSampleSnapshotTemplate

下载
聚焦模式
字号
最后更新时间： 2026-09-18 15:59:28

1. API Description

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

This API is used to create a custom sampled screenshot template. Maximum number: 16.

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. 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 time of the sampling interval in seconds.
    		•
    SubAppId No Integer

    On-demand application ID. For customers who activate on-demand services on or after December 25, 2023, when accessing resources in on-demand applications (whether the default application or a newly created application), this field must be set to the app ID.
    Name No String

    Sample screenshot template name. Length limit: 64 characters.
    Width No Integer

    The maximum value of the screenshot width (or long side). Valid values: 0 and [32, 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;
  • When Width is non-0 and Height is 0, Height is scaled proportionally;
  • When both Width and Height are non-0, the resolution is specified by the user.
    • Default value: 0.
    Height No Integer

    The maximum value of the screenshot height (or short side). Valid values: 0 and [32, 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;
  • 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.
    ResolutionAdaptive No String

    Resolution adaptation. Available values:

  • open: enable. At this point, Width represents the long side of the video, and Height represents the short side;
  • close: disable. At this point, Width represents the video width, and Height represents the video height.
    • Default value: open.
    Format No String

    Image format. Valid values: jpg, png, and webp. Default value: jpg.
    Comment No String

    Transcoding template description. Length limit: 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 "fill". Optional filling modes:

  • stretch: Stretch each frame to fill the entire screen, which may cause the transcoded video to be "squashed" or "stretched";
  • black: Keep the video aspect ratio unchanged, and fill the remaining edge part with black.
  • white: Keep the video aspect ratio unchanged, and fill the remaining edge part with white.
  • gauss: Gaussian blur. Keep the video aspect ratio unchanged, and apply Gaussian blur to the remaining edge part.
    • Default value: black.

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer

    Sampling screenshot template unique identifier.
    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 (Specified Width and Height)

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=CreateSampleSnapshotTemplate
&Name=fixed width and height screenshot
&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 (Specified Long Edge)

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=CreateSampleSnapshotTemplate
&Name=long side screenshot
&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 Parameter error: description of this template.
    InvalidParameterValue.Format Parameter value error: Format.
    InvalidParameterValue.Height Parameter error: height.
    InvalidParameterValue.Name Parameter value error: Name exceeds the length limit.
    InvalidParameterValue.Resolution Parameter error: Resolution error.
    InvalidParameterValue.SampleInterval Invalid parameter value: SampleInterval.
    InvalidParameterValue.SampleType Parameter value error: SampleType.
    InvalidParameterValue.Width Parameter error: width.
    LimitExceeded.TooMuchTemplate Exceed the limit: The number of templates exceeds the upper limit of 100. If needed, submit a ticket (https://console.tencentcloud.com/workorder/category).
    UnauthorizedOperation Unauthorized operation.
    上一篇: CreateSnapshotByTimeOffsetTemplate下一篇: CreateImageSpriteTemplate

    帮助和支持

    本页内容是否解决了您的问题？

    填写满意度调查问卷，共创更好文档体验。

    文档反馈

    搜索
      请输入关键词搜索文档