云端录制 Beta
  • 平台类型
  • 框架 / 引擎
  • iOS
  • Android
  • macOS
  • Windows
  • Linux
  • Web
  • 小程序

API 集成指引

更新时间:2020-11-13 11:05

1 接入流程

ZEGO 云端录制支持 RESTful API,无需集成 SDK,直接通过 http 网络请求即可轻松开始云端录制。

2 开通云端录制服务

开通云端录制服务前,请确保您已完成以下准备工作:

  • 拥有一个已接入 ZEGO 实时音视频 SDK 的应用。
  • 开通第三方云存储服务,目前支持 Amazon S3、阿里云 OSS、腾讯云 COS。

完成以上准备工作后,请联系 ZEGO 技术支持开通云端录制服务。

3 实现云端录制

以下为实现云端录制需要调用的 API 时序图:

3.1 获取 AccessToken

在开始录制之前,需要调用 access_token 方法获取鉴权凭证。在以下的请求中,都需要填入 access_token 字段。

3.2 开始录制

调用 start 方法并设置房间号即可进入该房间进行录制,请求成功会返回对应的录制 task_id,该 id 是整个录制周期的唯一标识,将作为调用后续方法的请求参数。

3.3 查询录制状态

录制过程中可以多次调用 query 方法查询录制状态,在返回的响应中可以获取到录制状态及文件上传地址等信息。

3.4 更新混流布局

混流录制过程中可以多次调用 update_layout 方法更新混流布局,详情请参考 设置混流布局

3.5 更新白板

白板录制过程中可以多次调用 update_whiteboard 方法更新白板 id,详情请参考 白板录制

3.6 停止录制

调用 stop 方法停止录制。

4 管理录制文件

4.1 上传录制文件

录制任务停止后,录制文件会上传至预先指定的第三方云存储。调用 query 方法,通过返回的参数可以及时查看上传进度。

  • file_url:返回录制文件的上传地址。
  • status:返回录制文件的上传状态。

录制文件上传结束后,云端录制会回调通知到开通服务时指定的回调地址。

4.2 管理录制文件名

录制文件名包含 streamID 和开始录制时间戳等信息,详情请参考 start 方法的 output_file_rule 参数。