Last updated: 2020-10-16 18:35:24

1. API Description

Domain name for API request:

After a transcoding template is created and a template ID is successfully returned, you need to call the CreateLiveTranscodeRule API 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.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: CreateLiveTranscodeTemplate.
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, such as “900p”. This can be only a combination of letters and digits.
Length limit:
Standard transcoding: 1-10 characters
Top speed codec transcoding: 3-10 characters
VideoBitrate Yes Integer Video bitrate. Value range: 0–8,000 Kbps.
If the value is 0, the original bitrate will be retained.
Note: transcoding templates require a unique bitrate. The final saved bitrate may differ from the input bitrate.
Acodec No String Audio codec: acc by default.
Note: this parameter is unsupported now.
AudioBitrate No Integer Audio bitrate. Default value: 0.
Value range: 0-500.
Vcodec No String Video codec: h264/h265/origin. Default value: h264.

origin: original codec as the output codec
Description No String Template description.
Width No Integer Width. Default value: 0.
Value range: 0-3,000
It must be a multiple of 2. The original width is 0
NeedVideo No Integer Whether to keep the video. 0: no; 1: yes. Default value: 1.
NeedAudio No Integer Whether to keep the audio. 0: no; 1: yes. Default value: 1.
Height No Integer Height. Default value: 0.
Value range: 0-3,000
It must be a multiple of 2. The original height is 0
Fps No Integer Frame rate. Default value: 0.
Range: 0-60 Fps.
Gop No Integer Keyframe interval, unit: second.
Original interval by default
Range: 2-6
Rotate No Integer Rotation angle. Default value: 0.
Valid values: 0, 90, 180, 270
Profile No String Encoding quality:
baseline/main/high. Default value: baseline.
BitrateToOrig No Integer Whether to use the original bitrate when the set bitrate is larger than the original bitrate.
0: no, 1: yes
Default value: 0.
HeightToOrig No Integer Whether to use the original height when the set height is higher than the original height.
0: no, 1: yes
Default value: 0.
FpsToOrig No Integer Whether to use the original frame rate when the set frame rate is larger than the original frame rate.
0: no, 1: yes
Default value: 0.
AiTransCode No Integer Whether it is a top speed codec template. 0: no, 1: yes. Default value: 0.
AdaptBitratePercent No Float Bitrate compression ratio of top speed codec video.
Target bitrate of top speed code = VideoBitrate * (1-AdaptBitratePercent)

Value range: 0.0-0.5.
ShortEdgeAsHeight No Integer This parameter is used to define whether the short side is the video height. 0: no, 1: yes. The default value is 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 Request sample

Input Example
&<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.


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.ProcessorAlreadyExist The transcoding template name already exists.
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.ArgsNotMatch Incorrect template name.
InvalidParameterValue Invalid parameter value.
MissingParameter Parameter missing.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback