实时音视频 SPARKRTC-查询录制规则列表:响应参数
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-request-Id |
String |
此字段携带请求ID号,以便任务跟踪。 |
参数 |
参数类型 |
描述 |
---|---|---|
rules |
Array of RecordRule objects |
录制规则列表 |
参数 |
参数类型 |
描述 |
---|---|---|
rule_id |
String |
规则id,由服务端返回。创建或修改规则的时候不携带 |
app_id |
String |
应用id |
obs_addr |
RecordObsFileAddr object |
保存录制文件所在的桶信息 |
record_formats |
Array of strings |
录制格式:HLS格式或者MP4格式 |
hls_config |
HLSRecordConfig object |
hls格式录制规则管理 |
mp4_config |
MP4RecordConfig object |
mp4格式录制规则管理 |
create_time |
String |
创建时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC |
update_time |
String |
更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC |
参数 |
参数类型 |
描述 |
---|---|---|
location |
String |
OBS Bucket所在RegionID
|
project_id |
String |
OBS Bucket所在Region的项目ID |
bucket |
String |
OBS的bucket名称 |
object |
String |
OBS对象路径,遵守OBS Object定义。如果为空则保存到根目录 |
参数 |
参数类型 |
描述 |
---|---|---|
record_cycle |
Integer |
周期录制时长。 取值范围:[60,43200]或者0,如果为0则整个流录制为一个文件。 单位:秒。 |
record_prefix |
String |
录制m3u8文件含路径和文件名的前缀 默认{app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 可自定义以下特殊变量:
|
record_slice_duration |
Integer |
录制HLS时ts的切片时长,非必填。 取值范围:[2,60],缺省为10。 单位:秒。 |
record_max_duration_to_merge_file |
Integer |
录制HLS文件拼接时长,如果流中断超过该时间,则生成新文件。 取值范围:[-1,300],缺省为0。 单位:秒。
|
参数 |
参数类型 |
描述 |
---|---|---|
record_cycle |
Integer |
周期录制时长。 取值范围:[60,10800]。 单位:秒。 |
record_prefix |
String |
录制文件含路径和文件名的前缀。 默认{app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 可自定义以下特殊变量:
|
record_max_duration_to_merge_file |
Integer |
录制MP4拼接时长,如果流中断超过该时间,则生成新文件。 取值范围:[0,300],缺省为0。 单位:秒。 如果为0表示流中断就生成新文件。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-Id |
String |
此字段携带请求ID号,以便任务跟踪。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
X-request-Id |
String |
此字段携带请求ID号,以便任务跟踪。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
X-request-Id |
String |
此字段携带请求ID号,以便任务跟踪。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |