CreateLiveTranscodeRule

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-19 14:59:28

Download PDF

1. API Description

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

To create a transcoding rule, you need to first call the CreateLiveTranscodeTemplate API to create a transcoding template and bind the returned template ID to the stream.

Transcoding-related document: LVB Remuxing and Transcoding.

A maximum of 200 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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: CreateLiveTranscodeRule.
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.
DomainName	Yes	String	Playback domain name.
AppName	Yes	String	Push path, which is the same as the `AppName` in push and playback addresses and is `live` by default. If you only bind a domain name, leave this parameter empty.
StreamName	Yes	String	Stream name. If only the domain name or path is bound, leave this parameter blank.
TemplateId	Yes	Integer	Designates an existing template ID.

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 Sample request

Input Example

https://live.tencentcloudapi.com/?Action=CreateLiveTranscodeRule
&DomainName=5000.liveplay.myqcloud.com
&AppName=live
&StreamName=stream1
&TemplateId=1000
&<Common request parameters>

Output Example

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

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.RuleAlreadyExist	The rule already exists.
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.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.DomainFormatError	The domain name format is incorrect. Please enter a valid one.
InvalidParameterValue	Invalid parameter value.
MissingParameter	Parameter missing.
UnsupportedOperation.NotLVBCodeMode	Not a LVB code/new console mode

Recent Pages