Help Center/ Live/ Cloud Live API Reference/ Transcoding Template Management/ Modifying a Transcoding Template
Updated on 2025-10-23 GMT+08:00
View PDF

Modifying a Transcoding Template

Function

This API is used to modify a transcoding template.

When modifying a live transcoding template, Live will overwrite the configuration in the modification request. As a result, the modification request must include all template information under the specified domain and app, meaning that quality_info needs to include all template information.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/template/transcodings

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

domain

Yes

String

Ingest domain name.

app_name

Yes

String

Application name.

trans_type

No

String

Transcoding stream triggering mode.

  • play: Transcoding is triggered by stream pull.

  • publish: Transcoding is triggered by stream push.

The default value is play.

quality_info

Yes

Array of QualityInfo objects

Video quality information.
Table 4 QualityInfo

Parameter

Mandatory

Type

Description

quality

Yes

String

The options are as follows:

  • lud: ultra HD (default name)

  • lhd: HD (default name)

  • lsd: SD (default name)

  • lld: smooth (default name)

  • userdefine: custom video quality. When userdefine is specified, the templateName field cannot be empty.

templateName

No

String

Customizes a template name.

  • To customize a template name, set quality to userdefine.

  • The name of each custom template must be unique.

  • The name of a custom template cannot be the same as the value of quality of another template.

  • If quality is not set to userdefine, do not set this parameter.

PVC

No

String

Indicates whether to use narrowband HD transcoding.

Note: This field is no longer used. Use hdlb instead.

The options are as follows:

  • off: disabled

  • on: enabled

Default value: off

hdlb

No

String

Indicates whether to enable low-bitrate HD. The image quality is better than PVC.

Note: When the hdlb field is used to enable low-bitrate HD, the PVC field does not take effect.

The options are as follows:

  • off: Low-bitrate HD is disabled.

  • on: Low-bitrate HD is enabled.

Default value: off

codec

No

String

Video encoding format.

The options are as follows:

  • H264: H.264 is used.

  • H265: H.265 is used.

The default value is H264.

width

No

Integer

Long side of the video. The landscape is a width, that is, a long side, and the portrait is a height. Unit: pixel.

The options are as follows:

  • When codec is set to H264, the recommended value range of width is [32, 3840] and the value must be an integer multiple of 2.

  • When codec is set to H265, the recommended value range of width is [320, 3840] and the value must be an integer multiple of 2.

Note: If the input value of both sides is 0, the output video resolution is the same as the source video resolution. If the value of one side is set to 0, the output video resolution will be scaled proportionally according to the input value of the other side.

Default value: 0

height

No

Integer

Short side of the video. The landscape is a width, and the portrait is a height, that is, a short side. Unit: pixel.

The options are as follows:

  • When codec is set to H264, the recommended value range of height is [32, 2160] and the value must be an integer multiple of 2.

  • When codec is set to H265, the recommended value range of height is [240, 2160] and the value must be an integer multiple of 2.

Note: If the input value of both sides is 0, the output video resolution is the same as the source video resolution. If the value of one side is set to 0, the output video resolution will be scaled proportionally according to the input value of the other side.

Default value: 0

bitrate

Yes

Integer

Bitrate of the transcoded video.

Unit: kbit/s

Value range: 40–30,000

video_frame_rate

No

Integer

Frame rate of the transcoded video.

Unit: FPS

Value range: 0–60. The value 0 indicates that the frame rate remains unchanged.

Default value: 0

protocol

No

String

Protocol type supported by transcoded outputs. The default value is RTMP. Currently, only RTMP is supported.

The options are as follows:

  • RTMP

iFrameInterval

No

Integer

Maximum I-frame interval.

Unit: number of frames

Value range: 0–500. Default value: 50.

Note: If you want to set the I-frame interval using iFrameInterval, set gop to 0 or do not set gop.

gop

No

Integer

I-frame interval by time.

Unit: second

Value range: 0–10. Default value: 2.

Note: If gop is not 0, the I-frame interval is set based on gop, and the iFrameInterval field does not take effect.

bitrate_adaptive

No

String

Adaptive bitrate parameter.

The options are as follows:

  • off: Bitrate adaptation is disabled. The target bitrate is output as specified.

  • minimum: The target bitrate is the smaller value between the specified bitrate and the bitrate of the source file. That is, the bitrate does not increase.

  • adaptive: The target bitrate is adaptive to the bitrate of the source file.

Default value: off

i_frame_policy

No

String

Policy for outputting I-frames during encoding.

The options are as follows:

  • auto: I-frames are output based on the configured GOP duration.

  • strictSync: The output I-frames are the same as those of the source. If the source contains I-frames, the output I-frames are encoded. If the source does not contain I-frames, the output non-I-frames are encoded. After this parameter is set, the GOP duration is invalid.

Default value: auto

Response Parameters

Status code: 204

Transcoding template modified successfully.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Modifies a transcoding template. Set the application name to live, transcoding quality to SD, transcoding format to H.264, width to 1920 pixels, and height to 1080 pixels.

PUT https://{endpoint}/v1/{project_id}/template/transcodings

{
  "domain" : "play.example.com",
  "app_name" : "live",
  "quality_info" : [ {
    "quality" : "lsd",
    "hdlb" : "off",
    "codec" : "H264",
    "width" : 1920,
    "height" : 1080,
    "bitrate" : 4500,
    "video_frame_rate" : 20,
    "gop" : 4
  }, {
    "quality" : "userdefine",
    "templateName" : "yourTemplateName",
    "hdlb" : "off",
    "codec" : "H264",
    "width" : 1920,
    "height" : 1080,
    "bitrate" : 4500,
    "video_frame_rate" : 20,
    "gop" : 4
  } ]
}

Example Responses

Status code: 400

Failed to modify the transcoding template.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

Status Codes

Status Code

Description

204

Transcoding template modified successfully.

400

Failed to modify the transcoding template.

Error Codes

See Error Codes.