通話の一時停止
PlanetKitは、通話の一時停止(hold)/再開(unhold)機能を提供します。この機能を使用すると、アプリケーションがメディアストリームの送信と受信を一時停止または再開します。ユーザーが通話を一時停止/再開すると、ピアはユーザーのビデオが一時停止/再開されたことを知らせるイベントを受信します。
通話の一時停止および再開の動作は、通話タイプによって異なります。ここでは、通話を一時停止または再開する方法について説明します。
対応する通話タイプ | SDKの最低バージョン |
---|---|
1対1通話、グループ通話(カンファレンス) | 0.7 |
1対1通話
1対1通話を一時停止または再開するには、PlanetKitCall
のhold()
またはunhold()
を使用します。
hold()
を呼び出してアプリケーションのメディアストリームの送受信を一時停止した後、ピアは通信を再開するためにunhold()
が呼び出されるまで待つ必要があります。ピア側のアプリケーションは、PlanetKitが通話パラメーターに設定された一時停止音(hold tone)を再生させます。
下図は、1対1通話の一時停止と再開の流れを示します。
関連API
1対1通話で通話の一時停止および再開に関連するAPIは次のとおりです。
メソッド | 説明 | 関連イベントコールバック |
---|---|---|
hold() | 一時停止ステータスを開始します。一時停止の理由を提供できます。 | onPeerHold |
unhold() | 一時停止ステータスを終了します。 | onPeerUnhold |
グループ通話
グループ通話を一時停止または再開するには、PlanetKitConference
のhold()
またはunhold()
を使用します。
グループ通話では、一時停止の動作が1対1通話と異なります。主に以下のような違いがあります。
- 一時停止音という概念が存在しません。
- 1対1通話では、発信者(ピア)側でメディアの送受信が一時停止になりますが、グループ通話では、ピアのメディア送受信がPlanet Cloudによって停止されます。
下図は、グループ通話の一時停止および再開の流れを示します。
関連API
グループ通話で通話の一時停止および再開に関連するAPIは次のとおりです。
メソッド | 説明 | 関連イベントコールバック |
---|---|---|
hold() | 一時停止ステータスを開始します。一時停止の理由を提供できます。 | onPeersHold |
unhold() | 一時停止ステータスを終了します。 | onPeersUnhold |