开启云端录制

API接口URL

https://sdk.cloudroom.com/CLOUDMEETING-API/v2/record/start

请求方式：POST

参数

公共参数

接口参数

Cfg 参数说明：

说明：audioFileCfg 和 videoFileCfg 至少选择一种格式录制。

AudioFileCfg音频文件配置

1.单流模式参数说明：

2.合流模式参数说明：

VideoFileCfg视频文件配置

1.单流模式参数说明：

2.合流模式参数说明：

LayoutConfig 参数说明：

示例：

//录制“usr1”的1号摄像头
{
    type: 0,
    keepAspectRatio: 1,
    left: 5,
    top: 10,
    width: 633,
    height: 356,
    param: {
        camid: "usr1.1"
    }
}

//录制“usr2”的默认摄像头
{
    type: 0,
    keepAspectRatio: 1,
    left: 642,
    top: 10,
    width: 633,
    height: 356,
    param: {
        camid: "usr2.-1"
    }
}

//录制时间戳
{
    type: 10,
    left: 980,
    top: 660,
    param: {
        text: '%timestamp%',
        color: "#ffffff",
        "font-size": 30
    },
}

//录制白板
{
    type: 6,
    left: 0,
    top: 0,
    width: 1280,
    height: 720,
    param: {
        background: '#FFFFFFFF'
    }
}

type参数说明：

• 当type =0时，表示摄像头，param必须包含camid；
• 当type =3时，表示影音共享，不用附加任何参数；
• 当type =5时，表示共享的屏幕，不用附加任何参数；
• 当type =6时，表示白板，不用附加任何参数；
• 当type =10时，表示文本，width 和 height 将被忽略，元素大小由文本信息自动确定。 param必须包含text，可选text-color，bk-color，font-size，text-margin；

param支持的参数：

• camid：用户id.摄像头id。默认摄像头的值为-1，如："testuser.-1"
• resourceid：具有唯一属性的字符串id，通过setPicResource将图片存储到sdk内供混图模块使用
• screenid：屏幕序号，-1表示主屏
• pid：进程号
• area：抓屏区域:"x,y,w,h"
• text：文本内容，支持时间戳参数"%timestamp%"，格式为：YYYY-MM-DD HH:MM:SS
• text-color：文本颜色，支持格式："#RGB","#RRGGBB", "#AARRGGBB"， 默认"#FFFFFF"
• bk-color：背景色，支持格式："#RGB","#RRGGBB", "#AARRGGBB"， 默认"#7D000000"
• font-size：字体大小，默认18
• text-margin：边距，默认5

请求示例

1.为房间中所有人录制独立的声音文件，独立的默认摄像头视频文件请求体示例：

{
    "RequestId":"95257a6e-dd78-19f9-0c78-3f3de5d35191",
    "CompID":111111,
    "SecretKey":"08635988d9be4151fcb5251b0af2b3c1",
    "AppId":"demo",
    "RoomId":"81954961",
    "cfg": {
        "mode": 1,
        "audioFileCfg": {
            "svrPathName": "/2025-12-01/房间号/$UID$_$TIME$.mp3",
            "subscribeAudios": ["_cr_all_"]
        },
        "videoFileCfg": {
            "svrPathName": "/2025-12-01/房间号/$UID$_cam$CAMID$_$TIME$.mp4",
            "subscribeVideos": ["_cr_allDefCam_"],
            "aStreamType": 0
        }
    }
}

2.录制一个2分屏左右布局图像+房间声音的mp4文件请求体示例：

{
    "RequestId":"95257a6e-dd78-19f9-0c78-3f3de5d35191",
    "CompID":111111,
    "SecretKey":"08635988d9be4151fcb5251b0af2b3c1",
    "RoomId":81954961,
    "cfg": {
        "mode": 0,
        "videoFileCfg": {
            "svrPathName": "/2025-12-01/房间号/2025-12-01_1764236203.mp4",
            "aChannelType": 0,
            "vWidth": 1280,
            "vHeight": 720,
            "layoutConfig": [
                {
                    "type": 0,
                    "top": 180,
                    "left": 0,
                    "width": 640,
                    "height": 360,
                    "keepAspectRatio": 1,
                    "param": {
                        "camid": "usr1.1"
                    }
                },
                {
                    "type": 0,
                    "top": 180,
                    "left": 0,
                    "width": 640,
                    "height": 360,
                    "keepAspectRatio": 1,
                    "param": {
                        "camid": "usr2.-1"
                    }
                }
            ]
        }
    }
}

返回数据

Data 数据

返回参数示例

{
    "RspCode":0,
    "RspDesc":"请求成功",
    "Data":{
        "RecordID":"9eda74eecb5de36e492dbab55aaaa071"
    }
}

返回状态码RspCode说明