音声通話中のビデオ通話の有効化

音声通話中にビデオ通話に切り替えたり、ビデオ通話中にもう一度音声通話に切り替えたりすることができます。これを、ビデオ通話を有効または無効にすると表現します。

ビデオ通話の有効化をリクエストする手順と、ピアがリクエストに応答する方法は、通話タイプによって異なります。ここでは、通話タイプによってビデオ通話を有効または無効にする方法について説明します。

対応する通話タイプ	SDKの最低バージョン
1対1通話、グループ通話（カンファレンス）	WebPlanetKit 3.1

1対1通話

1対1通話でビデオ通話を有効または無効にするには、Callの次のメソッドを使用します。

メソッド	説明	関連イベントコールバック
enableVideo()	ビデオ通話を有効にすることをリクエストします。	evtVideoEnabledByPeer
disableVideo()	ビデオ通話を無効にすることをリクエストします。	evtVideoDisabledByPeer

リクエスト側のビデオの初期状態

enableVideo()のEnableVideoOptionsにブーリアン型のcameraOnを追加して、リクエスト側の初期ビデオ状態を設定できます。cameraOnの値によって、ビデオの初期状態は次のように設定されます。

• cameraOnがtrueの場合、カメラがオンになり、カメラでキャプチャーしたビデオが転送されます。
• cameraOnがfalseの場合、カメラがオフのままで、ビデオは転送されません。

Note

• 通話開始APIとビデオ通話転換APIのcameraOnのデフォルト値は、trueです。
• cameraOnをfalseに設定すると、ローカルユーザーのビデオが転送されません。以降、ローカルユーザーのビデオをキャプチャーして転送するには、CallのresumeMyVideo()を呼び出す必要があります。
• WebPlanetKit 5.2以下のバージョンでは、cameraOn機能をvideoEnabledという名前で提供しています。

ユーザーのレスポンスタイプ

1対1通話で相手がビデオ通話をリクエストしたとき、ユーザーのレスポンスタイプは、通話設定のプロセスで設定できます。

レスポンスタイプはRESPONSE_ENABLE_VIDEOにて、以下のように定義されています。

• PAUSE：相手がビデオ通話を有効にすることをリクエストした際にユーザーのビデオを一時停止します。
• SEND：相手がビデオ通話を有効にすることをリクエストした際にユーザーのビデオを送信します。

次のようにレスポンスタイプを設定できます。

• 発信側では、MakeCallParamsのresponseOnEnableVideoでレスポンスタイプを設定します。
• 受信側では、VerifyCallParamsのresponseOnEnableVideoでレスポンスタイプを設定します。

ビデオ通話を有効にする

ビデオ通話のリクエスト側がenableVideo()を呼び出すと、受信者には2つのシナリオがあります。シナリオはレスポンスタイプの値によって選択されます。

• シナリオ1：ビデオストリーミングを送信しながら手動で応答する
  • 受信者のレスポンスタイプがPAUSEの場合です。
  • このシナリオでは、ビデオを一時停止した状態でビデオ通話を開始します。 ビデオ通話のリクエストを受けたユーザー（Client 02）が自分のビデオストリームを送信するタイミングを選択できます。

    

  • 関連イベントであるevtPeerVideoPausedとevtPeerVideoResumedについて詳しくは、ビデオの一時停止イベントを参照してください。
• シナリオ2：ビデオストリーミングを送信しながら自動で応答する
  • 受信者のレスポンスタイプがSENDの場合です。
  • このシナリオでは、ビデオ通話のリクエストを受けたユーザー（Client 02）がリクエストを受けたときに自分のビデオストリームを送信します。

    

Tip

あらかじめ受信者のシナリオを定めてから設定することを推奨します。つまり、レスポンスタイプフィールドの値をPAUSEまたはSENDなどの定数に設定して使用してください。

ビデオ通話を無効にする

ビデオ通話の途中でビデオストリーミングを中止したい場合は、disableVideo()を呼び出します。

Note

ネイティブPlanetKitとは異なり、WebPlanetKitは1対1通話でdisableVideo()を呼び出す際にdisableReasonを伝える機能をサポートしていません。

リジェクトの流れの例

enableVideo()リクエストの受信者がビデオ通話に参加したくなければ、リクエストをリジェクトできます。ここでレスポンスタイプはPAUSEであると仮定します。このとき、通話の手順は以下のようになるべきです。

カメラの初期化に失敗した場合

クライアントがevtVideoEnabledByPeerイベントを受信した後カメラの初期化（open）に失敗した場合、クライアントはカメラの初期化を再試行し、初期化に成功した上でresumeMyVideo()を呼び出す必要があります。

グループ通話

グループ通話でビデオ通話を有効または無効にするには、Conferenceの次のメソッドを使用します。

メソッド	説明	関連イベントコールバック
enableVideo()	ビデオ通話を有効にすることをリクエストします。	evtPeersVideoUpdated (state=ENABLED)
disableVideo()	ビデオ通話を無効にすることをリクエストします。	evtPeersVideoUpdated (state=DISABLED)

evtPeersVideoUpdatedではENABLED、DISABLED、PAUSEDの3つのステータスを渡します。

ステータスがPAUSEDの場合、pauseReasonを参照して必要な作業を行う必要があります。詳しくは、ビデオの一時停止イベントを参照してください。

リクエスト側のビデオの初期状態

enableVideo()のEnableVideoOptionsにブーリアン型のcameraOnを追加して、リクエスト側の初期ビデオ状態を設定できます。cameraOnの値によって、ビデオの初期状態は次のように設定されます。

• cameraOnがtrueの場合、カメラがオンになり、カメラでキャプチャーしたビデオが転送されます。
• cameraOnがfalseの場合、カメラがオフのままで、ビデオは転送されません。

Note

• 通話開始APIとビデオ通話転換APIのcameraOnのデフォルト値は、trueです。
• cameraOnをfalseに設定すると、ローカルユーザーのビデオが転送されません。以降、ローカルユーザーのビデオをキャプチャーして転送するには、CallのresumeMyVideo()を呼び出す必要があります。
• WebPlanetKit 5.2以下のバージョンでは、cameraOn機能をvideoEnabledという名前で提供しています。

ビデオ通話を有効にする

ビデオ通話をリクエストした側がenableVideo()を呼び出すと、他の参加者はそれぞれrequestPeerVideo()を呼び出し、そのストリームを受け取るかどうかを決定する必要があります。

ビデオ通話を無効にする

グループビデオ通話の途中でビデオストリームを中止するには、disableVideo()を呼び出します。

インターフェースの変更

グループ通話でのビデオ通話の有効化に関するイベントのインターフェースが以下のように変更されました。

SDK version	Group call
WebPlanetKit 5.0以上	evtPeersVideoUpdated
WebPlanetKit 4.0～4.2	evtConfVideoUpdated

関連API

ビデオ通話の有効化と無効化に関連するAPIは次のとおりです。

共通

• EnableVideoOptions

1対1通話

Enum

• RESPONSE_ENABLE_VIDEO

メソッド

• MakeCallParamsのresponseOnEnableVideo
• VerifyCallParamsのresponseOnEnableVideo
• CallのenableVideo()
• CallのdisableVideo()
• CallのresumeMyVideo()

イベント

• evtVideoEnabledByPeer
• evtVideoDisabledByPeer

グループ通話

メソッド

• ConferenceのenableVideo()
• ConferenceのdisableVideo()
• ConferenceのresumeMyVideo()

イベント

• evtPeersVideoUpdated

関連ドキュメント

• ビデオの初期状態の設定
• ビデオの一時停止イベント