跳到主要内容

更改布局

在录制分流时，可修改录制布局。

注意

如果录制 mcu 合流，无法通过此 API 修改配置。

开通服务​

云端录制为付费增值服务。

  • 在开发环境下，可免费体验云端录制服务。可登录控制台，在 云端录制页面开通服务，查看免费体验额度。
  • 在生产环境下，需要预存费用才能开通服务。

在使用云端录制 API 之前，请确认已在控制台开通云端录制服务，并已完成相关配置。请注意，录制触发方式需要配置为手动才能使用 API 控制录制服务。详见配置云端录制服务。

请求方法​

POST: http(s)://api.rong-api.com/rtc/record/config.json

签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详见 API 请求签名。

正文参数​

HTTP 请求正文中包含具有以下结构的 JSON 对象：

参数类型必传说明
sessionIdString是当前通话的会话 ID。您可以通过融云服务端回调获取该 sessionId，请参见房间状态同步。
mixLayoutNumber是mix 模式下的视频合流布局方式，可选项：
1：自定义布局
2：悬浮布局
3：自适应布局
默认值为悬浮布局。详见了解合流布局。
renderModeNumber是视频的填充方式，可选项：
1：等比放大填充（相对视频源会有裁剪）
2：等比缩放（可能会有黑边）
默认值为等比缩放。
hostUserIdString是主画面的用户 ID。
悬浮布局时使用该用户的视频渲染主背景；
自适应布局时使用该用户的视频渲染左上角的画面；
自定义布局时可不传。
hostStreamIdString是主画面的视频流 ID。
悬浮布局时使用该视频流渲染主背景；
自适应布局时使用该视频流渲染左上角的画面；
自定义布局时可不传。
input.videoArray是用于设置合流布局每个用户视频子窗口的位置和大小。
input.video[i].userIdString是子窗口的用户 ID
input.video[i].streamIdString是子窗口的视频流 ID
input.video[i].xNumber是浮点数。子窗口的起始点 x 轴相对坐标
即：距离左边框的像素点 / videoResolution 的宽度
input.video[i].yNumber是浮点数。子窗口的起始点 y 轴相对坐标
即：距离上边框的像素点 / videoResolution 的高度
input.video[i].widthNumber是浮点数。子窗口的相对宽度
即：子窗口的宽度除以 videoResolution 的宽度
input.video[i].heightNumber是浮点数。子窗口的相对高度
即：子窗口的高度除以 videoResolution 的高度

请求示例​

POST /rtc/record/config.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1585127132438
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Room-Id: room1
Content-Type: application/json

{
    "sessionId":"aaa",
    "renderMode":1,
    "mixLayout":1,
    "hostUserId":"abc",
    "hostStreamId":"111_RongCloudRTC",
    "input":{
        "video":[
            {
                "userId":"111",
                "streamId":"111_RongCloudRTC",
                "x":0,
                "y":0,
                "width":0.5,
                "height":0.5
            },
            {
                "userId":"2222",
                "streamId":"2222_RongCloudRTC",
                "x":0.5,
                "y":0.5,
                "width":0.5,
                "height":0.5
            }
        ]
    }
}

返回结果​

返回值返回类型说明
codeNumber返回码，200 为正常。
errorMessageString错误信息。
recordIdString录制 ID，每次录制任务的唯一标识。可以用于录制回调或文件切片关联。

返回结果示例​

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "code":200,
    "errorMessage":"Success",
    "recordId":"b8bed381888091ff4e6a42d6f3b8782a"
}
最后于 更新