ビデオの一時停止イベント
ピアが自分のビデオストリームを一時停止または再開するとイベントが発生します。
| 対応する通話タイプ | SDKの最低バージョン |
|---|---|
| 1対1通話、グループ通話（カンファレンス） | WebPlanetKit 3.1 |
1対1通話
1対1通話では、ピアのビデオが一時停止または再開されると、以下のようなイベントコールバックが呼び出されます。
| イベントコールバック | 説明 |
|---|---|
MakeCallDelegateのevtPeerVideoPausedVerifyCallDelegateのevtPeerVideoPaused | ピアのビデオが一時停止されたときに呼び出されます。 |
MakeCallDelegateのevtPeerVideoResumedVerifyCallDelegateのevtPeerVideoResumed | ピアのビデオが再開されたときに呼び出されます。 |
グループ通話
グループ通話では、1人以上のピアのビデオが一時停止または再開されると、以下のようなイベントコールバックが呼び出されます。
| イベントコールバック | 説明 |
|---|---|
evtPeersVideoPaused | 1人以上のピアのビデオが一時停止されたときに呼び出されます。 |
evtPeersVideoResumed | 1人以上のピアのビデオが再開されたときに呼び出されます。 |
ビデオを一時停止する理由
ユーザー指示やカメラ使用不可など、さまざまな理由でビデオストリームを停止することができます。
1対1通話も、グループ通話もビデオを一時停止する際にイベントコールバックを通じてビデオの一時停止の理由を渡します。VIDEO_PAUSE_REASONenumは、以下のようにビデオを一時停止する理由を定義します。
| Enum定数 | 説明 |
|---|---|
PLANETKIT_VIDEO_PAUSE_REASON_BY_USER | ピアがpauseMyVideo()を呼び出しました |
PLANETKIT_VIDEO_PAUSE_REASON_BY_INTERRUPT | アプリケーションがバックグラウンド状態に入りました |
PLANETKIT_VIDEO_PAUSE_REASON_ENABLE_VIDEO_RESPONSE | （1対1通話のみ可能）ピアがレスポンスタイプをPAUSEに設定し、ユーザーがビデオ通話を有効にすることをリクエストしました。詳しくは、音声通話中のビデオ通話の有効化を参照してください。 |
PLANETKIT_VIDEO_PAUSE_REASON_CAMERA_INACTIVE | カメラが使用できなくなりました |
インターフェースの変更
ビデオの一時停止イベントに関連するAPIで以下のような変更がありました。
| SDKバージョン | 1対1通話 | グループ通話 |
|---|---|---|
| WebPlanetKit 5.0以上 | evtPeerVideoPausedevtPeerVideoResumed | evtPeersVideoPausedevtPeersVideoResumed |
| WebPlanetKit 4.2以下 | evtPeerUpdated | evtPeerUpdated |
Note
WebPlanetKit 5.1までは、グループ通話においてユーザー自身のビデオの一時停止状態を他のユーザーと共有することを有効にするには、ConferenceParamsのshareVideoPauseプロパティ（デフォルトはfalse）をtrueに設定する必要があります。WebPlanetKit 5.2以上のバージョンからshareVideoPauseプロパティが削除されました。