CreateLiveSnapshotTemplate

Last updated: 2020-03-20 17:18:44

PDF

1. API Description

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.

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 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, which is a non-empty string.
Maximum length: 255 bytes.
CosAppId Yes Integer COS AppId.
CosBucket Yes String COS bucket name.
CosRegion Yes String COS region.
Description No String Description.
Maximum length: 1,024 bytes.
SnapshotInterval No Integer Screencapturing interval in seconds. Default value: 10s.
Value range: 5–600s.
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

3. Output Parameters

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.

4. Example

Example1 Sample request

Input Example

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>

Output Example

{
  "Response": {
    "TemplateId": 1000,
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.
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.
InvalidParameterValue Wrong parameter value.
MissingParameter Missing parameter.