视频直播 LIVE-查询频道信息:响应参数

时间:2024-04-11 21:37:06

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总频道数

channels

Array of CreateOttChannelInfoReq objects

频道信息

表5 CreateOttChannelInfoReq

参数

参数类型

描述

domain

String

频道推流域名

app_name

String

组名或应用名

id

String

频道ID。频道唯一标识,为必填项。频道ID不建议输入下划线“_”,否则会影响转码和截图任务

name

String

频道名。可选配置

state

String

频道状态

  • ON:频道下发成功后,自动启动拉流、转码、录制等功能

  • OFF:仅保存频道信息,不启动频道

input

InputStreamInfo object

频道入流信息

encoder_settings

Array of encoder_settings objects

转码模板配置

record_settings

record_settings object

最大回看录制时长。在此时间段内会连续不断的录制,为必选项

单位:秒。取值为“0”时,表示不支持录制;最大支持录制14天

endpoints

Array of EndpointItem objects

频道出流信息

表6 InputStreamInfo

参数

参数类型

描述

input_protocol

String

频道入流协议

  • FLV_PULL

  • RTMP_PUSH

  • RTMP_PULL

  • HLS_PULL

  • SRT_PULL

  • SRT_PUSH

sources

Array of SourcesInfo objects

频道主源流信息。入流协议为RTMP_PUSH和SRT_PUSH时,非必填项。其他情况下,均为必填项。

secondary_sources

Array of SecondarySourcesInfo objects

备入流数组,非必填项。如果有备入流,则主备入流必须保证路数、codec和分辨率均一致。入流协议为RTMP_PUSH时,无需填写。

failover_conditions

FailoverConditions object

有主备入流时,当前参数为必选。入流协议为RTMP_PUSH时,无需填写。

max_bandwidth_limit

Integer

当入流协议为HLS_PULL时,最大带宽限制。 未配置会默认选择BANDWIDTH最高的流

ip_port_mode

Boolean

当推流协议为SRT_PUSH时,如果配置了直推源站,编码器不支持输入streamid,需要打开设置为true

表7 SourcesInfo

参数

参数类型

描述

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时,拉流地址的streamid

latency

Integer

协议为SRT_PULL时,拉流时延

表8 SecondarySourcesInfo

参数

参数类型

描述

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时,拉流地址的streamid

latency

Integer

协议为SRT_PULL时,拉流时延

表9 FailoverConditions

参数

参数类型

描述

input_loss_threshold_msec

Integer

入流停止的时长阈值。到达此阈值后,自动触发主备切换

单位:毫秒,取值范围:0 - 3600000

input_preference

String

以主入流URL为第一优先级(PRIMARY)或主备URL平等切换(EQUAL)

如果为平等切换时使用的是备URL,无需手工切换到主URL

表10 encoder_settings

参数

参数类型

描述

template_id

String

转码模板ID

表11 record_settings

参数

参数类型

描述

rollingbuffer_duration

Integer

最大回看录制时长。在此时间段内会连续不断的录制,为必选项

单位:秒。取值为“0”时,表示不支持录制;最大支持录制14天

表12 EndpointItem

参数

参数类型

描述

hls_package

Array of HlsPackageItem objects

HLS打包信息

dash_package

Array of DashPackageItem objects

DASH打包信息

mss_package

Array of MssPackageItem objects

MSS打包信息

表13 HlsPackageItem

参数

参数类型

描述

url

String

客户自定义的拉流地址,包括方法、域名、路径和参数

stream_selection

Array of StreamSelectionItem objects

从全量流中过滤出一个码率在[min, max]区间的流。如果不需要码率过滤可不选。

hls_version

String

HLS版本号

segment_duration_seconds

Integer

频道输出分片的时长,为必选项

单位:秒。取值范围:1-10

playlist_window_seconds

Integer

频道直播返回分片的窗口长度,为频道输出分片的时长乘以数量后得到的值。实际返回的分片数不小于3个。

单位:秒。取值范围:0 - 86400(24小时转化成秒后的取值)

encryption

Encryption object

加密信息

ads

Object

广告配置

ext_args

Object

其他额外参数

request_args

PackageRequestArgs object

播放相关配置

表14 DashPackageItem

参数

参数类型

描述

url

String

客户自定义的拉流地址,包括方法、域名、路径和参数

stream_selection

Array of StreamSelectionItem objects

从全量流中过滤出一个码率在[min, max]区间的流。如果不需要码率过滤可不选。

segment_duration_seconds

Integer

频道输出分片的时长,为必选项

单位:秒。取值范围:1-10

playlist_window_seconds

Integer

频道直播返回分片的窗口长度,为频道输出分片的时长乘以数量后得到的值。实际返回的分片数不小于3个。

单位:秒。取值范围:0 - 86400(24小时转化成秒后的取值)

encryption

Encryption object

加密信息

ads

Object

广告配置

ext_args

Object

其他额外参数

request_args

PackageRequestArgs object

播放相关配置

表15 MssPackageItem

参数

参数类型

描述

url

String

客户自定义的拉流地址,包括方法、域名、路径和参数

stream_selection

Array of StreamSelectionItem objects

从全量流中过滤出一个码率在[min, max]区间的流。如果不需要码率过滤可不选。

segment_duration_seconds

Integer

频道输出分片的时长,为必选项

单位:秒。取值范围:1-10

playlist_window_seconds

Integer

频道直播返回分片的窗口长度,为频道输出分片的时长乘以数量后得到的值。实际返回的分片数不小于3个。

单位:秒。取值范围:0 - 86400(24小时转化成秒后的取值)

encryption

Encryption object

加密信息

ext_args

Object

其他额外参数

delay_segment

Integer

延播时长,单位秒

request_args

PackageRequestArgs object

播放相关配置

表16 StreamSelectionItem

参数

参数类型

描述

key

String

拉流URL中用于码率过滤的参数

max_bandwidth

Integer

最大码率,单位:bps

取值范围:0 - 104,857,600(100Mbps)

min_bandwidth

Integer

最小码率,单位:bps

取值范围:0 - 104,857,600(100Mbps)

表17 Encryption

参数

参数类型

描述

key_rotation_interval_seconds

Integer

密钥缓存时间。如果密钥不变,默认缓存七天

encryption_method

String

加密方式

level

String

取值如下:

  • content:一个频道对应一个密钥

  • profile:一个码率对应一个密钥

默认值:content

drm_content_id

String

客户生成的DRM内容ID

system_ids

Array of strings

system_id枚举值

auth_info

String

增加到请求消息体header中的鉴权信息

km_url

String

获取密钥的DRM地址

表18 PackageRequestArgs

参数

参数类型

描述

record

Array of RecordRequestArgs objects

录制播放相关配置

timeshift

Array of TimeshiftRequestArgs objects

时移播放相关配置

live

Array of LiveRequestArgs objects

直播播放相关配置

表19 RecordRequestArgs

参数

参数类型

描述

start_time

String

开始时间

end_time

String

结束时间

format

String

格式

unit

String

单位

表20 TimeshiftRequestArgs

参数

参数类型

描述

back_time

String

时移时长字段名

unit

String

单位

表21 LiveRequestArgs

参数

参数类型

描述

delay

String

时延字段

unit

String

单位

状态码: 400

表22 响应Body参数

参数

参数类型

描述

result_code

String

错误码

result_msg

String

错误描述

domain

String

推流域名

app_name

String

组名或应用名,为必填项

id

String

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

support.huaweicloud.com/mediaapi-live/ListOttChannelInfo.html