Version: 1.0

グループ通話フロー

ここでは、LINE Planetのグループ通話（カンファレンス）のフローについて説明します。

下図では、アプリクライアントとアプリサーバーはアプリケーション側に属しており、PlanetKitとLINE Planet CloudはLINE Planet側に属しています。

グループ通話参加

グループ通話に参加するには、アプリクライアントがjoinConference()を呼び出す必要があります。ユーザーがグループ通話に参加すると、onConnectedイベントが発生します。

Note

グループ通話に参加するには、ルーム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のアプリクライアントではonPeerListUpdatedイベントが発生し、Client KのアプリクライアントではonConnected、onPeerListUpdated、onVideoUpdateイベントが発生します。

ここでは、3つの関連イベントを見ることができます。

イベント	発生条件	説明
`onConnected`	`joinConference()` APIが呼び出され、通話が接続された後	通話が接続されたことを通知
`onPeerListUpdated`	誰かがルームに参加または退出した後	新しく参加または退出した参加者のリストを渡す
`PlanetKitPeerControlHandler`の`onVideoUpdate`	ピアがビデオをオンまたはオフにした後	ピアのビデオ状態を渡す

ピアリストの更新イベント

onPeerListUpdatedイベントは、参加者リストが更新されるたびに、つまり誰かがルームに参加または退出した後に発生します。そのため、Client Kが参加すると、Client 01とClient Kの両方ともこのイベントを受け取ります。このイベントは、新しく参加または退出した参加者のリストを渡します。

新しい参加者に対してonPeerListUpdatedイベントが発生すると、他の参加者はその参加者に対してPlanetKitPeerControlインスタンスを作成し、そのPlanetKitPeerControlインスタンスを使用して参加者のステータス変更に基づいて参加者のUIを更新するなどの作業を行うことができます。

ピアビデオの更新イベント

onVideoUpdateは、参加者のビデオストリームが変わるたびに発生します。

上記の例では、Client 01だけがビデオを送信します。Client KはonVideoUpdateイベントによって、Client 01がビデオをオンにしたことを知ります。

Tip

onVideoUpdateイベントは、音声通話中にビデオ通話をオンにした場合にも発生することがあります。詳しくは、音声通話中のビデオ通話の有効化を参照してください。

イベントの更新間隔

アプリクライアントは、更新間隔内の最新情報に基づきonPeerListUpdatedとonVideoUpdateイベントを受け取ります。その結果として、アプリクライアントは、誰かが参加直後に退出する場合など、更新間隔内で発生した急な変更に対するイベントを受信できない場合があります。

LINE Planet Cloudはこれらを内部で更新するスケジューラーを持ち、スケジューリング間隔は現在の参加者数が増えた分だけ長くなります。つまり、参加者数に比例して情報の更新が遅くなることにご注意ください。

ピアビデオのリクエスト

onConnectedイベントが発生した後、アプリクライアントはオーディオストリームを自動で受け取ります。ただし、ビデオストリームは、アプリクライアントが適切なビデオ解像度を定めてPlanetKitPeerControlのstartVideo()を呼び出さない限り、LINE Planet Cloudから自動送信されません。

アプリケーションは、PlanetKitPeerControlHandlerのonVideoUpdateコールバックを通じてビデオストリームを有効にしたのは誰なのかを知ることができます。

PlanetKitがビデオストリーム数に応じて推奨の解像度を使用するstartVideo()を呼び出す際に、解像度の引数としてrecommendedを使用することをお勧めします。詳しくは、グループ通話のピアビデオ解像度を参照してください。

Tip

OSのUIフレームワークによっては、ピアのビデオストリームをレンダリングするためにAPIを追加で呼び出す場合もあります。APIリファレンスを確認してください。

グループ通話退出

グループ通話から退出するには、アプリクライアントがleaveConference()を呼び出す必要があります。グループ通話から退出したユーザーのアプリクライアントでは、onDisconnectedイベントが発生します。参加者リストが変更されたため、ピアのアプリクライアントではonPeerListUpdatedイベントが発生します。

ビデオがオンになっている参加者

ビデオがオンになっている参加者がルームから退出すると、他の参加者はonVideoUpdateイベントを受け取ります。

Client Kが通話から退出しようとすると、Client KのアプリクライアントがleaveConference()を呼び出します。
Client KのアプリクライアントではonVideoUpdateイベントとonPeerListUpdatedイベントが発生し、Client 01のアプリクライアントではonDisconnectedイベントが発生します。
Planet CloudはGroup Call Eventコールバックを呼び出し、アプリサーバーにグループ通話のステータス変更を通知します。

Note

画面共有ビデオを送信していた参加者がルームから退出すると、状態がdisabledであるPlanetKitPeerControlHandlerのonScreenShareUpdateが他の参加者に送信されます。

ビデオがオフになっている参加者

ビデオがオフになっている参加者がルームから退出する場合、onVideoUpdateは発生しません。

Client Kが通話から退出しようとすると、Client KのアプリクライアントがleaveConference()を呼び出します。
Client 01のアプリクライアントではonPeerListUpdatedイベントが発生し、Client KのアプリクライアントではonDisconnectedイベントが発生します。
Planet CloudはGroup Call Eventコールバックを呼び出し、アプリサーバーにグループ通話のステータス変更を通知します。

グループ通話フロー