音声の初期状態
1対1通話を開始したり、グループ通話に参加したりする時に適用されるローカルユーザーの音声の初期状態を設定できます。
| 対応する通話タイプ | SDKの最低バージョン |
|---|---|
| 1対1通話、グループ通話(カンファレンス) | WebPlanetKit 5.2 |
概要
通話開始APIの引数として、ブーリアン型のmicOnを追加して音声の初期状態を設定できます。micOnの値によって、音声の初期状態は次のように設定されます。
true(デフォルト値):通話開始時にマイクが有効化されてオンになり、マイクでキャプチャーした音声がピアに転送されます。false:通話開始時にマイクが有効化されず、オフのまま維持され、音声はピアに転送されません。
Note
micOnをfalseに設定した後、再び音声を転送するにはmuteMyAudio(false)を呼び出す必要があります。- WebPlanetKit 6.0以降では、
micOnをfalseに設定すると、通話開始時にマイクへアクセスしません。そのため、ユーザーが初めてミュートを解除するまで、ブラウザーのマイク権限リクエストは表示されず、通話開始時のブラウザーのマイクインジケーターも表示されません。- WebPlanetKit 6.0以前のバージョンでは、
micOnがfalseであってもマイクにアクセスします。
- WebPlanetKit 6.0以前のバージョンでは、
- WebPlanetKit 5.2以前のバージョンでは、
micOn機能をaudioEnabledという名前で提供しています。
通話開始時の音声の初期状態設定
MakeCallParamsやVerifyCallParams、またはConferenceParamsにmicOnを追加し、音声の初期状態を設定できます。
-
1対1通話
// Caller side
const makeCallParams = {
...,
micOn: false
};
planetKit.makeCall(makeCallParams);// Callee side
const verifyCallParams = {
...,
micOn: false
};
planetKit.verifyCall(verifyCallParams); -
グループ通話
const conferenceParams = {
...,
micOn: false
};
planetKit.joinConference(conferenceParams);
関連API
オーディオの初期状態の設定に関連するAPIは、次のとおりです。