Modifying Channel Transcoding Template Information

Updated on 2025-01-24 GMT+08:00

View PDF

Function

Modifies channel transcoding template information.

URI

PUT /v1/{project_id}/ott/channels/encorder-settings

**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	Yes	String	User token. This parameter is mandatory when token authentication is used. It 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.
Access-Control-Allow-Internal	No	String	Service authentication token. If authentication is enabled for a service, Access-Control-Allow-Internal must be carried to access the service.
Access-Control-Allow-External	No	String	Service authentication token. If authentication is enabled for a service, Access-Control-Allow-External must be carried to access the service.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
domain	Yes	String	Ingest domain name of a channel.
app_name	Yes	String	Group name or application name.
id	Yes	String	Unique ID of a channel. This parameter is mandatory.
encoder_settings	No	Array of encoder_settings objects	Transcoding template configuration.
encoder_settings_expand	No	EncoderSettingsExpand object	Audio output configuration

**Table 4** encoder_settings
Parameter	Mandatory	Type	Description
template_id	No	String	Transcoding template ID.

**Table 5** EncoderSettingsExpand
Parameter	Mandatory	Type	Description
audio_descriptions	No	Array of audio_descriptions objects	Description of an audio output setting

**Table 6** audio_descriptions
Parameter	Mandatory	Type	Description
name	Yes	String	Name of an audio output setting. Enter only letters, digits, hyphens (-), and underscores (_). Names of audio output settings in the same channel must be different.
audio_selector_name	Yes	String	Audio selector name
language_code_control	No	String	Language code control. The setting will change only the audio's language displayed externally, not its actual language. Options: FOLLOW_INPUT: If the output audio of the selected audio selector has a language, this language will be used. Otherwise, the language code and stream name specified here will be used. The default value is recommended. USE_CONFIGURED: The language and stream name of the output audio can be customized.
language_code	No	String	Language code, which consists of 2 or 3 lowercase letters.
stream_name	No	String	Stream name

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
result_code	String	Error code.
result_msg	String	Error description.
domain	String	Ingest domain name.
app_name	String	Group name or application name. This parameter is mandatory.
id	String	Unique ID of a channel. This parameter is mandatory.
sources	Array of SourceRsp objects	Ingest URL list. During channel creation, the ingest URL list is returned only when the input stream protocol is RTMP_PUSH.

**Table 8** SourceRsp
Parameter	Type	Description
url	String	RTMP ingest URL.
bitrate	Integer	Bitrate. Unit: bit/s. Value range: (0, 104,857,600] (100 Mbit/s)
width	Integer	Width corresponding to the resolution. Value range: 0–4096 (4K)
height	Integer	Height corresponding to the resolution. Value range: 0–2160 (4K)
enable_snapshot	Boolean	Whether to use the stream for snapshot capturing.

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
result_code	String	Error code.
result_msg	String	Error description.
domain	String	Ingest domain name.
app_name	String	Group name or application name. This parameter is mandatory.
id	String	Unique ID of a channel. This parameter is mandatory.

Example Requests

 PUT https://{endpoint}/v1/{project_id}/ott/channels/encorder-settings

{
  "domain" : "push.testott.hls.com",
  "app_name" : "ott",
  "id" : "test",
  "encoder_settings" : [ {
    "template_id" : "ld"
  } ]
}

Example Responses

Status code: 200

Demo Information

{
  "result_code" : "LIVE.100000000",
  "result_msg" : "SUCCESS",
  "domain" : "push.testott.hls.com",
  "app_name" : "ott",
  "id" : "test"
}

Status code: 400

Error response

{
  "result_code" : "LIVE.103011019",
  "result_msg" : "The resource to access is not exists",
  "domain" : "push.testott.hls.com",
  "app_name" : "ott",
  "id" : "test2"
}