ModifySampleSnapshotTemplate

Last updated: 2023-10-12 16:44:40Download PDF

1. API Description

Domain name for API request: mps.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: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
Definition	Yes	Integer	Unique ID of a sampled screencapturing template.
Name	No	String	Name of a sampled screencapturing template. Length limit: 64 characters.
Width	No	Integer	Image width in px. Value range: [128, 4,096].
Height	No	Integer	Image height in px. Value range: [128, 4,096].
ResolutionAdaptive	No	String	Resolution 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.
SampleType	No	String	Sampled screencapturing type. Valid values: Percent: By percent. Time: By time interval.
SampleInterval	No	Integer	Sampling 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.
Format	No	String	The image format. Valid values: jpg, png, webp.
Comment	No	String	Template description. Length limit: 256 characters.
FillType	No	String	Fill 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. white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur. Default value: black.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying a sampled screenshot template

Input Example

POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySampleSnapshotTemplate
<Common request parameters>

{
    "Definition": "10001",
    "Name": "Sampled screenshot template 1",
    "Format": "jpg",
    "SampleType": "Percent",
    "Height": "960",
    "Width": "540",
    "SampleInterval": "10"
}

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

Tencent Cloud CLI 3.0

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.InvalidMpsUser	Operation failed: unauthorized MPS user.
InternalError	Internal error.
InvalidParameterValue.Comment	Parameter error: template description.
InvalidParameterValue.FillType	Invalid parameter: incorrect fill type.
InvalidParameterValue.Format	Incorrect parameter value: Format.
InvalidParameterValue.Height	Parameter error: height.
InvalidParameterValue.Name	Incorrect parameter value: `Name` exceeds the length limit.
InvalidParameterValue.Resolution	Parameter error: Incorrect resolution.
InvalidParameterValue.SampleInterval	Incorrect parameter value: SampleInterval.
InvalidParameterValue.SampleType	Incorrect parameter value: SampleType.
InvalidParameterValue.Width	Parameter error: Wwdth.
ResourceNotFound.TemplateNotExist	The resource does not exist: the template does not exist.