製品概要についての公式ドキュメントはこちら
概要
Cloud Recording は、VideoやVoiceSDKなどを使って作成されたサービス(ボイスチャット、会議、セミナーなど)の映像と音声を録画(録音)することができます。
録画の実行にはRESTful APIをコールします。
また、録画したファイルはお客様が指定するクラウドストレージ(※1)上に保存することができます。
(※1 指定可能なクラウドストレージについては以下の公式ページ中の「Prerequisites」をご参照ください。)
https://docs.agora.io/en/cloud-recording/get-started/getstarted#prerequisites
また、録画(録音)ファイルはお客様の設定された上記で指定したストレージのみに保存される仕組みになっており、データのバックアップをAgoraが保持することはありません。
録画モード
録画方式には、大別して以下の3種類があります。
- Individual(個別)モード
- Composite(複合)モード
- Web Page Recording
それぞれ、各ユーザ(uid)の映像/音声を個別に保存するモード、各ユーザ(uid)の映像/音声を結合して保存するモード、Webページを丸ごと保存するモードとなっています。
詳細については以下のFAQを参照ください。
RESTful API
RESTful APIには以下のメソッドが用意されています。
- acquire：resourceIdの取得
- start：録画開始
- stop：録画停止
- update：録画更新
- updateLayout：ビデオミキシングレイアウト更新
- query：状態確認
API reference はこちら
大まかな流れとしては、まず acquire API で resourceId を取得します。
これは録画を行うためのリソースを確保するために使用するユニークな文字列であり、これを使用してその後の start API や stop API などの実行を行います。
また、状態確認を行う query API では、録画の進捗状況やステータスを確認することが可能です。
詳細については以下のFAQを参照ください。
Cloud Recording の録画状態を監視する方法はありますか
RESTful APIリクエストの上限数は、10リクエスト/秒(デフォルト設定)です。
ただし必要であれば、上限を上げることができます。
ご希望の場合、Zendeskから上限緩和申請が可能ですので、以下の記事を参照ください。
Cloud Recording RESTfulAPIリクエスト数の上限を上げることはできますか？