tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateLiveTranscodeRule

Last updated: 2023-09-06 15:06:29

1. API Description

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

This API is used to create a transcoding rule that binds a template ID to a stream. Up to 50 transcoding rules can be created in total. Before you call this API, you need to first call CreateLiveTranscodeTemplate to get the template ID.

Related document: Live 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.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateLiveTranscodeRule.
Version Yes String Common Params. The value used for this API: 2018-08-01.
Region No String Common Params. This parameter is not required for this API.
DomainName Yes String Playback domain name.
AppName Yes String The push path, which is the same as AppName in the push and playback addresses and is live by default. If you only want to bind the template to a domain, pass in an empty string.
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 Creating a transcoding rule

This example shows you how to create a transcoding rule.

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

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.ConfNotFound
InvalidParameter.DomainFormatError The domain name format is incorrect. Please enter a valid one.
InvalidParameterValue Invalid parameter value.
MissingParameter Parameter missing.
ResourceNotFound.ForbidService You are blocked.
ResourceNotFound.FreezeService Service suspended.
ResourceNotFound.StopService The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first.
ResourceNotFound.UserDisableService You disabled the service.
UnsupportedOperation.NotLVBCodeMode Not a LVB code/new console mode
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy