Help & DocumentationLive Video BroadcastingAPI documentationScreencapture and Porn Detection APIsDescribeLiveSnapshotTemplates

DescribeLiveSnapshotTemplates

Last updated: 2020-05-09 14:26:36

PDF

1. API Description

Domain name for API request: live.tencentcloudapi.com.

This API is used to get the screencapturing template list.

A maximum of 500 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: DescribeLiveSnapshotTemplates.
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.

3. Output Parameters

Parameter Name Type Description
Templates Array of SnapshotTemplateInfo Screencapturing template list.
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=DescribeLiveSnapshotTemplates
&<Common request parameters>

Output Example

{
  "Response": {
    "Templates": [
      {
        "TemplateId": 1000,
        "TemplateName": "testName",
        "Description": "test",
        "SnapshotInterval": 10,
        "Width": 250,
        "Height": 250,
        "PornFlag": 0,
        "CosAppId": 123,
        "CosBucket": "bucket",
        "CosRegion": "beijing"
      }
    ],
    "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.