本文介绍使用云端录制 RESTful API 进行单流录制的重点步骤。建议你同时参考云端录制 RESTful API 快速开始了解云端录制的基础流程。

功能描述

云端录制共支持三种录制模式：

• 单流录制
• 合流录制
• 页面录制

单流录制模式下，分别录制频道中每个 UID 的音频流和视频流，每个 UID 均有其对应的音频文件和视频文件。

举例来说，当频道中有两个用户，且同时录制音视频时，单流录制生成的文件如下图所示：

录制后共生成四个 M3U8 文件（每个 UID 对应两个 M3U8 文件）和多个 TS/WebM 文件，分开存储音视频数据。通过音视频合并转码脚本完成文件合并后，你会得到两个 MP4 文件。

实现方法

获取 resource ID

在开始录制前，必须调用 acquire 方法请求一个用于云端录制的 resource ID。如果要使用延时转码，需要将 scene 设置为 2。

请求示例

• 请求 URL：

    https://api.agora.io/v1/apps/<yourappid>/cloud_recording/acquire

• Content-type 为 application/json;charset=utf-8

• Authorization 为 Basic authorization，生成方法请参考 RESTful API 认证。

• 请求包体内容：

{
    "cname": "httpClient463224",
    "uid": "527841",
    "clientRequest":{
      "resourceExpiredHour": 24,
      "scene": 0
   }
}

开始录制

在调用 start 方法时，你需要将 mode 参数设置为 individual，开启单流录制模式。该模式下，你还需要通过 recordingConfig 设置单流录制的详细信息，以及通过 storageConfig 设置第三方云存储的信息。

单流录制支持的 clientRequest 参数包括：

请求示例

• 请求 URL：

https://api.agora.io/v1/apps/<yourappid>/cloud_recording/resourceid/<resourceid>/mode/individual/start

• Content-type 为 application/json;charset=utf-8
• Authorization 为 Basic authorization，生成方法请参考 RESTful API 认证。
• 请求包体内容：

实时录制

{
    "uid": "527841",
    "cname": "httpClient463224",
    "clientRequest": {
        "token": "<token if any>",
        "recordingConfig": {
            "maxIdleTime": 30,
            "streamTypes": 2,
            "channelType": 0, 
            "videoStreamType": 0, 
            "subscribeVideoUids": ["123","456"], 
            "subscribeAudioUids": ["123","456"],
            "subscribeUidGroup": 0
        }, 
        "storageConfig": {
            "accessKey": "xxxxxxf",
            "region": 3,
            "bucket": "xxxxx",
            "secretKey": "xxxxx",
            "vendor": 2,
            "fileNamePrefix": ["directory1","directory2"]
       }
   }
}

延时转码

{
    "uid": "527841",
    "cname": "httpClient463224",
    "clientRequest": {
        "token": "<token if any>",
        "appsCollection": {
            "combinationPolicy": "postpone_transcoding"
        }, 
        "recordingConfig": {
            "maxIdleTime": 30,
            "streamTypes": 2,
            "channelType": 0, 
            "videoStreamType": 1, 
            "subscribeVideoUids": ["123","456"], 
            "subscribeAudioUids": ["123","456"],
            "subscribeUidGroup": 0
        }, 
        "storageConfig": {
            "accessKey": "xxxxxxf",
            "region": 3,
            "bucket": "xxxxx",
            "secretKey": "xxxxx",
            "vendor": 2,
            "fileNamePrefix": ["directory1","directory2"]
       }
   }
}

停止录制

录制完成后，调用 stop 方法离开频道，停止录制。录制停止后如需再次录制，必须再调用 acquire 方法请求一个新的 resource ID。

请求示例

• 请求 URL：

  https://api.agora.io/v1/apps/<yourappid>/cloud_recording/resourceid/<resourceid>/sid/<sid>/mode/individual/stop

• Content-type 为 application/json;charset=utf-8

• Authorization 为 Basic authorization，生成方法请参考 RESTful API 认证。

• 请求包体内容：

  {
  "cname": "httpClient463224",
  "uid": "527841",  
  "clientRequest":{
    }
  }

录制生成文件

该模式下录制文件的音视频编码配置如下：

• 音频编码配置：采样率固定为 48 kHz，声道数和码率与原始音频流一致。
• 视频编码配置：与原始视频流一致。

根据录制内容的不同，录制生成的文件如下表所示：

单流模式下，Web 端选择 VP8 编码时，云端录制生成的切片文件为 WebM 文件。其他情况下生成的切片文件均为 TS 文件。

录制文件的命名规则详见管理录制文件。

开发注意事项

Web SDK 3.x 和 4.x 在禁用视频轨道之后，录制效果有所不同，详见下表：