オーディオの初期状態
1対1通話を開始したり、グループ通話に参加したりする時に適用されるローカルユーザーのオーディオの初期状態を設定できます。
| 対応する通話タイプ | SDKの最低バージョン |
|---|---|
| 1対1通話、グループ通話(カンファレンス) | PlanetKit 7.1 |
概要
PlanetKitInitialMyAudioState列挙型に次のようなオーディオの初期状態の値が定義されています。
unmuted:マイクがオンになり、マイクでキャプチャーした音声が転送されます。muted:マイクはオンにならず、音声は転送されません。
Note
- 以下で説明するAPIのデフォルト値は、
unmutedです。 - オーディオの初期状態を
mutedに設定すると、通話開始時にローカルユーザーのマイクはオンにならず、音声は相手に転送されません。音声を転送するには、後でmuteMyAudio()をfalseで呼び出す必要があります。 mutedで開始すると、ミュート解除されるまでマイクデバイスがオンにならないため、通話開始時にマイクインジケーターが表示されません。
Note
CallKitが統合されている場合(PlanetKitCallKitTypeがuserまたはplanetkitに設定されている場合)、マイクインジケーターはCallKitによって制御されます。開始時に.mutedにしていると、接続後にミュート状態がCallKitと同期され、インジケーターの表示が抑制されます。このとき、同期が完了する前はインジケーターが一時的に点灯することがありますが、同期が完了するとミュート状態を正しく反映します。
オーディオの初期状態設定
通話タイプに応じてオーディオの初期状態を設定するために使用されるAPIは、次のとおりです。
1対1通話
- 発信者側:通話を作成する際に
PlanetKitMakeCallSettingBuilderのwithInitialMyAudioStateKey()でオーディオの初期状態を設定します。 - 受信者側:通話に応答する際に
acceptCall()のinitialMyAudioStateパラメーターでオーディオの初期状態を設定します。
1対1通話でオーディオの初期状態を設定するサンプルコードは、1対1音声通話および1対1ビデオ通話を参照してください。
グループ通話
グループ通話に参加する際にPlanetKitJoinConferenceSettingBuilderのwithInitialMyAudioStateKey()でオーディオの初期状態を設定します。
グループ通話でオーディオの初期状態を設定するサンプルコードは、グループ音声通話およびグループビデオ通話を参照してください。
関連API
オーディオの初期状態の設定に関連するAPIは、次のとおりです。
共通
1対1通話
-
PlanetKitMakeCallSettingBuilderのwithInitialMyAudioStateKey(_:) -
acceptCall(startMessage:useResponderPreparation:recordOnCloud:initialMyVideoState:initialMyAudioState:)