修改频道入流信息 - ModifyOttChannelInfoInput
功能介绍
修改频道入流信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型(*为必须) |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
live:ott:updateChannelInput |
Write |
- |
- |
- |
- |
URI
PUT /v1/{project_id}/ott/channels/input
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,获取方法请参考获取项目ID。 约束限制: 不涉及 取值范围: [1,32] 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
参数解释: 用户Token,使用Token鉴权方式时为必填项。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: [1,256] 默认取值: 不涉及 |
|
Authorization |
否 |
String |
参数解释: 使用AK/SK方式认证时必填,携带的鉴权信息。 约束限制: 不涉及 取值范围: [1,256] 默认取值: 不涉及 |
|
X-Sdk-Date |
否 |
String |
参数解释: 请求的发生时间,使用AK/SK方式认证时为必填项。 约束限制: 不涉及 取值范围: [1,256] 默认取值: 不涉及 |
|
X-Project-Id |
否 |
String |
参数解释: 使用AK/SK方式认证时为必填项,携带项目ID信息。 约束限制: 不涉及 取值范围: [1,64] 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
domain |
是 |
String |
参数解释: 频道推流域名 约束限制: 不涉及 取值范围: 只能由小写英文字符与"-"、"_"组成,且长度为[1~255]个字符。 默认取值: 不涉及 |
|
app_name |
是 |
String |
参数解释: 组名或应用名 约束限制: 不涉及 取值范围: 只能由英文字符与"-"、"_"组成,首字符必须为字母。且长度为[1~64]个字符。 默认取值: 不涉及 |
|
id |
是 |
String |
参数解释: 频道ID,频道唯一标识。 约束限制: 不涉及 取值范围: 只能由英文字符与"-"、"_"组成,首字符必须为字母。且长度为[2~64]个字符。 默认取值: 不涉及 |
|
input |
否 |
InputStreamInfo object |
参数解释: 频道出流信息 约束限制: 不涉及 |
|
encoder_settings_expand |
否 |
EncoderSettingsExpand object |
参数解释: 输出编码扩展 约束限制: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
input_protocol |
是 |
String |
参数解释: 频道入流协议 约束限制: 不涉及 取值范围: 默认取值: FLV_PULL |
|
sources |
否 |
Array of SourcesInfo objects |
参数解释: 频道主源流信息 约束限制: |
|
secondary_sources |
否 |
Array of SecondarySourcesInfo objects |
参数解释: 频道备源流信息 约束限制: |
|
failover_conditions |
否 |
FailoverConditions object |
参数解释: 频道供应商提供的主备音视频流URL切换的配置 约束限制: 非必填项 |
|
max_bandwidth_limit |
否 |
Integer |
参数解释: 当入流协议为HLS_PULL时,需要配置的最大带宽。 约束限制: 用户提供的拉流URL中,针对不同码率的音视频,均会携带带宽参数“BANDWIDTH”。 取值范围: [0,104857600] 默认取值: 不涉及 |
|
ip_port_mode |
否 |
Boolean |
参数解释: 当推流协议为SRT_PUSH时,如果配置了直推源站,编码器不支持输入streamid,需要打开设置为true 约束限制: 不涉及 取值范围: 默认取值: false |
|
ip_whitelist |
否 |
String |
参数解释: 客户推流的IP白名单 约束限制: 协议为SRT_PUSH类型时,需要携带推流白名单 取值范围: 支持数字与“/”、“,”,字符串,长度限制[0~256]个字符 默认取值: 不涉及 |
|
scte35_source |
否 |
String |
参数解释: 广告的scte35信号源 约束限制: 仅HLS_PULL类型的频道支持此配置,且目前仅支持SEGMENTS 取值范围: SEGMENTS、MANIFEST 默认取值: 不涉及 |
|
ad_triggers |
否 |
Array of strings |
参数解释: 广告触发器配置。 约束限制: 最多设置五个 取值范围: 默认取值: 不涉及 |
|
audio_selectors |
否 |
Array of InputAudioSelector objects |
参数解释: 音频选择器, 约束限制: 最多设置8个音频选择器 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
url |
否 |
String |
参数解释: 频道源流URL,用于外部拉流,当请求协议为SRT_PUSH、RTMP_PUSH时,无需填写 约束限制: 无需直播转码时,此参数为必填项 取值范围: 长度限制[1~1024]位 默认取值: 不涉及 |
|
bitrate |
否 |
Integer |
参数解释: 码率,单位:bps 约束限制: 无需直播转码时,此参数为必填项 默认取值: 不涉及 取值范围: 0~104857600 |
|
width |
否 |
Integer |
参数解释: 分辨率对应宽的值 约束限制: 不涉及 默认取值: 不涉及 取值范围: 0~4096 |
|
height |
否 |
Integer |
参数解释: 分辨率对应高的值 约束限制: 不涉及 默认取值: 不涉及 取值范围: 0~2160 |
|
enable_snapshot |
否 |
Boolean |
参数解释: 描述是否使用该流做截图 约束限制: 不涉及 取值范围: 默认取值: false |
|
bitrate_for3u8 |
否 |
Boolean |
参数解释: 是否使用bitrate来固定码率 约束限制: 不涉及 取值范围: 默认取值: false |
|
passphrase |
否 |
String |
参数解释: 协议为SRT_PUSH时的加密信息 约束限制: 不涉及 取值范围: 长度限制[10~79]个字符 默认取值: 不涉及 |
|
backup_urls |
否 |
Array of strings |
参数解释: 备入流地址列表 约束限制: 不涉及 取值范围: 限制最多12个 默认取值: 不涉及 |
|
stream_id |
否 |
String |
参数解释: 频道为SRT_PULL类型时,拉流地址的Stream ID 约束限制: 不涉及 取值范围: 长度限制[0~512]个字符 默认取值: 不涉及 |
|
latency |
否 |
Integer |
参数解释: 频道为SRT_PULL类型时的拉流时延 约束限制: 不涉及 取值范围: 取值限制100~15000 默认取值: 不涉及 |
|
pbkeylen |
否 |
Integer |
参数解释: srt加密算法,包含如下取值: 约束限制: 不涉及 取值范围: 16~32 默认取值: 32 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
url |
否 |
String |
参数解释: 频道源流URL,用于外部拉流,当请求协议为SRT_PUSH、RTMP_PUSH时,无需填写 约束限制: 无需直播转码时,此参数为必填项 取值范围: 不涉及 默认取值: 不涉及 |
|
bitrate |
否 |
Integer |
参数解释: 码率,单位:bps 约束限制: 无需直播转码时,此参数为必填项 默认取值: 不涉及 取值范围: 0~104857600 |
|
width |
否 |
Integer |
参数解释: 分辨率对应宽的值 约束限制: 不涉及 默认取值: 不涉及 取值范围: 0~4096 |
|
height |
否 |
Integer |
参数解释: 分辨率对应高的值 约束限制: 不涉及 默认取值: 不涉及 取值范围: 0~2160 |
|
bitrate_for3u8 |
否 |
Boolean |
参数解释: 是否使用bitrate来固定码率 取值范围: 约束限制: 不涉及 默认取值: false |
|
passphrase |
否 |
String |
参数解释: 协议为SRT_PUSH时的加密信息 约束限制: 不涉及 取值范围: 长度限制[10~79]个字符 默认取值: 不涉及 |
|
backup_urls |
否 |
Array of strings |
参数解释: 备入流地址列表 约束限制: 不涉及 取值范围: 限制最多12个 默认取值: 不涉及 |
|
stream_id |
否 |
String |
参数解释: 频道为SRT_PULL类型时,拉流地址的Stream ID 约束限制: 不涉及 取值范围: 长度限制[0~512]个字符 默认取值: 不涉及 |
|
latency |
否 |
Integer |
参数解释: 频道为SRT_PULL类型时的拉流时延 约束限制: 不涉及 取值范围: 取值限制100~15000 默认取值: 不涉及 |
|
pbkeylen |
否 |
Integer |
参数解释: srt加密算法,取值如下: 约束限制: 不涉及 取值范围: 16~32 默认取值: 32 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
input_loss_threshold_msec |
否 |
Integer |
参数解释: 入流停止的时长阈值,到达此阈值后,自动触发主备切换。单位:毫秒。 约束限制: 不涉及 默认取值: 2000 取值范围: 0~3600000 |
|
input_preference |
否 |
String |
参数解释: 以主入流URL为第一优先级(PRIMARY)或主备URL平等切换(EQUAL) 约束限制: 非必填,如果是平等切换时,使用的是备URL,不会自动切换至主URL 取值范围: 默认取值: EQUAL |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
参数解释: 音频选择器的名称 约束限制: 同一个频道中每个选择器的名称需要唯一 取值范围: 仅支持大小写字母、数字、中划线和下划线。且长度为[1~255]个字符。 默认取值: 不涉及 |
|
selector_settings |
否 |
AudioSelectorSettings object |
参数解释: 设置音频选择器 约束限制: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
audio_language_selection |
否 |
AudioSelectorLangSelection object |
参数解释: 设置语言选择器 约束限制: 不涉及 |
|
audio_pid_selection |
否 |
AudioSelectorPidSelection object |
参数解释: 设置PID选择器 约束限制: 不涉及 |
|
audio_hls_selection |
否 |
AudioSelectorHlsSelection object |
参数解释: 设置Hls选择器 约束限制: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
language_code |
是 |
String |
参数解释: 语言简称 约束限制: 不涉及 取值范围: 输入2或3个小写字母的语言代码 默认取值: 不涉及 |
|
language_selection_policy |
否 |
String |
参数解释: 语言输出策略 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
pid |
是 |
Integer |
参数解释: 设置PID的值 约束限制: 不涉及 默认取值: 不涉及 取值范围: 0~8191 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
参数解释: hls音频选择器名 约束限制: 不涉及 取值范围: 字符长度[1,255] 默认取值: 不涉及 |
|
group_id |
是 |
String |
参数解释: hls音频选择器gid 约束限制: 不涉及 取值范围: 字符长度[1,255] 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
audio_descriptions |
否 |
Array of audio_descriptions objects |
参数解释: 音频输出配置的描述信息 约束限制: 不涉及 取值范围: 最大支持8个 默认取值: 不涉及 |
|
video_descriptions |
否 |
VideoDescriptions object |
参数解释: 视频输出配置的描述信息 约束限制: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
参数解释: 音频输出配置的名称 约束限制: 同一个频道不同的音频输出配置名称,不允许重复 取值范围: 仅支持大小写字母,数字,中划线(-),下划线(_),且字符长度[1,255]。 默认取值: 不涉及 |
|
audio_selector_name |
是 |
String |
参数解释: 音频选择器名称 约束限制: 不涉及 取值范围: 仅支持大小写字母,数字,中划线(-),下划线(_),且字符长度[1,255]。 默认取值: 不涉及 |
|
language_code_control |
否 |
String |
参数解释: 语言代码控制。这里的设置不会修改音频实际的语言,只会修改音频对外展示的语言 约束限制: 同一个频道不同的音频输出配置名称,不允许重复 取值范围: 默认取值: 不涉及 |
|
language_code |
否 |
String |
参数解释: 语言代码 约束限制: 不涉及 取值范围: 输入2或3个小写字母 默认取值: 不涉及 |
|
stream_name |
否 |
String |
参数解释: 流名称 约束限制: 不涉及 取值范围: 字符长度[0,255] 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result_code |
String |
参数解释: 错误码 取值范围: 详见错误码。 |
|
result_msg |
String |
参数解释: 错误描述 取值范围: 详见错误码描述。 |
|
domain |
String |
参数解释: 推流域名,响应参数不涉及。 取值范围: 不涉及 |
|
app_name |
String |
参数解释: 组名或应用名,响应参数不涉及。 取值范围: 不涉及 |
|
id |
String |
参数解释: 频道ID,频道唯一标识。响应参数不涉及。 取值范围: 不涉及 |
|
sources |
Array of SourceRsp objects |
参数解释: 推流URL列表,最多返回12条。创建频道时,只有入流协议为RTMP_PUSH、SRT_PUSH时,会返回推流URL列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
url |
String |
参数解释: 频道源流URL,用于外部拉流 取值范围: 长度限制[1~1024]个字符 |
|
bitrate |
Integer |
参数解释: 码率,单位:bps 取值范围: 0~104857600 |
|
width |
Integer |
参数解释: 分辨率对应宽的值 取值范围: 0~4096 |
|
height |
Integer |
参数解释: 分辨率对应高的值 取值范围: 0~2160 |
|
enable_snapshot |
Boolean |
参数解释: 描述是否使用该流做截图 取值范围: |
状态码:400
请求示例
PUT https://{endpoint}/v1/{project_id}/ott/channels/input
{
"domain" : "push.testott.hls.com",
"app_name" : "ott",
"id" : "test",
"input" : {
"input_protocol" : "RTMP_PUSH",
"sources" : [ {
"width" : 100,
"bitrate_for3u8" : false,
"enable_snapshot" : false,
"bitrate" : 1024,
"passphrase" : "",
"url" : "rtmp://192.168.8.158/ott/adtestdrm?vhost=pull.testott.hls.com",
"height" : 100
} ]
}
}
响应示例
状态码: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" : "test",
"id" : "test-abc"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Demo Information |
|
400 |
Error response |
错误码
请参见错误码。