Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

ステージ管理

最終更新 Markdown で表示Agent セットアップ

このガイドでは、Cloudflare RealtimeKit のウェビナー(WebRTC)向けに、ステージ管理 API の使い方を説明します。

従来の publish-subscribe モデルでは、ユーザーがメディアを公開し、ほかのユーザーが購読するかを選べます。RealtimeKit では、任意で管理された構成も使えます。この構成では、権限の低いユーザーはデフォルトでメディアを公開しません。そのユーザーは公開の許可をリクエストでき、権限のあるユーザーが許可または拒否を選べます。

RealtimeKit のステージ管理 API では、次のような操作ができます。

  • ステージからの退出と参加
  • ステージリクエストと権限の管理
  • 参加者の退出

Stage API にアクセスする

ステージモジュールは meeting.stage 名前空間から使えます。

プロパティ

ステータス

meeting.stage.status プロパティは、ローカルユーザーの現在のステージステータスを返します。

取りうるステータス:

  • ON_STAGE — ユーザーは現在ステージ上にあり、音声と映像を共有しています。
  • OFF_STAGE — ユーザーはセッションを視聴していますが、ステージ上にはおらず、音声も映像も共有していません。
  • REQUESTED_TO_JOIN_STAGE — ユーザーはステージ参加と音声・映像共有のリクエストを待機中です。このステータスは、ホストがリクエストを承認または拒否するまで続きます。
  • ACCEPTED_TO_JOIN_STAGE — ホストが、ユーザーのステージ参加リクエストを承認しました。

ホスト向けの操作

RealtimeKit のステージ管理 API では、ホストがステージリクエストを受け取り、管理できます。ステージへの参加と退出もできます。

ステージに参加する

このメソッドは、ユーザーをメディアルームへ接続し、ミーティング内のほかのピアとやり取りできるようにします。

ステージから退出する

このメソッドを使うと、ユーザーはメディアルームから切断され、ピアと通信できなくなります。音声と映像も、ルーム内のほかの参加者には見えなくなります。

アクセスを許可する

権限のあるユーザーは、grantAccess メソッドで一連のユーザーにステージアクセスを許可できます。

パラメーター:

アクセスを拒否する

権限のあるユーザーは、denyAccess メソッドで一連のユーザーのステージアクセスを拒否できます。

パラメーター:

ユーザーを退出させる

権限のあるユーザーは、kick メソッドで一連のユーザーをステージから削除できます。

パラメーター:

参加者向けの操作

RealtimeKit のステージ管理 API では、参加者がステージアクセスをリクエストし、管理できます。

アクセスをリクエストする

このメソッドは、ホストが承認できる新しいステージリクエストを作ります。ステージに参加するには、各ユーザー(視聴者またはホスト)がこのメソッドを呼び出す必要があります。

ホストがこのメソッドを呼び出すと、ステータスは ACCEPTED_TO_JOIN_STAGE に更新されます。

アクセスリクエストを取り消す

ステージリクエストを取り消すときは、このメソッドを呼び出します。

イベント

meeting.stage モジュールは、次のイベントを発行します。

ステージアクセスリクエストの更新

ステージアクセスリクエストに更新があったときに発行されます。

ステージアクセスリクエストの承認

ホストがステージ参加リクエストを承認したとき、またはユーザーをステージへ直接招待したときに発行されます。

ステージステータスの更新

ローカルユーザーのステージステータスが変わったときに発行されます。

新しいステージリクエスト

新しい参加者がステージ参加をリクエストしたときに発行されます。

ステージリクエストの承認

ホストがステージリクエストを承認したときに発行されます。

ステージリクエストの拒否

ホストがステージリクエストを拒否したときに発行されます。

役に立ちましたか?