fix: Improve speaker switching logic for iOS. (#692)

* fix: Improve speaker switching logic for iOS.

* update.

* fix.

example/lib/widgets/controls.dart

@@ -107,14 +107,13 @@ class _ControlsWidgetState extends State<ControlsWidget> {
     setState(() {});
   }
 
-  void _setSpeakerphoneOn() {
+  void _setSpeakerphoneOn() async {
     _speakerphoneOn = !_speakerphoneOn;
-    Hardware.instance.setSpeakerphoneOn(_speakerphoneOn);
+    await widget.room.setSpeakerOn(_speakerphoneOn, forceSpeakerOutput: false);
     setState(() {});
   }
 
   void _toggleCamera() async {
-    //
     final track = participant.videoTrackPublications.firstOrNull?.track;
     if (track == null) return;
 

lib/src/core/engine.dart

@@ -541,8 +541,8 @@ class Engine extends Disposable with EventsEmittable<EngineEvent> {
                 type: Reliability.lossy,
               )));
       // _onDCStateUpdated(Reliability.lossy, state)
-    } catch (_) {
-      logger.severe('[$objectId] createDataChannel() did throw $_');
+    } catch (err) {
+      logger.severe('[$objectId] createDataChannel() did throw $err');
     }
 
     try {
@@ -558,8 +558,8 @@ class Engine extends Disposable with EventsEmittable<EngineEvent> {
                 state: state,
                 type: Reliability.reliable,
               )));
-    } catch (_) {
-      logger.severe('[$objectId] createDataChannel() did throw $_');
+    } catch (err) {
+      logger.severe('[$objectId] createDataChannel() did throw $err');
     }
   }
 

lib/src/core/room.dart

@@ -1066,9 +1066,15 @@ extension RoomHardwareManagementMethods on Room {
     );
   }
 
-  Future<void> setSpeakerOn(bool speakerOn) async {
-    if (lkPlatformIs(PlatformType.iOS) || lkPlatformIs(PlatformType.android)) {
-      await Hardware.instance.setSpeakerphoneOn(speakerOn);
+  /// [speakerOn] set speakerphone on or off, by default wired/bluetooth headsets will still
+  /// be prioritized even if set to true.
+  /// [forceSpeakerOutput] if true, will force speaker output even if headphones
+  /// or bluetooth is connected, only supported on iOS for now
+  Future<void> setSpeakerOn(bool speakerOn,
+      {bool forceSpeakerOutput = false}) async {
+    if (lkPlatformIsMobile()) {
+      await Hardware.instance
+          .setSpeakerphoneOn(speakerOn, forceSpeakerOutput: forceSpeakerOutput);
       engine.roomOptions = engine.roomOptions.copyWith(
         defaultAudioOutputOptions:
             roomOptions.defaultAudioOutputOptions.copyWith(
@@ -1082,8 +1088,7 @@ extension RoomHardwareManagementMethods on Room {
   @internal
   Future<void> applyAudioSpeakerSettings() async {
     if (roomOptions.defaultAudioOutputOptions.speakerOn != null) {
-      if (lkPlatformIs(PlatformType.iOS) ||
-          lkPlatformIs(PlatformType.android)) {
+      if (lkPlatformIsMobile()) {
         await Hardware.instance.setSpeakerphoneOn(
             roomOptions.defaultAudioOutputOptions.speakerOn!);
       }

lib/src/core/transport.dart

@@ -85,15 +85,15 @@ class Transport extends Disposable {
       List<rtc.RTCRtpSender> senders = [];
       try {
         senders = await pc.getSenders();
-      } catch (_) {
-        logger.warning('getSenders() failed with error: $_');
+      } catch (err) {
+        logger.warning('getSenders() failed with error: $err');
       }
 
       for (final e in senders) {
         try {
           await pc.removeTrack(e);
-        } catch (_) {
-          logger.warning('removeTrack() failed with error: $_');
+        } catch (err) {
+          logger.warning('removeTrack() failed with error: $err');
         }
       }
 
@@ -261,8 +261,8 @@ class Transport extends Disposable {
     try {
       final result = await pc.getRemoteDescription();
       return result;
-    } catch (_) {
-      logger.warning('pc.getRemoteDescription failed with error: $_');
+    } catch (err) {
+      logger.warning('pc.getRemoteDescription failed with error: $err');
     }
     return null;
   }

lib/src/hardware/hardware.dart

@@ -76,14 +76,18 @@ class Hardware {
 
   MediaDevice? selectedVideoInput;
 
-  bool? _speakerOn;
+  bool? get speakerOn => _preferSpeakerOutput;
 
-  bool? get speakerOn => _speakerOn;
-
-  bool _preferSpeakerOutput = false;
+  bool _preferSpeakerOutput = true;
 
   bool get preferSpeakerOutput => _preferSpeakerOutput;
 
+  bool _forceSpeakerOutput = false;
+
+  /// if true, will force speaker output even if headphones or bluetooth is connected
+  /// only supported on iOS for now
+  bool get forceSpeakerOutput => _forceSpeakerOutput && _preferSpeakerOutput;
+
   Future<List<MediaDevice>> enumerateDevices({String? type}) async {
     var infos = await rtc.navigator.mediaDevices.enumerateDevices();
     var devices = infos
@@ -126,33 +130,42 @@ class Hardware {
     await rtc.Helper.selectAudioInput(device.deviceId);
   }
 
-  Future<void> setPreferSpeakerOutput(bool enable) async {
-    if (lkPlatformIs(PlatformType.iOS)) {
-      if (_preferSpeakerOutput != enable) {
+  @Deprecated('use setSpeakerphoneOn')
+  Future<void> setPreferSpeakerOutput(bool enable) => setSpeakerphoneOn(enable);
+
+  bool get canSwitchSpeakerphone => lkPlatformIsMobile();
+
+  /// [enable] set speakerphone on or off, by default wired/bluetooth headsets will still
+  /// be prioritized even if set to true.
+  /// [forceSpeakerOutput] if true, will force speaker output even if headphones
+  /// or bluetooth is connected, only supported on iOS for now
+  Future<void> setSpeakerphoneOn(bool enable,
+      {bool forceSpeakerOutput = false}) async {
+    if (canSwitchSpeakerphone) {
+      _preferSpeakerOutput = enable;
+      _forceSpeakerOutput = forceSpeakerOutput;
+      if (lkPlatformIs(PlatformType.iOS)) {
         NativeAudioConfiguration? config;
         if (lkPlatformIs(PlatformType.iOS)) {
           // Only iOS for now...
           config = await onConfigureNativeAudio.call(audioTrackState);
+          if (_preferSpeakerOutput && _forceSpeakerOutput) {
+            config = config.copyWith(
+              appleAudioCategoryOptions: {
+                AppleAudioCategoryOption.defaultToSpeaker,
+              },
+            );
+          }
           logger.fine('configuring for ${audioTrackState} using ${config}...');
           try {
             await Native.configureAudio(config);
           } catch (error) {
             logger.warning('failed to configure ${error}');
           }
         }
+      } else {
+        await rtc.Helper.setSpeakerphoneOn(enable);
       }
-      _preferSpeakerOutput = enable;
-    } else {
-      logger.warning('setPreferSpeakerOutput only support on iOS');
-    }
-  }
-
-  bool get canSwitchSpeakerphone => lkPlatformIsMobile();
-
-  Future<void> setSpeakerphoneOn(bool enable) async {
-    if (canSwitchSpeakerphone) {
-      _speakerOn = enable;
-      await rtc.Helper.setSpeakerphoneOn(enable);
     } else {
       logger.warning('setSpeakerphoneOn only support on iOS/Android');
     }

lib/src/support/native.dart

@@ -31,11 +31,6 @@ class Native {
   static Future<bool> configureAudio(
       NativeAudioConfiguration configuration) async {
     try {
-      if (bypassVoiceProcessing) {
-        /// skip configuring audio if bypassVoiceProcessing
-        /// is enabled
-        return false;
-      }
       final result = await channel.invokeMethod<bool>(
         'configureNativeAudio',
         configuration.toMap(),

lib/src/support/native_audio.dart

@@ -86,15 +86,50 @@ class NativeAudioConfiguration {
   final AppleAudioCategory? appleAudioCategory;
   final Set<AppleAudioCategoryOption>? appleAudioCategoryOptions;
   final AppleAudioMode? appleAudioMode;
+  final bool? preferSpeakerOutput;
 
-  NativeAudioConfiguration({
-    // for iOS / Mac
-    this.appleAudioCategory,
-    this.appleAudioCategoryOptions,
-    this.appleAudioMode,
-    // Android options
-    // ...
-  });
+  static final soloAmbient = NativeAudioConfiguration(
+    appleAudioCategory: AppleAudioCategory.soloAmbient,
+    appleAudioCategoryOptions: {},
+    appleAudioMode: AppleAudioMode.default_,
+  );
+
+  static final playback = NativeAudioConfiguration(
+    appleAudioCategory: AppleAudioCategory.playback,
+    appleAudioCategoryOptions: {AppleAudioCategoryOption.mixWithOthers},
+    appleAudioMode: AppleAudioMode.spokenAudio,
+  );
+
+  static final playAndRecordSpeaker = NativeAudioConfiguration(
+    appleAudioCategory: AppleAudioCategory.playAndRecord,
+    appleAudioCategoryOptions: {
+      AppleAudioCategoryOption.allowBluetooth,
+      AppleAudioCategoryOption.allowBluetoothA2DP,
+      AppleAudioCategoryOption.allowAirPlay,
+    },
+    appleAudioMode: AppleAudioMode.videoChat,
+  );
+
+  static final playAndRecordReceiver = NativeAudioConfiguration(
+    appleAudioCategory: AppleAudioCategory.playAndRecord,
+    appleAudioCategoryOptions: {
+      AppleAudioCategoryOption.allowBluetooth,
+      AppleAudioCategoryOption.allowBluetoothA2DP,
+      AppleAudioCategoryOption.allowAirPlay,
+    },
+    appleAudioMode: AppleAudioMode.voiceChat,
+  );
+
+  NativeAudioConfiguration(
+      {
+      // for iOS / Mac
+      this.appleAudioCategory,
+      this.appleAudioCategoryOptions,
+      this.appleAudioMode,
+      this.preferSpeakerOutput
+      // Android options
+      // ...
+      });
 
   Map<String, dynamic> toMap() => <String, dynamic>{
         if (appleAudioCategory != null)
@@ -104,17 +139,21 @@ class NativeAudioConfiguration {
               appleAudioCategoryOptions!.map((e) => e.toStringValue()).toList(),
         if (appleAudioMode != null)
           'appleAudioMode': appleAudioMode!.toStringValue(),
+        if (preferSpeakerOutput != null)
+          'preferSpeakerOutput': preferSpeakerOutput,
       };
 
   NativeAudioConfiguration copyWith({
     AppleAudioCategory? appleAudioCategory,
     Set<AppleAudioCategoryOption>? appleAudioCategoryOptions,
     AppleAudioMode? appleAudioMode,
+    bool? preferSpeakerOutput,
   }) =>
       NativeAudioConfiguration(
         appleAudioCategory: appleAudioCategory ?? this.appleAudioCategory,
         appleAudioCategoryOptions:
             appleAudioCategoryOptions ?? this.appleAudioCategoryOptions,
         appleAudioMode: appleAudioMode ?? this.appleAudioMode,
+        preferSpeakerOutput: preferSpeakerOutput ?? this.preferSpeakerOutput,
       );
 }

lib/src/track/audio_management.dart

@@ -12,7 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import 'package:flutter_webrtc/flutter_webrtc.dart' as rtc;
 import 'package:synchronized/synchronized.dart' as sync;
 
 import '../hardware/hardware.dart';
@@ -114,6 +113,14 @@ Future<void> _onAudioTrackCountDidChange() async {
     if (lkPlatformIs(PlatformType.iOS)) {
       // Only iOS for now...
       config = await onConfigureNativeAudio.call(_audioTrackState);
+
+      if (Hardware.instance.forceSpeakerOutput) {
+        config = config.copyWith(
+          appleAudioCategoryOptions: {
+            AppleAudioCategoryOption.defaultToSpeaker,
+          },
+        );
+      }
     }
 
     if (config != null) {
@@ -124,13 +131,6 @@ Future<void> _onAudioTrackCountDidChange() async {
         logger.warning('failed to configure ${error}');
       }
     }
-
-    if (lkPlatformIs(PlatformType.iOS)) {
-      if (Hardware.instance.speakerOn != null &&
-          Hardware.instance.canSwitchSpeakerphone) {
-        await rtc.Helper.setSpeakerphoneOn(Hardware.instance.speakerOn!);
-      }
-    }
   }
 }
 
@@ -148,38 +148,14 @@ AudioTrackState _computeAudioTrackState() {
 
 Future<NativeAudioConfiguration> defaultNativeAudioConfigurationFunc(
     AudioTrackState state) async {
-  //
-  if (state == AudioTrackState.remoteOnly &&
+  if (state == AudioTrackState.none) {
+    return NativeAudioConfiguration.soloAmbient;
+  } else if (state == AudioTrackState.remoteOnly &&
       Hardware.instance.preferSpeakerOutput) {
-    return NativeAudioConfiguration(
-      appleAudioCategory: AppleAudioCategory.playback,
-      appleAudioCategoryOptions: {
-        AppleAudioCategoryOption.mixWithOthers,
-      },
-      appleAudioMode: AppleAudioMode.spokenAudio,
-    );
-  } else if ([
-        AudioTrackState.localOnly,
-        AudioTrackState.localAndRemote,
-      ].contains(state) ||
-      (state == AudioTrackState.remoteOnly &&
-          !Hardware.instance.preferSpeakerOutput)) {
-    return NativeAudioConfiguration(
-      appleAudioCategory: AppleAudioCategory.playAndRecord,
-      appleAudioCategoryOptions: {
-        AppleAudioCategoryOption.allowBluetooth,
-        AppleAudioCategoryOption.allowBluetoothA2DP,
-        AppleAudioCategoryOption.allowAirPlay,
-      },
-      appleAudioMode: Hardware.instance.preferSpeakerOutput
-          ? AppleAudioMode.videoChat
-          : AppleAudioMode.voiceChat,
-    );
+    return NativeAudioConfiguration.playback;
   }
 
-  return NativeAudioConfiguration(
-    appleAudioCategory: AppleAudioCategory.soloAmbient,
-    appleAudioCategoryOptions: {},
-    appleAudioMode: AppleAudioMode.default_,
-  );
+  return Hardware.instance.preferSpeakerOutput
+      ? NativeAudioConfiguration.playAndRecordSpeaker
+      : NativeAudioConfiguration.playAndRecordReceiver;
 }

lib/src/track/track.dart

@@ -133,6 +133,8 @@ abstract class Track extends DisposableChangeNotifier
 
     logger.fine('$objectId.stop()');
 
+    await mediaStreamTrack.stop();
+
     _active = false;
     return true;
   }