feat(llc, ui): added method with callbacks to handling audio interruptions (iOS, Android) (#984)

* handling audio interruptions

* fix

* Update dogfooding/lib/screens/home_screen.dart

Co-authored-by: Rene Floor <[email protected]>

* webrtc version bump

* Update dogfooding/lib/app/app_content.dart

Co-authored-by: Rene Floor <[email protected]>

* fix

* fix

* changelogs

---------

Co-authored-by: Rene Floor <[email protected]>

Author: Brazol

dogfooding/android/app/src/main/AndroidManifest.xml

@@ -11,6 +11,8 @@
     <uses-permission android:name="android.permission.BLUETOOTH" android:maxSdkVersion="30"/>
     <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" android:maxSdkVersion="30"/>
     <uses-permission android:name="android.permission.BLUETOOTH_CONNECT"/>
+    <uses-permission android:name="android.permission.READ_PHONE_STATE"/>
+    <uses-permission android:name="android.permission.READ_CALL_STATE" />
 
    <application
         android:label="Stream Video Calls (Flutter)"

dogfooding/lib/app/app_content.dart

@@ -86,6 +86,7 @@ class _StreamDogFoodingAppContentState
   late final _router = initRouter(_userAuthController);
 
   final _compositeSubscription = CompositeSubscription();
+  bool? _microphoneEnabledBeforeInterruption;
 
   @override
   void initState() {
@@ -105,6 +106,7 @@ class _StreamDogFoodingAppContentState
     });
 
     _tryConsumingIncomingCallFromTerminatedState();
+    _handleMobileAudioInterruptions();
   }
 
   void initPushNotificationManagerIfAvailable() {
@@ -120,6 +122,26 @@ class _StreamDogFoodingAppContentState
     _observeFcmMessages();
   }
 
+  void _handleMobileAudioInterruptions() {
+    if (!CurrentPlatform.isMobile) return;
+
+    RtcMediaDeviceNotifier.instance.handleCallInterruptionCallbacks(
+      onInterruptionStart: () {
+        final call = StreamVideo.instance.activeCall;
+        _microphoneEnabledBeforeInterruption =
+            call?.state.value.localParticipant?.isAudioEnabled;
+
+        call?.setMicrophoneEnabled(enabled: false);
+      },
+      onInterruptionEnd: () {
+        if (_microphoneEnabledBeforeInterruption == true) {
+          StreamVideo.instance.activeCall?.setMicrophoneEnabled(enabled: true);
+        }
+        _microphoneEnabledBeforeInterruption = null;
+      },
+    );
+  }
+
   void _tryConsumingIncomingCallFromTerminatedState() {
     if (!CurrentPlatform.isAndroid) return;
 

dogfooding/lib/screens/home_screen.dart

@@ -47,6 +47,7 @@ class _HomeScreenState extends State<HomeScreen> {
         Permission.notification,
         Permission.camera,
         Permission.microphone,
+        if (CurrentPlatform.isAndroid) Permission.phone,
       ].request();
 
       StreamVideoPushNotificationManager.ensureFullScreenIntentPermission();

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.6
+      stream_webrtc_flutter: ^1.0.7
 
 scripts:
   postclean:

packages/stream_video/CHANGELOG.md

@@ -1,3 +1,6 @@
+## Unreleased
+* Added `handleCallInterruptionCallbacks` method to `RtcMediaDeviceNotifier` that provides an option to handle system audio interruption like incoming calls, or other media playing
+
 ## 0.9.5
 
 ✅ Added

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

@@ -9,6 +9,12 @@ import '../../utils/extensions.dart';
 import '../../utils/result.dart';
 import 'rtc_media_device.dart';
 
+abstract class InterruptionEvent {}
+
+class InterruptionBeginEvent extends InterruptionEvent {}
+
+class InterruptionEndEvent extends InterruptionEvent {}
+
 class RtcMediaDeviceNotifier {
   RtcMediaDeviceNotifier._internal() {
     // Debounce call the onDeviceChange callback.
@@ -22,6 +28,43 @@ class RtcMediaDeviceNotifier {
   Stream<List<RtcMediaDevice>> get onDeviceChange => _devicesController.stream;
   final _devicesController = BehaviorSubject<List<RtcMediaDevice>>();
 
+  /// Allows to handle call interruption callbacks.
+  /// [onInterruptionStart] is called when the call interruption begins.
+  /// [onInterruptionEnd] is called when the call interruption ends.
+  /// [androidInterruptionSource] specifies the source of the interruption on Android.
+  ///
+  /// On iOS, interruptions can occur due to:
+  /// - Incoming phone calls
+  /// - Siri activation
+  /// - Alarm or timer sounds
+  /// - Audio from other apps taking over (e.g., voice memo, navigation)
+  ///
+  /// On Android, interruption sources depend on the [androidInterruptionSource]:
+  /// - With audioFocus:
+  ///   - Other media apps interrupting (e.g., Spotify)
+  ///   - Assistant voice prompts (e.g., Google Assistant)
+  ///   - Alarms and notifications
+  /// - With telephony:
+  ///   - Phone calls (requires READ_PHONE_STATE permission)
+  ///
+  /// This method allows you to pause the call, mute the audio, or perform any other
+  /// necessary actions when interruptions occur.
+  ///
+  /// For more details on handling call interruptions, refer to the
+  /// [Stream Video documentation](https://getstream.io/video/docs/flutter/advanced/handling-system-audio-interruptions/).
+  Future<void> handleCallInterruptionCallbacks({
+    void Function()? onInterruptionStart,
+    void Function()? onInterruptionEnd,
+    rtc.AndroidInterruptionSource androidInterruptionSource =
+        rtc.AndroidInterruptionSource.audioFocusAndTelephony,
+  }) {
+    return rtc.handleCallInterruptionCallbacks(
+      onInterruptionStart,
+      onInterruptionEnd,
+      androidInterruptionSource: androidInterruptionSource,
+    );
+  }
+
   Future<void> _onDeviceChange(_) async {
     final devicesResult = await enumerateDevices();
     final devices = devicesResult.getDataOrNull();

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.6
+  stream_webrtc_flutter: ^1.0.7
   synchronized: ^3.1.0
   system_info2: ^4.0.0
   tart: ^0.5.1

packages/stream_video_flutter/CHANGELOG.md

@@ -1,3 +1,6 @@
+## Unreleased
+* Added `handleCallInterruptionCallbacks` method to `RtcMediaDeviceNotifier` that provides an option to handle system audio interruption like incoming calls, or other media playing
+
 ## 0.9.5
 
 ✅ Added

packages/stream_video_flutter/example/pubspec.yaml

@@ -30,7 +30,7 @@ dependencies:
   stream_video: ^0.9.5
   stream_video_flutter: ^0.9.5
   stream_video_push_notification: ^0.9.5
-  stream_webrtc_flutter: ^1.0.6
+  stream_webrtc_flutter: ^1.0.7
 
 dependency_overrides:
   stream_video:

packages/stream_video_flutter/pubspec.yaml

@@ -23,11 +23,11 @@ dependencies:
   plugin_platform_interface: ^2.1.8
   rate_limiter: ^1.0.0
   stream_video: ^0.9.5
-  stream_webrtc_flutter: ^1.0.6
+  stream_webrtc_flutter: ^1.0.7
   visibility_detector: ^0.4.0+2
 
 dev_dependencies:
-  alchemist: '>=0.11.0 <0.13.0'
+  alchemist: ">=0.11.0 <0.13.0"
   flutter_test:
     sdk: flutter
   mocktail: ^1.0.0