chore: default audio logic in line with other sdks (#970)

* default audio logic in line with other sdks

* tweak

* webrtc dependency bump

* added unit tests for applying call settings

* test fix

Author: Brazol

dogfooding/lib/widgets/settings_menu/settings_menu.dart

@@ -10,7 +10,8 @@ import 'package:flutter_dogfooding/widgets/settings_menu/closed_captions_menu_it
 import 'package:flutter_dogfooding/widgets/settings_menu/noise_cancellation_menu_item.dart';
 import 'package:flutter_dogfooding/widgets/settings_menu/settings_menu_item.dart';
 import 'package:flutter_dogfooding/widgets/settings_menu/standard_action_menu_item.dart';
-import 'package:stream_chat_flutter/stream_chat_flutter.dart';
+import 'package:stream_chat_flutter/stream_chat_flutter.dart'
+    hide CurrentPlatform;
 import 'package:stream_video_flutter/stream_video_flutter.dart';
 
 import '../../utils/feedback_dialog.dart';
@@ -206,6 +207,11 @@ class _SettingsMenuState extends State<SettingsMenu> {
         )
       ] else
         ChooseAudioOutputMenuItem(onPressed: () {
+          if (CurrentPlatform.isIos) {
+            _deviceNotifier.triggeriOSAudioRouteSelectionUI();
+            return;
+          }
+
           setState(() {
             showAudioOutputs = true;
           });

dogfooding/linux/flutter/generated_plugin_registrant.cc

@@ -13,6 +13,7 @@
 #include <record_linux/record_linux_plugin.h>
 #include <stream_webrtc_flutter/flutter_web_r_t_c_plugin.h>
 #include <url_launcher_linux/url_launcher_plugin.h>
+#include <volume_controller/volume_controller_plugin.h>
 
 void fl_register_plugins(FlPluginRegistry* registry) {
   g_autoptr(FlPluginRegistrar) desktop_drop_registrar =
@@ -36,4 +37,7 @@ void fl_register_plugins(FlPluginRegistry* registry) {
   g_autoptr(FlPluginRegistrar) url_launcher_linux_registrar =
       fl_plugin_registry_get_registrar_for_plugin(registry, "UrlLauncherPlugin");
   url_launcher_plugin_register_with_registrar(url_launcher_linux_registrar);
+  g_autoptr(FlPluginRegistrar) volume_controller_registrar =
+      fl_plugin_registry_get_registrar_for_plugin(registry, "VolumeControllerPlugin");
+  volume_controller_plugin_register_with_registrar(volume_controller_registrar);
 }

dogfooding/linux/flutter/generated_plugins.cmake

@@ -10,6 +10,7 @@ list(APPEND FLUTTER_PLUGIN_LIST
   record_linux
   stream_webrtc_flutter
   url_launcher_linux
+  volume_controller
 )
 
 list(APPEND FLUTTER_FFI_PLUGIN_LIST

melos.yaml

@@ -22,7 +22,7 @@ command:
       device_info_plus: ">=10.1.2 <12.0.0"
       share_plus: ^11.0.0
       stream_chat_flutter: ^9.8.0
-      stream_webrtc_flutter: ^1.0.5
+      stream_webrtc_flutter: ^1.0.6
 
 scripts:
   postclean:

packages/stream_video/lib/src/call/call.dart

@@ -101,6 +101,7 @@ class Call {
     RetryPolicy? retryPolicy,
     SdpPolicy? sdpPolicy,
     CallPreferences? preferences,
+    RtcMediaDeviceNotifier? rtcMediaDeviceNotifier,
   }) {
     streamLog.i(_tag, () => '<factory> callCid: $callCid');
     return Call._internal(
@@ -111,6 +112,7 @@ class Call {
       retryPolicy: retryPolicy,
       sdpPolicy: sdpPolicy,
       preferences: preferences,
+      rtcMediaDeviceNotifier: rtcMediaDeviceNotifier,
     );
   }
 
@@ -125,6 +127,7 @@ class Call {
     RetryPolicy? retryPolicy,
     SdpPolicy? sdpPolicy,
     CallPreferences? preferences,
+    RtcMediaDeviceNotifier? rtcMediaDeviceNotifier,
   }) {
     streamLog.i(_tag, () => '<factory> created: $data');
     return Call._internal(
@@ -135,6 +138,7 @@ class Call {
       retryPolicy: retryPolicy,
       sdpPolicy: sdpPolicy,
       preferences: preferences,
+      rtcMediaDeviceNotifier: rtcMediaDeviceNotifier,
     ).also(
       (it) => it._stateManager.updateFromCallCreatedData(
         data,
@@ -154,6 +158,7 @@ class Call {
     RetryPolicy? retryPolicy,
     SdpPolicy? sdpPolicy,
     CallPreferences? preferences,
+    RtcMediaDeviceNotifier? rtcMediaDeviceNotifier,
   }) {
     streamLog.i(_tag, () => '<factory> created: $data');
     return Call._internal(
@@ -164,6 +169,7 @@ class Call {
       retryPolicy: retryPolicy,
       sdpPolicy: sdpPolicy,
       preferences: preferences,
+      rtcMediaDeviceNotifier: rtcMediaDeviceNotifier,
     ).also((it) => it._stateManager.lifecycleCallRinging(data));
   }
 
@@ -176,6 +182,7 @@ class Call {
     SdpPolicy? sdpPolicy,
     CallPreferences? preferences,
     CallCredentials? credentials,
+    RtcMediaDeviceNotifier? rtcMediaDeviceNotifier,
   }) {
     final finalCallPreferences = preferences ?? DefaultCallPreferences();
     final finalRetryPolicy = retryPolicy ?? const RetryPolicy();
@@ -204,6 +211,8 @@ class Call {
       retryPolicy: finalRetryPolicy,
       sdpPolicy: finalSdpPolicy,
       permissionManager: permissionManager,
+      rtcMediaDeviceNotifier:
+          rtcMediaDeviceNotifier ?? RtcMediaDeviceNotifier.instance,
     );
   }
 
@@ -215,6 +224,7 @@ class Call {
     required this.networkMonitor,
     required RetryPolicy retryPolicy,
     required SdpPolicy sdpPolicy,
+    required RtcMediaDeviceNotifier rtcMediaDeviceNotifier,
     CallCredentials? credentials,
   })  : _sessionFactory = CallSessionFactory(
           callCid: stateManager.callState.callCid,
@@ -228,6 +238,7 @@ class Call {
         _streamVideo = streamVideo,
         _retryPolicy = retryPolicy,
         _credentials = credentials,
+        _rtcMediaDeviceNotifier = rtcMediaDeviceNotifier,
         dynascaleManager = DynascaleManager(stateManager: stateManager) {
     streamLog.i(_tag, () => '<init> state: ${stateManager.callState}');
 
@@ -252,6 +263,7 @@ class Call {
   final PermissionsManager _permissionsManager;
   final DynascaleManager dynascaleManager;
   final InternetConnection networkMonitor;
+  final RtcMediaDeviceNotifier _rtcMediaDeviceNotifier;
 
   CallCredentials? _credentials;
   CallSession? _session;
@@ -1458,9 +1470,7 @@ class Call {
   }
 
   Future<void> _applyCallSettingsToConnectOptions(CallSettings settings) async {
-    // Apply defaul audio output and input devices
-    final mediaDevicesResult =
-        await RtcMediaDeviceNotifier.instance.enumerateDevices();
+    final mediaDevicesResult = await _rtcMediaDeviceNotifier.enumerateDevices();
 
     final mediaDevices = mediaDevicesResult.fold(
       success: (success) => success.data,
@@ -1477,38 +1487,65 @@ class Call {
         .where((d) => d.kind == RtcMediaDeviceKind.videoInput)
         .toList();
 
-    var defaultAudioOutput = audioOutputs.firstWhereOrNull((device) {
-      if (settings.audio.defaultDevice ==
-          AudioSettingsRequestDefaultDeviceEnum.speaker) {
-        return device.id.equalsIgnoreCase(
-          AudioSettingsRequestDefaultDeviceEnum.speaker.value,
+    /// Determines if the speaker should be enabled based on a priority hierarchy of
+    /// settings.
+    ///
+    /// The priority order is as follows:
+    /// 1. If video camera is set to be on by default, speaker is enabled
+    /// 2. If audio speaker is set to be on by default, speaker is enabled
+    /// 3. If the default audio device is set to speaker, speaker is enabled
+    final speakerOnWithSettingsPriority = settings.video.cameraDefaultOn ||
+        settings.audio.speakerDefaultOn ||
+        settings.audio.defaultDevice ==
+            AudioSettingsRequestDefaultDeviceEnum.speaker;
+
+    // Determine default audio output with priority:
+    // 1. External device (if available)
+    var defaultAudioOutput =
+        audioOutputs.firstWhereOrNull((device) => device.isExternal);
+
+    if (defaultAudioOutput == null) {
+      // 2. Speaker (if settings indicate it should be used)
+      if (speakerOnWithSettingsPriority) {
+        defaultAudioOutput = audioOutputs.firstWhereOrNull(
+          (device) => device.id.equalsIgnoreCase(
+            AudioSettingsRequestDefaultDeviceEnum.speaker.value,
+          ),
+        );
+      } else {
+        // 3. First non-speaker device
+        defaultAudioOutput = audioOutputs.firstWhereOrNull(
+          (device) => !device.id.equalsIgnoreCase(
+            AudioSettingsRequestDefaultDeviceEnum.speaker.value,
+          ),
         );
       }
+    }
 
-      return !device.id.equalsIgnoreCase(
-        AudioSettingsRequestDefaultDeviceEnum.speaker.value,
-      );
-    });
+    final defaultAudioOutputIsExternal =
+        defaultAudioOutput?.isExternal ?? false;
 
-    if (defaultAudioOutput == null && audioOutputs.isNotEmpty) {
-      defaultAudioOutput = audioOutputs.first;
+    // iOS doesn't allow implicitly setting the default audio output,
+    // if external device is connected we trust the OS to set it as default.
+    if (defaultAudioOutputIsExternal && CurrentPlatform.isIos) {
+      defaultAudioOutput = null;
     }
 
+    // Match the default audio input with the default audio output if possible
+    final defaultAudioInput = audioInputs
+        .firstWhereOrNull((d) => d.label == defaultAudioOutput?.label);
+
     var defaultVideoInput = videoInputs.firstWhereOrNull(
       (device) => device.label
           .toLowerCase()
           .contains(settings.video.cameraFacing.value.toLowerCase()),
     );
 
+    // If it's not front or back then take one of the external cameras
     if (defaultVideoInput == null && videoInputs.length > 2) {
-      // If it's not front or back then take one of the external cameras
       defaultVideoInput = videoInputs.last;
     }
 
-    final defaultAudioInput = audioInputs
-            .firstWhereOrNull((d) => d.label == defaultAudioOutput?.label) ??
-        audioInputs.firstOrNull;
-
     _connectOptions = connectOptions.copyWith(
       camera: TrackOption.fromSetting(
         enabled: settings.video.cameraDefaultOn,
@@ -1523,7 +1560,8 @@ class Call {
               VideoSettingsRequestCameraFacingEnum.front
           ? FacingMode.user
           : FacingMode.environment,
-      speakerDefaultOn: settings.audio.speakerDefaultOn,
+      speakerDefaultOn:
+          !defaultAudioOutputIsExternal && speakerOnWithSettingsPriority,
       targetResolution: settings.video.targetResolution,
       screenShareTargetResolution: settings.screenShare.targetResolution,
     );
@@ -2203,7 +2241,7 @@ class Call {
     await result.fold(
       success: (success) async {
         final mediaDevicesResult =
-            await RtcMediaDeviceNotifier.instance.enumerateDevices();
+            await _rtcMediaDeviceNotifier.enumerateDevices();
 
         final mediaDevices = mediaDevicesResult.fold(
           success: (success) => success.data,
@@ -2385,10 +2423,6 @@ class Call {
       _connectOptions = _connectOptions.copyWith(
         microphone: enabled ? TrackOption.enabled() : TrackOption.disabled(),
       );
-
-      if (_connectOptions.audioOutputDevice != null) {
-        await setAudioOutputDevice(_connectOptions.audioOutputDevice!);
-      }
     }
 
     return result.map((_) => none);

packages/stream_video/lib/src/webrtc/rtc_media_device/rtc_media_device.dart

@@ -1,5 +1,7 @@
 import 'package:equatable/equatable.dart';
 
+import '../../platform_detector/platform_detector.dart';
+
 enum RtcMediaDeviceKind {
   audioInput('audioinput'),
   audioOutput('audiooutput'),
@@ -41,4 +43,47 @@ class RtcMediaDevice with EquatableMixin {
 
   @override
   List<Object?> get props => [id, kind, groupId, label];
+
+  /// The set of external audio ports that are considered external outputs
+  static const Set<String> iOSExternalPorts = {
+    'bluetoothA2DP',
+    'bluetoothLE',
+    'bluetoothHFP',
+    'carAudio',
+    'headphones',
+  };
+
+  /// The set of external audio device types that are considered external outputs
+  static const Set<String> androidExternalAudioDeviceType = {
+    'bluetooth',
+    'wired-headset',
+  };
+
+  /// Whether this device represents an external audio output.
+  /// Checks if the device label contains any of the external port types.
+  bool get isExternal {
+    if (groupId == null) {
+      return false;
+    }
+
+    if (CurrentPlatform.isIos) {
+      return iOSExternalPorts.any(
+        (port) => groupId!.toLowerCase().contains(
+              port.toLowerCase(),
+            ),
+      );
+    } else if (CurrentPlatform.isAndroid) {
+      return androidExternalAudioDeviceType.any(
+        (type) => groupId!.toLowerCase().contains(
+              type.toLowerCase(),
+            ),
+      );
+    } else {
+      return groupId!.toLowerCase().contains('bluetooth');
+    }
+  }
+
+  bool get isSpeaker => id.toLowerCase() == 'speaker';
+
+  bool get isEarpiece => id.toLowerCase() == 'earpiece';
 }

packages/stream_video/lib/src/webrtc/rtc_media_device/rtc_media_device_notifier.dart

@@ -87,4 +87,8 @@ class RtcMediaDeviceNotifier {
   Future<Result<List<RtcMediaDevice>>> videoInputs() {
     return enumerateDevices(kind: RtcMediaDeviceKind.videoInput);
   }
+
+  Future<void> triggeriOSAudioRouteSelectionUI() {
+    return rtc.Helper.triggeriOSAudioRouteSelectionUI();
+  }
 }

packages/stream_video/pubspec.yaml

@@ -31,7 +31,7 @@ dependencies:
   rxdart: ^0.28.0
   sdp_transform: ^0.3.2
   state_notifier: ^1.0.0
-  stream_webrtc_flutter: ^1.0.5
+  stream_webrtc_flutter: ^1.0.6
   synchronized: ^3.1.0
   system_info2: ^4.0.0
   tart: ^0.5.1