文档首页/ 视频直播 Live/ 媒体直播API参考/ OTT频道管理/ 修改频道转码模板信息
更新时间：2024-09-14 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改频道转码模板信息

功能介绍

修改频道转码模板信息。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Access-Control-Allow-Internal

否

String

服务鉴权Token，服务开启鉴权，必须携带Access-Control-Allow-Internal访问服务。

Access-Control-Allow-External

否

String

服务鉴权Token，服务开启鉴权，必须携带Access-Control-Allow-External访问服务。
表3 请求Body参数

参数

是否必选

参数类型

描述

domain

是

String

频道推流域名

app_name

是

String

组名或应用名

id

是

String

频道ID。频道唯一标识，为必填项

encoder_settings

否

Array of encoder_settings objects

转码模板配置

encoder_settings_expand

否

EncoderSettingsExpand object

音频输出配置
表4 encoder_settings

参数

是否必选

参数类型

描述

template_id

否

String

转码模板ID
表5 EncoderSettingsExpand

参数

是否必选

参数类型

描述

audio_descriptions

否

Array of audio_descriptions objects

音频输出配置的描述信息
表6 audio_descriptions

参数

是否必选

参数类型

描述

name

是

String

音频输出配置的名称。仅支持大小写字母，数字，中划线（-），下划线（_）。

同一个频道不同的音频输出配置名称，不允许重复。

audio_selector_name

是

String

音频选择器名称

language_code_control

否

String

语言代码控制。这里的设置不会修改音频实际的语言，只会修改音频对外展示的语言。

包含如下选项：

  • FOLLOW_INPUT：如果所选音频选择器对应的输出音频有语言，则与其保持一致，否则会以这里配置的语言代码和流名称进行兜底。推荐当前选项，为默认值。

  • USE_CONFIGURED：用户根据实际情况自定义输出音频的语言和流名称。

language_code

否

String

语言代码，输入2或3个小写字母。

stream_name

否

String

流名称

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

result_code

String

错误码

result_msg

String

错误描述

domain

String

推流域名

app_name

String

组名或应用名，为必填项

id

String

频道ID。频道唯一标识，为必填项

sources

Array of SourceRsp objects

推流URL列表。创建频道时，只有入流协议为RTMP_PUSH时，会返回推流URL列表
表8 SourceRsp

参数

参数类型

描述

url

String

RTMP推流地址

bitrate

Integer

码率。

单位：bps。取值范围：(0,104,857,600]（100Mbps）

width

Integer

分辨率对应宽的值。取值范围：0 - 4096（4K）

height

Integer

分辨率对应高的值。取值范围：0 - 2160（4K）

enable_snapshot

Boolean

描述是否使用该流做截图

状态码： 400

表9 响应Body参数

参数

参数类型

描述

result_code

String

错误码

result_msg

String

错误描述

domain

String

推流域名

app_name

String

组名或应用名，为必填项

id

String

频道ID。频道唯一标识，为必填项

请求示例

 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"
  } ]
}

响应示例

状态码： 200

Demo Information

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

状态码： 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"
}

状态码

状态码

描述

200

Demo Information

400

Error response

错误码

请参见错误码。

父主题： OTT频道管理