修改频道入流信息 - 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。 | 
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| X-Auth-Token | 否 | String | 用户Token,使用Token鉴权方式时为必填项。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 | 
| Authorization | 否 | String | 使用AK/SK方式认证时必填,携带的鉴权信息。 | 
| X-Sdk-Date | 否 | String | 请求的发生时间,使用AK/SK方式认证时为必填项。 | 
| X-Project-Id | 否 | String | 使用AK/SK方式认证时为必填项,携带项目ID信息。 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| domain | 是 | String | 频道推流域名 | 
| app_name | 是 | String | 组名或应用名 | 
| id | 是 | String | 频道ID。频道唯一标识,为必填项 | 
| input | 否 | InputStreamInfo object | 频道出流信息 | 
| encoder_settings_expand | 否 | EncoderSettingsExpand object | 输出编码扩展 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| input_protocol | 是 | String | 频道入流协议 
 | 
| sources | 否 | Array of SourcesInfo objects | 频道主源流信息。入流协议为RTMP_PUSH和SRT_PUSH时,非必填项。其他情况下,均为必填项。 | 
| secondary_sources | 否 | Array of SecondarySourcesInfo objects | 备入流数组,非必填项。如果有备入流,则主备入流必须保证路数、codec和分辨率均一致。入流协议为RTMP_PUSH时,无需填写。 | 
| failover_conditions | 否 | FailoverConditions object | 非必填,频道供应商提供的主备音视频流URL切换的配置。 | 
| max_bandwidth_limit | 否 | Integer | 当入流协议为HLS_PULL时,需要配置的最大带宽。 用户提供的拉流URL中,针对不同码率的音视频,均会携带带宽参数“BANDWIDTH”。 
 | 
| ip_port_mode | 否 | Boolean | 当推流协议为SRT_PUSH时,如果配置了直推源站,编码器不支持输入streamid,需要打开设置为true | 
| ip_whitelist | 否 | String | SRT_PUSH类型时,客户推流的IP白名单 | 
| scte35_source | 否 | String | 广告的scte35信号源。 仅HLS_PULL类型的频道支持此配置,且目前仅支持SEGMENTS。 | 
| ad_triggers | 否 | Array of strings | 广告触发器配置。 包含如下取值: 
 | 
| audio_selectors | 否 | Array of InputAudioSelector objects | 设置音频选择器,最多设置8个音频选择器 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| url | 否 | String | 频道源流URL,用于外部拉流 | 
| bitrate | 否 | Integer | 码率。无需直播转码时,此参数为必填项 单位:bps。取值范围:(0,104,857,600](100Mbps) | 
| width | 否 | Integer | 分辨率对应宽的值,非必填项 取值范围:0 - 4096(4K) | 
| height | 否 | Integer | 分辨率对应高的值,非必填项 取值范围:0 - 2160(4K) | 
| enable_snapshot | 否 | Boolean | 描述是否使用该流做截图 | 
| bitrate_for3u8 | 否 | Boolean | 是否使用bitrate来固定码率。默认值:false | 
| passphrase | 否 | String | 协议为SRT_PUSH时的加密信息 | 
| backup_urls | 否 | Array of strings | 备入流地址列表 | 
| stream_id | 否 | String | 频道为SRT_PULL类型时,拉流地址的Stream ID。 | 
| latency | 否 | Integer | 频道为SRT_PULL类型时的拉流时延。 | 
| pbkeylen | 否 | Integer | srt加密算法 16 = AES-128 24 = AES-192 32 = AES-256 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| url | 否 | String | 频道源流URL,用于外部拉流 | 
| bitrate | 否 | Integer | 码率。无需直播转码时,此参数为必填项 单位:bps。取值范围:(0,104,857,600](100Mbps) | 
| width | 否 | Integer | 分辨率对应宽的值,非必填项 取值范围:0 - 4096(4K) | 
| height | 否 | Integer | 分辨率对应高的值,非必填项 取值范围:0 - 2160(4K) | 
| bitrate_for3u8 | 否 | Boolean | 是否使用bitrate来固定码率。默认值:false | 
| passphrase | 否 | String | 协议为SRT_PUSH时的加密信息 | 
| backup_urls | 否 | Array of strings | 备入流地址列表 | 
| stream_id | 否 | String | 频道为SRT_PULL类型时,拉流地址的Stream ID。 | 
| latency | 否 | Integer | 频道为SRT_PULL类型时的拉流时延。 | 
| pbkeylen | 否 | Integer | srt加密算法 16 = AES-128 24 = AES-192 32 = AES-256 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| input_loss_threshold_msec | 否 | Integer | 入流停止的时长阈值。到达此阈值后,自动触发主备切换。 单位:毫秒,取值范围:0 - 3600000。 非必填,默认填2000ms。 | 
| input_preference | 否 | String | 以主入流URL为第一优先级(PRIMARY)或主备URL平等切换(EQUAL)。 如果是平等切换时,使用的是备URL,不会自动切换至主URL。 非必填,默认值为EQUAL。 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| name | 是 | String | 音频选择器的名称。仅支持大小写字母、数字、中划线和下划线。 同一个频道中每个选择器的名称需要唯一。 | 
| 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 | 语言输出策略。 取值如下: 
 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| audio_descriptions | 否 | Array of audio_descriptions objects | 音频输出配置的描述信息 | 
| video_descriptions | 否 | VideoDescriptions object | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| name | 是 | String | 音频输出配置的名称。仅支持大小写字母,数字,中划线(-),下划线(_)。 同一个频道不同的音频输出配置名称,不允许重复。 | 
| audio_selector_name | 是 | String | 音频选择器名称 | 
| language_code_control | 否 | String | 语言代码控制。这里的设置不会修改音频实际的语言,只会修改音频对外展示的语言。 包含如下选项: 
 | 
| language_code | 否 | String | 语言代码,输入2或3个小写字母。 | 
| stream_name | 否 | String | 流名称 | 
响应参数
状态码:200
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| result_code | String | 错误码 | 
| result_msg | String | 错误描述 | 
| domain | String | 推流域名 | 
| app_name | String | 组名或应用名,为必填项 | 
| id | String | 频道ID。频道唯一标识,为必填项 | 
| sources | Array of SourceRsp objects | 推流URL列表。创建频道时,只有入流协议为RTMP_PUSH时,会返回推流URL列表 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| 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
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| result_code | String | 错误码 | 
| result_msg | String | 错误描述 | 
| domain | String | 推流域名 | 
| app_name | String | 组名或应用名,为必填项 | 
| id | String | 频道ID。频道唯一标识,为必填项 | 
请求示例
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 | 
错误码
请参见错误码。
 
  