视频直播 LIVE-新建OTT频道:请求参数
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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访问服务。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain |
是 |
String |
频道推流域名 |
app_name |
是 |
String |
组名或应用名 |
id |
是 |
String |
频道ID。频道唯一标识,为必填项。频道ID不建议输入下划线“_”,否则会影响转码和截图任务 |
name |
否 |
String |
频道名。可选配置 |
state |
是 |
String |
频道状态
|
input |
是 |
InputStreamInfo object |
频道入流信息 |
encoder_settings |
否 |
Array of encoder_settings objects |
转码模板配置 |
record_settings |
是 |
record_settings object |
最大回看录制时长。在此时间段内会连续不断的录制,为必选项 单位:秒。取值为“0”时,表示不支持录制;最大支持录制14天 |
endpoints |
是 |
Array of EndpointItem objects |
频道出流信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
有主备入流时,当前参数为必选。入流协议为RTMP_PUSH时,无需填写。 |
max_bandwidth_limit |
否 |
Integer |
当入流协议为HLS_PULL时,最大带宽限制。 未配置会默认选择BANDWIDTH最高的流 |
ip_port_mode |
否 |
Boolean |
当推流协议为SRT_PUSH时,如果配置了直推源站,编码器不支持输入streamid,需要打开设置为true |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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时,拉流时延 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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时,拉流时延 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
input_loss_threshold_msec |
否 |
Integer |
入流停止的时长阈值。到达此阈值后,自动触发主备切换 单位:毫秒,取值范围:0 - 3600000 |
input_preference |
否 |
String |
以主入流URL为第一优先级(PRIMARY)或主备URL平等切换(EQUAL) 如果为平等切换时使用的是备URL,无需手工切换到主URL |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
rollingbuffer_duration |
是 |
Integer |
最大回看录制时长。在此时间段内会连续不断的录制,为必选项 单位:秒。取值为“0”时,表示不支持录制;最大支持录制14天 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
hls_package |
否 |
Array of HlsPackageItem objects |
HLS打包信息 |
dash_package |
否 |
Array of DashPackageItem objects |
DASH打包信息 |
mss_package |
否 |
Array of MssPackageItem objects |
MSS打包信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
播放相关配置 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
播放相关配置 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
播放相关配置 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key |
否 |
String |
拉流URL中用于码率过滤的参数 |
max_bandwidth |
否 |
Integer |
最大码率,单位:bps 取值范围:0 - 104,857,600(100Mbps) |
min_bandwidth |
否 |
Integer |
最小码率,单位:bps 取值范围:0 - 104,857,600(100Mbps) |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key_rotation_interval_seconds |
否 |
Integer |
密钥缓存时间。如果密钥不变,默认缓存七天 |
encryption_method |
否 |
String |
加密方式 |
level |
否 |
String |
取值如下:
默认值:content |
drm_content_id |
是 |
String |
客户生成的DRM内容ID |
system_ids |
是 |
Array of strings |
system_id枚举值 |
auth_info |
是 |
String |
增加到请求消息体header中的鉴权信息 |
km_url |
是 |
String |
获取密钥的DRM地址 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
record |
否 |
Array of RecordRequestArgs objects |
录制播放相关配置 |
timeshift |
否 |
Array of TimeshiftRequestArgs objects |
时移播放相关配置 |
live |
否 |
Array of LiveRequestArgs objects |
直播播放相关配置 |