グループ通話フロー
ここでは、LINE Planetのグループ通話（カンファレンス）のフローについて説明します。
下図では、アプリクライアントとアプリサーバーはアプリケーション側に属しており、PlanetKitとLINE Planet CloudはLINE Planet側に属しています。
グループ通話参加
グループ通話に参加するには、アプリクライアントがJoinConference()を呼び出す必要があります。ユーザーがグループ通話に参加すると、OnConnectedイベントが発生します。
グループ通話に参加するには、ルームIDが必要です。したがって、アプリクライアントはグループ通話に参加する前にアプリケーション通信チャンネルを通じてルームIDを共有する必要があります。
下図はグループ通話に参加する流れを示します。ここではClient 01がグループ音声通話に参加した後、Client Kが通話に参加します。
- Client 01が通話に参加しようとすると、Client 01のアプリクライアントが
JoinConference()を呼び出します。 - Planet CloudはGroup Call Eventコールバックを呼び出して、アプリサーバーに新しいグループ通話を通知します。
- Client 01のアプリクライアントで
OnConnectedイベントが発生します。 - Client Kが通話に参加しようとすると、Client Kのアプリクライアントが
JoinConference()を呼び出します。 - Planet CloudはGroup Call Eventコールバックを呼び出し、アプリサーバーにグループ通話のステータス変更を通知します。
- Client 01のアプリクライアントでは
OnPeerListUpdateイベントが発生し、Client KのアプリクライアントではOnConnected、OnPeerListUpdate、OnPeersVideoUpdatedイベントが発生します。
ここでは、3つの関連イベントを見ることができます。
| イベント | 発生条件 | 説明 |
|---|---|---|
OnConnected | JoinConference() API呼び出し後 | 完了コールバック |
OnPeerListUpdate | 誰かがルームに参加または退出した後 | 新しく参加または退出した参加者のリストを渡す |
OnPeersVideoUpdated | - ルームに参加した状態でビデオをオンまたはオフにした後 - ビデオをオンにした状態で参加したとき | ビデオをオンまたはオフにした参加者のリストを渡す |
ピアリストの更新イベント
OnPeerListUpdateは参加者が更新されるたびに発生します。そのため、Client Kが参加すると、Client 01とClient Kの両方ともこのイベントを受け取ります。このイベントは、新しく参加または退出した参加者のリストを渡します。
新しい参加者に対してOnPeerListUpdateが発生すると、他の参加者はその参加者に対してPeerControlインスタンスを作成し、そのPeerControlインスタンスを使用して、参加者のビデオを開始または中止したり、参加者のステータスの変更に基づいて参加者のUIを更新したりすることができます。
PeerControlの使い方について詳しくは、グループビデオ通話のサンプルコードを参照してください。
ピアビデオの更新イベント
OnPeersVideoUpdatedは、参加者のビデオストリームが変わるたびに発生します。
上記の例では、Client 01だけがビデオを送信します。Client KはOnPeersVideoUpdatedイベントによって、Client 01がビデオをオンにしたことを知ります。
OnPeersVideoUpdatedイベントは、音声通話中にビデオ通話をオンにした場合にも発生することがあります。詳しくは、音声通話中のビデオ通話の有効化を参照してください。
イベントの更新間隔
アプリクライアントは、更新間隔内の最新情報に基づきOnPeerListUpdateとOnPeersVideoUpdatedを受け取ります。その結果として、アプリクライアントは、誰かが参加直後に退出する場合など、更新間隔内で発生した急な変更に対するイベントを受信できない場合があります。
LINE Planet Cloudはこれらを内部で更新するスケジューラーを持ち、スケジューリング間隔は現在の参加者数が増えた分だけ長くなります。つまり、参加者数に比例して情報の更新が遅くなることにご注意ください。
ピアビデオのリクエスト
OnConnectedイベントが発生した後、アプリクライアントはオーディオストリームを自動で受け取ります。ただし、ビデオストリームは、アプリクライアントが適切なビデオ解像度を定めてPeerControl::StartVideo()を呼び出さない限り、LINE Planet Cloudから自動送信されません。
アプリケーションは、IConferenceEventのOnPeersVideoUpdatedコールバックやIPeerControlEventのOnVideoUpdatedコールバックを通じてビデオストリームを有効にしたのは誰なのかを知ることができます。
PlanetKitがビデオストリーム数に応じて推奨解像度を使用するようにStartVideo()を呼び出すときに解像度の引数としてPLNK_VIDEO_RESOLUTION_RECOMMENDEDを使用することをお勧めします。詳しくは、グループ通話のピアビデオ解像度を参照してください。
OSのUIフレームワークによって、ピアビデオストリームをレンダリングするために追加のAPIを呼び出す必要がある場合があります。APIリファレンスを確認してください。
グループ通話退出
グループ通話から退出するには、アプリクライアントがLeaveConference()を呼び出す必要があります。グループ通話から退出したユーザーのアプリクライアントでは、OnDisconnectedイベントが発生します。参加者リストが変更されたため、ピアのアプリクライアントではOnPeerListUpdateイベントが発生します。
ビデオがオンになっている参加者
ビデオがオンになっている参加者がルームから退出すると、他の参加者はOnPeersVideoUpdatedイベントを受け取ります。
- Client 01が通話から退出しようとすると、Client 01のアプリクライアントが
LeaveConference()を呼び出します。 - Client Kのアプリクライアントでは
OnPeersVideoUpdatedイベントとOnPeerListUpdateイベントが発生し、Client 01のアプリクライアントではOnDisconnectedイベントが発生します。 - Planet CloudはGroup Call Eventコールバックを呼び出し、アプリサーバーにグループ通話のステータス変更を通知します。
- 画面共有ビデオを送信していた参加者がルームから退出すると、状態が
DISABLEDであるOnPeerScreenShareUpdatedが他の参加者に送信されます。 - 状態が
DISABLEDであるOnPeersVideoUpdatedまたはOnPeerScreenShareUpdatedイベントは、PlanetKit 4.4以上を使用している参加者だけに送信されます。
ビデオがオフになっている参加者
ビデオがオフになっている参加者がルームから退出する場合、OnPeersVideoUpdatedは発生しません。
- Client Kが通話から退出しようとすると、Client Kのアプリクライアントが
LeaveConference()を呼び出します。 - Client 01のアプリクライアントでは
OnPeerListUpdateイベントが発生し、Client KのアプリクライアントではOnDisconnectedイベントが発生します。 - Planet CloudはGroup Call Eventコールバックを呼び出し、アプリサーバーにグループ通話のステータス変更を通知します。
関連API
グループ通話に関連するAPIは次のとおりです。