Demo 使用指南 (Deprecated)

本文介绍如何通过命令行运行 C++ demo 进行录制。 你也可以通过调用 API 实现录制，详见调用 API 录制。无论是使用命令行，还是调用 API，实现的都是相同的功能，你可以根据个人习惯选择其中一种方式。

前提条件

请确保满足以下要求：

• 打开 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。

运行 Demo

1. 下载云端录制 SDK 并解压缩。

2. 打开命令行工具，进入 SDK 包中 cloud_recording_demo.bin 所在目录，执行 ./cloud_recording_demo.bin 命令，即可看到录制相关的参数和选项，如下所示：

   Usage: 
   ./cloud_recording_demo.bin --appId STRING --channelName STRING --uid UINTEGER32 --token STRING --recordingStreamType UINTEGER32 --videoStreamType UINTEGER32 --decryption_mode UINTEGER32 --secret STRING --channelType UINTEGER32 --audioProfile UINTEGER32 --mixWidth UINTEGER32 --mixHeight UINTEGER32 --fps UINTEGER32 --bitrate UINTEGER32 --maxResolutionUid UINTEGER32 --mixedVideoLayoutType UINTEGER32 --maxIdleTime UINTEGER32 --vendor UINTEGER32 --region UINTEGER32 --bucket STRING --accessKey STRING --secretKey STRING 
                             --appId     (app id)
                             --channelName     (channel name)
                             --uid     (User id)
                             --token     (channel token/Optional)
                             --recordingStreamType     (stream types (Optional: 0 for audio only,  1 for video only, 2 for audio and video, default 2))
                             --videoStreamType     (video stream type(Optional: 0 for high video, 1 for low video, default 0. Only works when recordingStreamType is not 0.))
                             --decryption_mode     (decryption mode(Optional, 0 for none, 1 for aes-128-xts,2 for aes-128-ecb, 3 for aes-256-xts, no decryption by default.))
                             --secret     (secret(Optional, emptry by default))
                             --channelType     (channel type (Optional 0 for communication, 1 for live, default 0))
                             —audioProfile     (audio profile, (Optional 0 for single channel mono, 1 for single channel music, 2 for multi channel music. default 0))
                             —mixWidth     (transcoding mixing width (Optional, defualt 640))
                             —mixHeight     (transcoding mixing height (Optional, default 360))
                             —fps     (transcoding fps(Optional, default 15))
                             —bitrate     (transcoding bitrate(Optional, 500 by default))
                             —maxResolutionUid     (transcoding max resolution uid(Optional))
                             —mixedVideoLayoutType     (mixed video layout mode(Optional, 0 for float, 1 for BestFit, 2 for vertical, 0 by defualt))
                             —maxIdleTime     (max idle time(Optional, 30 by default))
                             —vendor     (cloud storage vendor(0 for Qiniu, 1 for AWS, 2 for Aliyun))
                             —region     (cloud storage region)
                             —bucket     (cloud storage bucket)
                             —accessKey     (cloud storage access key)
                             —secretKey     (cloud storage secret key)

开始云端录制

按照你的需要在命令行中输入以下参数的设置并执行，即可开始云端录制服务。

命令行示例：

$ ./cloud_recording_demo.bin --appId <你的app ID> --channelName <频道名> --uid <录制uid> --vendor 0 --region 0 --bucket <云空间名称> --accessKey <accesskey> --secretKey <secretKey> --channelType <0 通信模式，1 直播模式>

• uid 不可以设为 0。
• appId，uid，channelName ，vendor， region，bucket，accessKey 和 secretKey 这几个参数必须设置，若不设置则无法录制，其他参数可根据需要自行选择是否设置，若不设置则使用默认值。
• 如果声网 Native/Web SDK 使用了 Token，必须设置 token 参数。
• 当云端录制 SDK 加入频道时，相当于一个哑客户端加入频道，因此需要跟声网 Native/Web SDK 加入相同的频道，并使用相同的 App ID 和频道模式。

停止云端录制

当频道空闲（无用户）超过预设时间（默认为 30 秒）后，demo 会自动退出频道停止录制。

上传和管理录制文件

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

录制 ID

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

录制开始后，命令行返回的所有回调中都会包含录制 ID 和录制频道名，用下划线隔开，如下图所示：

录制文件索引

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

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

上传录制文件

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

• 录制过程中
  • OnRecordingUploadingProgress：录制开始后约每分钟触发一次，该回调中的 progress 参数表示已上传文件占已录制文件的百分比。
• 停止录制后，根据上传情况，会触发以下回调之一：
  • OnRecordingUploaded：如果录制文件全部成功上传至预先设定的云存储，最后一个录制切片文件上传完成时触发该回调，通知应用程序上传完成。
  • OnRecordingBackedUp：如果有录制文件未能成功上传至第三方云存储，声网服务器会将这部分文件自动上传至声网备份云，当录制结束后会触发该回调。

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

录制文件上传完成后，你可以在预先设定的第三方云存储空间查看，如下图所示：

查看日志文件

运行 demo 进行云端录制后，会在 $(pwd)/cloud_recording_log 文件夹中生成以录制 ID 命名的 .log 日志文件，该文件可以帮助查找问题原因。

状态信息反馈

在运行 demo 进行云端录制的过程中，命令行会出现如下信息提示当前运行状态。

正常状态

异常状态