更新云端录制
说明:
在录制过程中,可以调用本接口更新录制配置。仅可更新已存在的配置节点,不同模式的可修改范围见下方参数说明。
API接口URL
https://sdk.cloudroom.com/CLOUDMEETING-API/v2/record/update
请求方式:POST
参数
接口参数
| 名称 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| RoomId | Int | 是 | 房间号 |
| RecordID | String | 是 | 录制ID |
| audioFileCfg | AudioFileCfg | 否 | 音频文件配置,仅可更新已存在的节点 |
| videoFileCfg | VideoFileCfg | 否 | 视频文件配置,仅可更新已存在的节点 |
说明:audioFileCfg 和 videoFileCfg 请至少选择一种。
AudioFileCfg 音频文件配置
仅单流模式支持更新已有音频配置(合流模式不支持)。
| 名称 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| subscribeAudios | String[] | 否 | 更新订阅名单;取值:["_cr_all_"](所有人)或 ["userId1","userId2"](指定用户) |
注意:不可传
svrPathName,文件名不可修改。
VideoFileCfg 视频文件配置
单流模式 — 更新已有视频配置:
| 名称 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| subscribeVideos | String[] | 否 | 更新订阅名单;取值:["_cr_all_"](所有人所有摄像头)、["_cr_allDefCam_"](所有人默认摄像头)或 ["userId1.camId", ...](指定用户的摄像头) |
| pushCfg | PushCfg[] | 否 | 推流配置列表;参数同 PushCfg |
注意:不可传
svrPathName、aStreamType。
合流模式 — 更新已有视频配置:
| 名称 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| svrPathName | String | 否 | 更新输出文件路径;支持以 ; 分隔多个路径,可同时输出多种格式(mp4、flv 等)和推流地址(rtmp://、rtsp://) |
| layoutConfig | LayoutConfig[] | 否 | 更新合流布局内容列表 |
注意:不可传
aChannelType、aChannelContent、vWidth、vHeight、vFps、vBps、vQP。
请求示例
单流 - 更新视频订阅名单
将录制所有人的默认摄像头改为仅录制指定用户的摄像头:
{
"RequestId": "95257a6e-dd78-19f9-0c78-3f3de5d35191",
"CompID": 111111,
"SecretKey": "08635988d9be4151fcb5251b0af2b3c1",
"RoomId": 81954961,
"RecordID": "9eda74eecb5de36e492dbab55aaaa071",
"videoFileCfg": {
"subscribeVideos": ["user1.-1", "user2.1"]
}
}
单流 - 更新音频订阅名单
将录制所有人的音频改为只录制指定用户:
{
"RequestId": "95257a6e-dd78-19f9-0c78-3f3de5d35191",
"CompID": 111111,
"SecretKey": "08635988d9be4151fcb5251b0af2b3c1",
"AppId": "demo",
"RoomId": 81954961,
"RecordID": "9eda74eecb5de36e492dbab55aaaa071",
"audioFileCfg": {
"subscribeAudios": ["user1", "user2"]
}
}
单流 - 同时更新音频和视频订阅名单
同时更换音频和视频的订阅用户:
{
"RequestId": "95257a6e-dd78-19f9-0c78-3f3de5d35191",
"CompID": 111111,
"SecretKey": "08635988d9be4151fcb5251b0af2b3c1",
"AppId": "demo",
"RoomId": 81954961,
"RecordID": "9eda74eecb5de36e492dbab55aaaa071",
"audioFileCfg": {
"subscribeAudios": ["user1", "user2"]
},
"videoFileCfg": {
"subscribeVideos": ["user1.-1", "user2.1"]
}
}
单流 - 更新视频订阅名单 + 推流配置
更新订阅名单的同时,将指定摄像头的流推到第三方直播平台:
{
"RequestId": "95257a6e-dd78-19f9-0c78-3f3de5d35191",
"CompID": 111111,
"SecretKey": "08635988d9be4151fcb5251b0af2b3c1",
"RoomId": 81954961,
"RecordID": "9eda74eecb5de36e492dbab55aaaa071",
"videoFileCfg": {
"subscribeVideos": ["user1.-1", "user2.1"],
"pushCfg": [
{
"streamID": "user1.-1",
"urls": ["rtmp://push.example.com/live/stream1"]
}
]
}
}
合流 - 更新布局并增加输出格式
原任务录制 MP4,现增加 FLV 格式和 RTMP 推流,同时调整布局为左右分屏:
{
"RequestId": "95257a6e-dd78-19f9-0c78-3f3de5d35191",
"CompID": 111111,
"SecretKey": "08635988d9be4151fcb5251b0af2b3c1",
"AppId": "demo",
"RoomId": 81954961,
"RecordID": "9eda74eecb5de36e492dbab55aaaa071",
"videoFileCfg": {
"svrPathName": "/2025-12-01/房间号/2025-12-01_mixed.mp4;/2025-12-01/房间号/2025-12-01_mixed.flv;rtmp://push.example.com/live/stream1;",
"layoutConfig": [
{
"type": 0,
"top": 180,
"left": 0,
"width": 640,
"height": 360,
"keepAspectRatio": 1,
"param": { "camid": "user1.-1" }
},
{
"type": 0,
"top": 180,
"left": 640,
"width": 640,
"height": 360,
"keepAspectRatio": 1,
"param": { "camid": "user2.-1" }
}
]
}
}
合流 - 仅更新输出格式
原任务录制 MP4,现增加 FLV 文件和 RTMP 推流,布局不变:
{
"RequestId": "95257a6e-dd78-19f9-0c78-3f3de5d35191",
"CompID": 111111,
"SecretKey": "08635988d9be4151fcb5251b0af2b3c1",
"AppId": "demo",
"RoomId": 81954961,
"RecordID": "9eda74eecb5de36e492dbab55aaaa071",
"videoFileCfg": {
"svrPathName": "/2025-12-01/房间号/2025-12-01_mixed.mp4;/2025-12-01/房间号/2025-12-01_mixed.flv;rtmp://push.example.com/live/stream1;"
}
}
合流 - 仅更新布局
不改变输出格式,仅将布局从单画面切换为左右分屏:
{
"RequestId": "95257a6e-dd78-19f9-0c78-3f3de5d35191",
"CompID": 111111,
"SecretKey": "08635988d9be4151fcb5251b0af2b3c1",
"AppId": "demo",
"RoomId": 81954961,
"RecordID": "9eda74eecb5de36e492dbab55aaaa071",
"videoFileCfg": {
"layoutConfig": [
{
"type": 0,
"top": 180,
"left": 0,
"width": 640,
"height": 360,
"keepAspectRatio": 1,
"param": { "camid": "user1.-1" }
},
{
"type": 0,
"top": 180,
"left": 640,
"width": 640,
"height": 360,
"keepAspectRatio": 1,
"param": { "camid": "user2.-1" }
}
]
}
}
返回数据
| 名称 | 类型 | 说明 |
|---|---|---|
| RspCode | String | 响应码 |
| RspDesc | String | 响应描述 |
返回参数示例
{
"RspCode": 0,
"RspDesc": "请求成功"
}
返回状态码RspCode说明
| 数值 | 说明 |
|---|---|
| 0 | 请求成功 |
| 1 | 用户所属企业没有接口API权限 |
| 2 | 账号不存在 |
| 3 | 密码错误 |
| 4 | 未获取到正确参数 |
| 5 | 未知错误 |
| 6 | 缺少必传参数 |
| 35 | 房间号不存在 |
| 45 | 录制ID不存在 |
| 71 | subscribeAudios 参数错误,请检查格式和内容 |
| 72 | subscribeVideos 参数错误,请检查格式和内容 |
| 73 | aChannelType 参数错误,有效值为0或1 |
| 74 | aChannelContent 参数错误,请检查格式和内容 |
| 75 | 房间内人数少于2人,不能录制左右声道 |
| 78 | 视频文件格式错误 |
| 79 | 音频文件格式错误 |
| 80 | 布局配置参数错误 |
| 81 | 用户id不存在 |
| 82 | 未开通录制权限 |
| 83 | 推流配置参数错误 |
| 85 | 当前录制模式下不可修改已有配置 |
| 86 | 参数不可修改 |
| 22008 | 接口超出频率 |
| 22009 | 参数不能为空 |