云端录制快速开始 (Deprecated)

本文介绍如何集成声网 Cloud Recording SDK 进行通话或直播录制。

当云端录制 SDK 加入频道时，相当于一个哑客户端加入频道，因此需要跟声网 Native/Web SDK 加入相同的频道，并使用相同的 App ID 和频道模式。

前提条件

请确保满足以下要求：

• 打开 TCP 端口：4447、8913、9700。
• 打开 UDP 端口：53、4444。
• 运行环境（物理或虚拟）：
  • Ubuntu Linux 14.04+ LTS 64 位
  • CentOS 6.5+（推荐 7.0）64 位
• 安装编译器 g++ 4.8 或以上版本。
• 联系 sales@agora.io 开通云端录制服务。
• 开通第三方云存储服务，目前支持七牛云、阿里云（推荐）和 Amazon S3。

集成

1. 下载云端录制 SDK。
2. 将云端录制 SDK 包中的 libagora-cloud-recording-client.so 和 IAgoraCloudRecording.h 文件添加到你的项目里，并确保与项目有连接。
3. Include 云端录制 SDK 包中的 IAgoraCloudRecording.h 头文件。

完成集成后，你可以参照下文进行云端录制。

实现云端录制

一个完整的云端录制过程主要包括以下步骤：

1. 创建实例

2. 开始录制（加入频道）

3. 结束录制（离开频道）

4. 释放资源

目前云端录制仅支持自动录制模式，也就是加入频道即自动开始录制，离开频道即自动结束录制。对于一个录制实例来说，离开频道后录制就结束了，如果需要再次录制必须创建一个新的实例。

你可以对同一个频道多次执行这个录制过程，录制你需要的内容。

创建实例

ICloudRecorder* CreateCloudRecorderInstance(ICloudRecorderObserver *observer);

在加入频道进行录制之前，需要调用 CreateCloudRecorderInstance 方法创建一个云端录制实例，并将其与应用程序相关联。可根据需要创建多个实例同时录制。

录制完成后，如不再需要该实例，可以通过调用 Release 方法销毁实例，释放资源。

开始云端录制

virtual int StartCloudRecording(
   const char* appId,
   const char* channel_name,
   const char* token,
   const uid_t uid,
   const RecordingConfig& recording_config,
   const CloudStorageConfig &storage_config) = 0;

创建实例后，调用 StartCloudRecording 方法开始录制，在该方法中需要填写如下参数：

• appId：待录制频道的 App ID，必填。
• channel_name：待录制频道的频道名，必填。
• token：待录制的频道中使用的 token，选填。详见校验用户权限。
• uid：云端录制使用的用户 ID，32 位无符号整数，取值范围 1 到 (2³²-1)，不可设置为 0，需保证唯一性。
• recording_config：配置录制参数，选填，如不填则使用默认配置。详见RecordingConfig。
• storage_config：配置第三方云存储，必填。详见 CloudStorageConfig。

• App ID 和频道名的设置必须与待录制频道的声网 Native/Web SDK 设置完全一致。
• 如果待录制频道使用了 Token，token 参数必须设置。

调用 StartCloudRecording 方法后，监测到频道内有用户即开始录制，并触发 OnRecordingStarted 回调，通知应用程序成功开始录制。

结束云端录制

virtual int StopCloudRecording() = 0;

录制完成后，调用 StopCloudRecording 方法离开频道，停止录制。

录制停止后如果需要再次开始录制，必须重新创建实例。

调用该方法后 SDK 会触发 OnRecordingStopped 回调，该回调通知应用程序已成功停止录制。

若未调用 StopCloudRecording 方法，当频道空闲（无用户）超过预设时间（默认为 30 秒） 后，Cloud Recording SDK 会自动退出频道停止录制，并触发 OnRecorderFailure 回调，错误码为 RecordingErrorNoUsers，通知应用程序录制退出异常。

释放资源

virtual void Release(bool cancelCloudRecording = false) = 0;

待录制完成并成功上传到第三方云存储后，你需要调用 Release 方法销毁 ICloudRecorder 实例，释放 SDK 使用的资源，释放资源后将无法再次使用和回调 SDK 内的其它方法。如需再次使用云端录制，必须重新创建实例。

在该方法中， cancelCloudRecording 参数默认为 false，正常情况下无需修改；如果录制出现错误需要重启录制服务，将该参数设为 true，具体情况请参考错误码。

上传和管理录制文件

开始录制后，声网服务器会将录制内容切片为多个 TS 文件并不断上传至预先设定的第三方云存储，直至录制结束。

录制 ID

录制 ID 是录制的唯一标识，每个录制实例对应一个录制 ID。

在创建录制实例后，你可以通过调用 GetRecordingId 方法获取录制 ID，所有的回调中也都包含录制 ID。

录制文件索引

每个录制实例均会生成一个 M3U8 文件，用于索引该次录制所有的 TS 文件。你可以通过 M3U8 文件播放和管理录制文件。

M3U8 文件名由录制 ID 和频道名组成，如 recording_id_channel_name.M3U8。

上传录制文件

录制文件的上传由声网服务器自动完成，你需要关注下面的回调。

• 录制过程中

  • OnRecordingUploadingProgress：录制开始后约每分钟触发一次，该回调中的 progress 参数表示已上传文件占已录制文件的百分比。

• 停止录制后，根据上传情况，SDK 会触发以下回调之一：

  • OnRecordingUploaded：如果录制文件全部成功上传至预先设定的云存储，最后一个录制切片文件上传完成时触发该回调，通知应用程序上传完成。
  • OnRecordingBackedUp：如果有录制文件未能成功上传至第三方云存储，声网服务器会将这部分文件自动上传至声网备份云，当录制结束后会触发该回调。声网备份云会继续尝试将这部分文件上传至设定的第三方云存储。如果等待五分钟后仍然不能正常播放录制文件，请联系声网技术支持。

以上回调中均包含 M3U8 文件名信息。

错误码

SDK 可能会触发以下异常或错误回调：

• OnRecorderFailure：录制组件异常，通常无需对此进行任何操作。
• OnUploaderFailure：上传组件异常，通常无需对此进行任何操作。
• OnRecordingFatalError：发生了不可恢复的错误，可根据具体的错误码判断录制后台的状态。

具体的错误描述及解决方法请参考错误码。