Version: 5.4

ビデオの初期状態の設定

ビデオ通話を開始したり、音声通話からビデオ通話に切り替えたりする時に適用されるローカルユーザーのビデオの初期状態を設定できます。

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

概要

通話開始APIとビデオ通話切り替えAPIの引数として、ブーリアン型のcameraOnを追加してビデオの初期状態を設定できます。cameraOnの値によって、ビデオの初期状態は次のように設定されます。

Note

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

MakeCallParamsやVerifyCallParams、またはConferenceParamsにcameraOnを追加し、ビデオの初期状態を設定できます。

1対1通話

// Caller side
const makeCallParams = {
    ...,
    cameraOn: false
};

planetKit.makeCall(makeCallParams);

// Callee side
const verifyCallParams = {
    ...,
    cameraOn: false
};

planetKit.verifyCall(verifyCallParams);

グループ通話

const conferenceParams = {
    ...,
    cameraOn: false
};

planetKit.joinConference(conferenceParams);

1対1通話またはグループ通話でビデオ通話を有効にする際にenableVideo()のEnableVideoOptionsにcameraOnを追加し、ビデオの初期状態を設定することができます。詳しくは、音声通話中のビデオ通話の有効化を参照してください。