tencent cloud

APIs

DocumentationAPIsVideo on DemandParameter Template APIsModifySnapshotByTimeOffsetTemplate

ModifySnapshotByTimeOffsetTemplate

Download
Focus Mode
Font Size
Last updated: 2026-09-22 21:49:26

1. API Description

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

Modify a user-customized specified time point screenshot 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: ModifySnapshotByTimeOffsetTemplate.
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 screenshot template at specified time point.
SubAppId No Integer

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

Screenshot template name at specified time point. Length limited to 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, 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 width of the video, and Height represents the 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 mode. 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: 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
    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 Specified Time Point Screenshot Template

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=ModifySnapshotByTimeOffsetTemplate
&Definition=10001
&Name=Specified Time Point Screenshot Template 1
&Width=540
&Height=960
&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
    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.Width Parameter error: width.
    ResourceNotFound.TemplateNotExist Resource does not exist: template not found.
    UnauthorizedOperation Unauthorized operation.
    Previous Topic: ModifyWatermarkTemplateNext Topic: ModifySampleSnapshotTemplate

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback

    Search
      Enter keywords to search documentation