启动录制任务
该接口用于启动录制任务,录制结束生将生成的 mp4 文件上传到指定的对象存储桶中。
注意:
请确保打开了录制功能。
请确保正确配置了对象存储的存储位置,否则可能导致录制失败。
至少有1个用户加入到频道。
请求路径
/v1/cloudRecord
请求方法
POST
公共参数
请参考请求 query 公共参数 。
请求参数
参数 | 类型 | 是否必填 | 说明 | 默认值 |
---|---|---|---|---|
app_id | String | 是 | 应用 ID | - |
project_id | String | 是 | 项目 ID | - |
channel | String | 是 | 频道名称 | - |
sign_key | String | 是 | 项目密钥(需base64编码) | - |
isAudioOnly | int | 否 | 是否仅录制音频。 0:(默认)音视频同时录制。 1:仅启用音频录制功能,关闭视频录制。 isAudioOnly 和 isVideoOnly 不能同时设置为 1。 |
0 |
isVideoOnly | int | 否 | 是否仅录制视频。 0:(默认)音视频同时录制。 1:仅启用视频录制功能,关闭音频录制。 isAudioOnly 和 isVideoOnly 不能同时设置为 1。 |
0 |
mixed_video_audio | int | 否 | 同时录制音视频时的文件混合模式。 0:(默认)不混合音频和视频。 1:音频和视频混合成一个文件,录制文件格式为 MP4,但播放器支持有限。 2:音频和视频混合成一个文件,录制文件格式为 MP4,支持更多播放器。 |
2 |
layout_mode | int | 否 | 0 | |
stream_type | int | 否 | 设置录制的视频流类型,只有在待录制频道开启了双流模式时该设置才会生效。 0:(默认)录制视频大流。 1:录制视频小流。 |
0 |
is_mixing_enabled | int | 否 | 0 |
返回值
{
"code": "success",
"task_id": 40
}
返回数据说明,如下表所示。
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
code | String | 是 | 响应代码 |
task_id | int | 是 | 录制任务 ID。 |