ビデオの一時停止イベント

ピアが自分のビデオストリームを一時停止または再開するとイベントが発生します。

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

1対1通話

1対1通話では、ピアのビデオが一時停止または再開されると、以下のようなイベントコールバックが呼び出されます。

イベントコールバック	説明
onPeerVideoPaused	ピアのビデオが一時停止されたときに呼び出されます。
onPeerVideoResumed	ピアのビデオが再開されたときに呼び出されます。

グループ通話

グループ通話では、1人以上のピアのビデオが一時停止または再開されると、以下のようなイベントコールバックが呼び出されます。

イベントコールバック	説明
onPeersVideoUpdated	1人以上のピアのビデオが一時停止または再開されたときに呼び出されます。 - ピアのビデオが一時停止された場合、ピアのVideoStateはPAUSEDです。 - ピアのビデオが再開された場合、ピアのVideoStateはENABLEDです。

ビデオを一時停止する理由

ユーザー指示やカメラ使用不可など、さまざまな理由でビデオストリームを停止することができます。

1対1通話も、グループ通話もビデオを一時停止する際にイベントコールバックを通じてビデオの一時停止の理由を渡します。PlanetKitVideoPauseReasonenumは、以下のようにビデオを一時停止する理由を定義します。

Enum定数	説明
BY_USER	ピアがpauseMyVideo()を呼び出しました
BY_INTERRUPT	アプリケーションがバックグラウンド状態に入りました
ENABLE_VIDEO_RESPONSE	（1対1通話のみ可能）ピアがビデオ通話を有効にした後、ユーザーのビデオは一時停止されます。詳しくは、音声通話中のビデオ通話の有効化を参照してください。
CAMERA_INACTIVE	カメラが使用できなくなりました
HOLD	ピアがhold()を呼び出しました。詳しくは、通話の一時停止を参照してください。

インターフェースの変更

ビデオの一時停止イベントに関連するAPIで以下のような変更がありました。

SDKバージョン	1対1通話	グループ通話
PlanetKit 4.4以上	onPeerVideoPaused onPeerVideoResumed	onPeersVideoUpdated
PlanetKit 4.3	evtPeerVideoPaused evtPeerVideoResumed	evtPeerVideoPaused evtPeerVideoResumed
PlanetKit 4.2以上	evtPeerUpdated	evtPeerUpdated

Note

PlanetKit 4.3までは、グループ通話においてユーザー自身のビデオの一時停止状態を他のユーザーと共有することを無効にするには、グループ通話パラメーターのshareVideoPauseプロパティ（デフォルトはtrue）をfalseに設定する必要があります。PlanetKit 4.4以上のバージョンからshareVideoPauseプロパティが削除されました。

関連ドキュメント

• 音声通話中のビデオ通話の有効化
• 通話の一時停止