文档中心
数据流录制
服务端 API v2
开始录制

开始录制

更新时间：2024-04-02 14:55

1 描述

调用本接口开始数据流录制。

当开发者成功调用 StartDataFlowRecord 接口后，数据流录制服务会进入指定的房间，录制房间内的音视频、白板、自定义信令等。

每个录制任务时间最长为 24 小时。超过 24 小时，录制任务将自动停止录制。

2 接口原型

请求方法：POST
请求地址：https://cloudrecord-api.zego.im/?Action=StartDataFlowRecord
传输协议：HTTPS
调用频率限制：50 次/秒（测试环境：20 次/秒）

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式中的 “2.1 公共请求参数”。

参数	类型	是否必选	描述
RoomId	String	是	待录制的房间 ID。
RecordInputParams	Object	否	录制任务输入参数。详见 RecordInputParams 成员列表。

RecordInputParams 成员如下：

参数	类型	是否必选	描述
HasWhiteboard	Bool	否	是否录制白板。 true：录制白板 false：不录制白板（默认值）本参数为 true 时 `Whiteboard` 参数必选。
Whiteboard	Array of Object	否	白板参数，`HasWhiteboard` 为 true 时必选。详见 Whiteboard 成员列表。
MaxRecordTime	Int	否	录制任务最大时长，录制持续时间达到该值自动结束。单位：秒。默认值 86400 秒（24 小时），该值需大于等于 300，且小于等于 86400（24 小时）。
MixConfig	Object	否	混流参数。详见 MixConfig 成员列表。

Whiteboard 成员如下：

参数	类型	是否必选	描述
HorizontalRatio	Int	是	客户端白板展示窗口的宽高比（宽）。
VerticalRatio	Int	是	客户端白板展示窗口的宽高比（高）。
WhiteboardId	String	否	录制白板的 ID。

MixConfig 成员如下：

参数	类型	是否必选	描述
MixMode	Int	否	布局方式。 1：自定义布局 2：（默认）平分布局 3：水平布局 4：垂直布局 5：悬浮布局
MixMaxResolutionStreamId	String	否	`MixMode` 设为 3、4、5 时，用于指定显示大画面的流 ID。

4 请求示例

请求 URL

https://cloudrecord-api.zego.im/?Action=StartDataFlowRecord
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0
&IsTest=false

请求消息体

{
  "RoomId": "xxxx",
  "RecordInputParams": {
      "HasWhiteboard": true,
      "Whiteboard": [
          {
              "HorizontalRatio": 16,
              "VerticalRatio": 9,
              "WhiteboardId": "0000"
          }
      ],
      "MaxRecordTime": 1800,
      "MixConfig": {
          "MixMode": 3,
          "MixMaxResolutionStreamId": "teacher"
      }
  }
}

5 响应参数

参数	类型	描述
Code	Int64	错误码。
Message	String	错误描述。
RequestId	String	请求 ID。
Data	Object	响应对象。详见 Data 成员列表。

Data 成员如下：

参数	类型	描述
TaskId	String	数据流录制服务分配的任务 ID，长度固定为 16 个字节的字符串。任务 ID 是对一次录制生命周期过程的唯一标识，结束录制时会失去意义。

6 响应示例

以下是 StartDataFlowRecord 接口的响应示例。

{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "abcd123",
    "Data": {
        "TaskId": "XXXXXXXXXXXX"
    }
}

云通讯产品

AIGC

扩展服务

低代码互动产品

标准 AI 产品

AIGC

社交娱乐

电商直播

在线教育

医疗健康

互动游戏

协同办公

物联网