API 概览

你可以通过你的业务服务器向 Agora 服务器发送 HTTP 请求，在服务端进行云端录制。本文提供云端录制 RESTful API 的概览信息。

概述

在阅读本文前，你可以参考以下文档，了解云端录制支持的几大功能，以及各功能涉及的重点步骤。

• 单流录制：分开录制每个 UID 的音频和视频。录制服务会实时将 M3U8 和 TS/WebM 文件上传至第三方云存储。如果开启延时转码，录制服务会在录制结束后 24 小时内对录制文件进行转码生成 MP4 文件，并将 MP4 文件上传至你指定的第三方云存储，频道内每个 UID 均会生成一个 MP4 文件。
• 合流录制：将频道内所有 UID 的音视频混合录制为一个音视频文件，并将录制文件上传至第三方云存储。
• 视频截图：单流录制模式下，对频道内的视频流进行截图，并将图片文件上传至第三方云存储。
• 页面录制：将指定网页的页面内容和音频混合录制为一个音视频文件，并将录制文件上传至第三方云存储。

前提条件

• 页面录制 RESTful API 仅支持 HTTPS 协议。请确保已完成 HTTP 基本认证。
• 请确保已开通云端录制服务。

数据格式

所有的请求都发送给域名：api.agora.io。

• 请求：请求的格式详见各个 API 中的示例。
• 响应：响应内容的格式为 JSON。

所有的请求 URL 和请求包体内容都是区分大小写的。

调用步骤

一般进行云端录制的步骤如下：

1. 通过 acquire 请求获取一个 resource ID 用于开启云端录制。
2. 获取 resource ID 后在 5 分钟内调用 start 开始云端录制。
3. 录制完成后调用 stop 停止录制。

在整个过程中可以通过 query 请求查询云端录制的状态。