实时音视频 SparkRTC-创建或更新录制规则:请求参数
下载实时音视频 SparkRTC用户手册完整版
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
内容类型。 |
|
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信息。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
obs_addr |
是 |
RecordObsFileAddr object |
保存录制文件所在的桶信息 |
|
record_formats |
是 |
Array of strings |
录制格式：支持HLS格式和MP4格式（HLS和MP4为大写）。
|
|
hls_config |
否 |
HLSRecordConfig object |
HLS格式录制规则管理 |
|
mp4_config |
否 |
MP4RecordConfig object |
MP4格式录制规则管理 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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表示流中断就生成新文件。 |
