ビデオの初期状態の設定
ビデオ通話を開始したり、音声通話からビデオ通話に切り替えたりする時に適用されるローカルユーザーのビデオの初期状態を設定できます。
| 対応する通話タイプ | SDKの最低バージョン |
|---|---|
| 1対1通話、グループ通話（カンファレンス） | PlanetKit 5.5 |
概要
PlanetKitInitialMyVideoState列挙型に次のようなビデオの初期状態の値が定義されています。
resume：カメラがオンになり、カメラでキャプチャーしたビデオが転送されます。pause：カメラがオフのままで、ビデオは転送されません。
Note
- 以下で説明するAPIのデフォルト値は、
resumeです。 - ビデオの初期状態を
pauseに設定すると、ローカルユーザーのビデオは転送されません。ローカルユーザーのビデオをキャプチャして転送するには、後でresumeMyVideo()を呼び出す必要があります。
ビデオ通話開始時のビデオの初期状態設定
通話タイプに応じてビデオの初期状態を設定するために使用されるAPIは、次のとおりです。
1対1通話
- 発信者側：通話を作成する際に
PlanetKitCallParamのinitialMyVideoState属性でビデオの初期状態を設定します。 - 受信者側：通話に応答する際に
acceptCall()のinitialMyVideoStateパラメーターでビデオの初期状態を設定します。
1対1通話でビデオの初期状態を設定するサンプルコードは、1対1ビデオ通話を参照してください。
グループ通話
グループ通話に参加する際にPlanetKitConferenceParamのinitialMyVideoState属性でビデオの初期状態を設定します。
グループ通話でビデオの初期状態を設定するサンプルコードは、グループビデオ通話を参照してください。
ビデオ通話切り替え時のビデオの初期状態設定
1対1通話またはグループ通話でビデオ通話を有効にする際にenableVideo()のinitialMyVideoStateパラメーターでビデオの初期状態を設定します。
詳しくは、音声通話中のビデオ通話の有効化を参照してください。
関連API
ビデオの初期状態の設定に関連するAPIは、次のとおりです。