Domain name for API request: live.tencentcloudapi.com.
After a screencapturing 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.
Screencapturing-related document: LVB Screencapturing.
A maximum of 200 requests can be initiated per second for this API.
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 parameter. The value used for this API: CreateLiveSnapshotTemplate. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-08-01. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| TemplateName | Yes | String | Template name. Maximum length: 255 bytes. Only letters, digits, underscores, and hyphens can be contained. |
| CosAppId | Yes | Integer | COS application ID. |
| CosBucket | Yes | String | COS bucket name. Note: the value of CosBucket cannot contain -[appid]. |
| CosRegion | Yes | String | COS region. |
| Description | No | String | Description. Maximum length: 1,024 bytes. Only letters, digits, underscores, and hyphens can be contained. |
| SnapshotInterval | No | Integer | Screencapturing interval in seconds. Default value: 10s. Value range: 5-300s. |
| Width | No | Integer | Screenshot width. Default value: 0 (original width). |
| Height | No | Integer | Screenshot height. Default value: 0 (original height). |
| PornFlag | No | Integer | Whether to enable porn detection. 0: no, 1: yes. Default value: 0 |
| CosPrefix | No | String | COS Bucket folder prefix. If no value is entered, the default value /{Year}-{Month}-{Day}will be used. |
| CosFileName | No | String | COS filename. If no value is entered, the default value {StreamID}-screenshot-{Hour}-{Minute}-{Second}-{Width}x{Height}{Ext}will be used. |
| Parameter Name | Type | Description |
|---|---|---|
| TemplateId | Integer | Template ID. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
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 parameters>{
"Response": {
"TemplateId": 1000,
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| InternalError.ArgsNotMatch | For the transcoding template adding API. |
| InternalError.ConfInUsed | The template is in use. |
| InternalError.ConfNotFound | The template does not exist. |
| InternalError.ConfOutLimit | The number of templates exceeds the limit. |
| 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 | Invalid parameter. |
| InvalidParameter.COSCustomFileNameError | Incorrect custom COS filename. |
| InvalidParameterValue | Invalid parameter value. |
| MissingParameter | Parameter missing. |
| UnsupportedOperation.NotLVBCodeMode | Not a LVB code/new console mode |
Was this page helpful?