Contents：
1. API Description
API request domain name: live.tencentcloudapi.com.
After a screencapture template is created and a template ID is successfully returned, you need to call the CreateLiveSnapshotRule API and bind the template ID to the stream.
Screenshot-related document: LVB screencapture.
Default API request rate limit: 200 requests/second.
2. Request Parameters
The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.
| Parameter name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter; the name of this API: CreateLiveSnapshotTemplate |
| Version | Yes | String | Common parameter; the version of this API: 2018-08-01 |
| Region | No | String | Common parameter; optional for this API |
| TemplateName | Yes | String | Template name. Non-empty string. |
| CosAppId | Yes | Integer | COS AppId |
| CosBucket | Yes | String | COS bucket name |
| CosRegion | Yes | String | COS region |
| Description | No | String | Description information |
| SnapshotInterval | No | Integer | Screencapture interval in seconds; 10 seconds by default. |
| Width | No | Integer | Screenshot width Default value: 0 (original height) |
| Height | No | Integer | Screenshot height Default value: 0 (original width) |
| PornFlag | No | Integer | Whether to enable porn detection; 0: disabled, 1: enabled Default value: 0. |
3. Return Parameters
| Parameter name | Type | Description |
|---|---|---|
| TemplateId | Integer | Template ID. |
| RequestId | String | The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues. |
4. Sample
Request Sample
Input Sample Code
https://live.tencentcloudapi.com/?Action=CreateLiveSnapshotTemplate
&TemplateName=testName
&Description=testDesc
&SnapshotInterval=10
&Width=250
&Height=250
&PornFlag=0
&CosAppId=123
&CosBucket=bucket
&CosRegion=beijing
&<Common request parameter>Output Sample Code
{
"Response": {
"TemplateId": 1000,
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}5. Developer Resources
API Explorer
API Explorer is a tool that provides ease of use in requesting APIs, authenticating identities, generating SDK and exploring APIs in Tencent Cloud environment.
6. Error Codes
The following error codes are API business logic-related. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error |
| InternalError.ArgsNotMatch | For the API that is used for adding transcoding template |
| InternalError.ConfInUsed | The template is in use. |
| InternalError.ConfNotFound | The template does not exist. |
| InternalError.ConfOutLimit | The number of templates exceeds the display. |
| InternalError.InvalidInput | Parameter check failed. |
| InternalError.NotFound | The record does not exist. |
| InternalError.RuleAlreadyExist | The rule has already been configured. |
| InternalError.RuleInUsing | The rule is in use. |
| InternalError.RuleNotFound | The rule does not exist. |
| InternalError.RuleOutLimit | The rule exceeds the limit. |
| InvalidParameter | Parameter error |
| InvalidParameterValue | Incorrect parameter value |
| MissingParameter | Missing parameter |
