tencent cloud

云点播

文档云点播服务端 API 文档Parameter Template APIsModifySampleSnapshotTemplate

ModifySampleSnapshotTemplate

Download
聚焦模式
字号
最后更新时间： 2026-05-19 15:00:38

1. API Description

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

This API is used to modify a custom sampled screencapturing 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 Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifySampleSnapshotTemplate.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
Definition Yes Integer Unique identifier of the sampling screenshot template.
SubAppId No Integer On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created).
Name No String Sample screenshot template name. The length cannot exceed 64 characters.
Width No Integer The maximum value of screenshot width (or long side), value ranges from 0 to [32, 4096], measurement unit: px.
  • When both Width and Height are 0, the resolution is the same as the source.
  • When Width is 0 and Height is not 0, Width is scaled proportionally.
  • When Width is not 0 and Height is 0, Height is scaled proportionally.
  • When both Width and Height are not 0, the resolution is specified by user.
    • Default value: 0.
    Height No Integer The maximum value of screenshot height (or short edge), value ranges from 0 to [32, 4096], unit: px.
  • When both Width and Height are 0, the resolution is the same as the source;
  • When Width is 0 and Height is not 0, Width is proportionally scaled;
  • When Width is not 0 and Height is 0, Height is proportionally scaled;
  • When both Width and Height are not 0, the resolution is specified by 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 indicates the short side.
  • close: Closed. At this point, Width represents the Width of the video, and Height indicates the Height of the video.

    • Default value: open.
    SampleType No String Sampling screenshot type, Valid value:
  • Percent: by percent.
  • Time: By time interval.
    		•
    SampleInterval No Integer Sampling interval.
  • When SampleType is Percent, specify the percentage of the sampling interval.
  • When SampleType is Time, specify the sampling interval in seconds.
    		•
    Format No String Image format. Valid values: jpg and png.
    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, use Gaussian blur for the remaining edge part.

    • Default value: black.

    3. Output Parameters

    Parameter Name Type Description
    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 Modifying a sampled screenshot template

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=ModifySampleSnapshotTemplate
&Definition=10001
&Name=Sampled screenshot template 1
&Width=540
&Height=960
&SampleType=Percent
&SampleInterval=10
&Format=jpg
&<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 Code Description
    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.SampleInterval Incorrect parameter value: SampleInterval.
    InvalidParameterValue.SampleType Incorrect parameter value: SampleType.
    InvalidParameterValue.Width Invalid parameter: width.
    ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.
    UnauthorizedOperation Unauthorized operation.
    上一篇: ModifySnapshotByTimeOffsetTemplate下一篇: ModifyImageSpriteTemplate

    帮助和支持

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

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

    文档反馈