本文にスキップする
Version: 1.0

ビデオの初期状態の設定

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

対応する通話タイプSDKの最低バージョン
1対1通話、グループ通話(カンファレンス)1.0

概要

PlanetKitInitialMyVideoState列挙型に次のようなビデオの初期状態の値が定義されています。

  • resume:カメラがオンになり、カメラでキャプチャーしたビデオが転送されます。
  • pause:カメラがオフのままで、ビデオは転送されません。
Note
  • 以下の説明で、APIのデフォルト値は、resumeです。
  • ビデオの初期状態をpauseに設定すると、ローカルユーザーのビデオは転送されません。ローカルユーザーのビデオをキャプチャーして転送するには、後からresumeMyVideo()を呼び出す必要があります。

ビデオ通話開始時の初期状態設定

通話タイプによってビデオの状態を設定するために使用されるAPIは次のとおりです。

1対1通話

  • 発信者側:通話を作成する際にPlanetKitMakeCallParamBuildersetInitialMyVideoState()でビデオの初期状態を設定します。
  • 受信者側:通話に応答する際にacceptCall()initialMyVideoStateパラメーターでビデオの初期状態を設定します。

1対1通話でビデオの初期状態を設定するサンプルコードは、1対1ビデオ通話を参照してください。

グループ通話

グループ通話に参加する際にPlanetKitJoinConferenceParamBuildersetInitialMyVideoState()でビデオの初期状態を設定します。

グループ通話でビデオの初期状態を設定するサンプルコードは、グループビデオ通話を参照してください。

ビデオ通話切り替え時の初期状態設定

1対1通話やグループ通話でビデオ通話を有効化する際にenableVideo()initialMyVideoStateパラメーターでビデオの初期状態を設定します。

詳しくは、音声通話中のビデオ通話の有効化を参照してください。

関連API

ビデオの初期状態の設定に関連するAPIは、次のとおりです。

1対1通話

グループ通話

関連ドキュメント

関連サンプルコード