fix: Picture in Picture improvements (#857)

* pip improvements

* tweaks

Author: Brazol

dogfooding/lib/di/injector.dart

@@ -1,6 +1,5 @@
 // 📦 Package imports:
 import 'package:flutter/foundation.dart';
-import 'package:flutter/material.dart';
 // 🌎 Project imports:
 import 'package:flutter_dogfooding/core/repos/app_preferences.dart';
 import 'package:flutter_dogfooding/core/repos/user_chat_repository.dart';
@@ -155,8 +154,8 @@ StreamVideo _initStreamVideo(
     tokenLoader: tokenLoader,
     options: const StreamVideoOptions(
       logPriority: Priority.verbose,
-      muteAudioWhenInBackground: true,
-      muteVideoWhenInBackground: true,
+      muteAudioWhenInBackground: false,
+      muteVideoWhenInBackground: false,
       keepConnectionsAliveWhenInBackground: true,
     ),
     pushNotificationManagerProvider: StreamVideoPushNotificationManager.create(

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

@@ -6,6 +6,7 @@ import 'dart:typed_data';
 import 'package:collection/collection.dart';
 import 'package:internet_connection_checker_plus/internet_connection_checker_plus.dart';
 import 'package:meta/meta.dart';
+import 'package:stream_webrtc_flutter/stream_webrtc_flutter.dart' as rtc;
 import 'package:stream_webrtc_flutter/stream_webrtc_flutter.dart';
 import 'package:synchronized/synchronized.dart';
 
@@ -1979,6 +1980,24 @@ class Call {
     return result.map((_) => none);
   }
 
+  Future<Result<bool>> setMultitaskingCameraAccessEnabled(bool enabled) async {
+    if (CurrentPlatform.isIos) {
+      try {
+        final result =
+            await rtc.Helper.enableIOSMultitaskingCameraAccess(enabled);
+        return Result.success(result);
+      } catch (error, stackTrace) {
+        _logger.e(() => 'Failed to set multitasking camera access: $error');
+        return Result.error(
+          'Failed to set multitasking camera access',
+          stackTrace,
+        );
+      }
+    }
+
+    return const Result.success(false);
+  }
+
   Future<Result<None>> setVideoInputDevice(RtcMediaDevice device) async {
     final result = await _session?.setVideoInputDevice(device) ??
         Result.error('Session is null');
@@ -1998,14 +2017,19 @@ class Call {
     if (enabled && !hasPermission(CallPermission.sendVideo)) {
       return Result.error('Missing permission to send video');
     }
-
     final result =
         await _session?.setCameraEnabled(enabled, constraints: constraints) ??
             Result.error('Session is null');
 
     if (result.isSuccess) {
+      // Set multitasking camera access for iOS
+      final multitaskingResult = await setMultitaskingCameraAccessEnabled(
+        enabled && !_streamVideo.muteVideoWhenInBackground,
+      );
+
       _stateManager.participantSetCameraEnabled(
         enabled: enabled,
+        iOSMultitaskingCameraAccessEnabled: multitaskingResult.getDataOrNull(),
       );
 
       _connectOptions = _connectOptions.copyWith(

packages/stream_video/lib/src/call/state/mixins/state_participant_mixin.dart

@@ -245,8 +245,13 @@ mixin StateParticipantMixin on StateNotifier<CallState> {
 
   void participantSetCameraEnabled({
     required bool enabled,
+    bool? iOSMultitaskingCameraAccessEnabled,
   }) {
-    return _toggleTrackType(SfuTrackType.video, enabled);
+    return _toggleTrackType(
+      SfuTrackType.video,
+      enabled,
+      iOSMultitaskingCameraAccessEnabled: iOSMultitaskingCameraAccessEnabled,
+    );
   }
 
   void participantSetMicrophoneEnabled({
@@ -263,9 +268,11 @@ mixin StateParticipantMixin on StateNotifier<CallState> {
 
   void _toggleTrackType(
     SfuTrackType trackType,
-    bool enabled,
-  ) {
+    bool enabled, {
+    bool? iOSMultitaskingCameraAccessEnabled,
+  }) {
     state = state.copyWith(
+      iOSMultitaskingCameraAccessEnabled: iOSMultitaskingCameraAccessEnabled,
       callParticipants: state.callParticipants.map((participant) {
         if (participant.isLocal) {
           final publishedTracks = participant.publishedTracks;

packages/stream_video/lib/src/call_state.dart

@@ -48,6 +48,7 @@ class CallState extends Equatable {
       blockedUserIds: const [],
       participantCount: 0,
       anonymousParticipantCount: 0,
+      iOSMultitaskingCameraAccessEnabled: false,
       custom: const {},
     );
   }
@@ -87,6 +88,7 @@ class CallState extends Equatable {
     required this.blockedUserIds,
     required this.participantCount,
     required this.anonymousParticipantCount,
+    required this.iOSMultitaskingCameraAccessEnabled,
     required this.custom,
   });
 
@@ -124,6 +126,7 @@ class CallState extends Equatable {
   final List<String> blockedUserIds;
   final int participantCount;
   final int anonymousParticipantCount;
+  final bool iOSMultitaskingCameraAccessEnabled;
   final Map<String, Object> custom;
 
   String get callId => callCid.id;
@@ -175,6 +178,7 @@ class CallState extends Equatable {
     List<String>? blockedUserIds,
     int? participantCount,
     int? anonymousParticipantCount,
+    bool? iOSMultitaskingCameraAccessEnabled,
     Map<String, Object>? custom,
   }) {
     return CallState._(
@@ -213,6 +217,8 @@ class CallState extends Equatable {
       participantCount: participantCount ?? this.participantCount,
       anonymousParticipantCount:
           anonymousParticipantCount ?? this.anonymousParticipantCount,
+      iOSMultitaskingCameraAccessEnabled: iOSMultitaskingCameraAccessEnabled ??
+          this.iOSMultitaskingCameraAccessEnabled,
       custom: custom ?? this.custom,
     );
   }
@@ -282,6 +288,7 @@ class CallState extends Equatable {
         blockedUserIds,
         participantCount,
         anonymousParticipantCount,
+        iOSMultitaskingCameraAccessEnabled,
         custom,
       ];
 

packages/stream_video/lib/src/stream_video.dart

@@ -221,6 +221,9 @@ class StreamVideo extends Disposable {
   final StreamVideoOptions _options;
   final MutableClientState _state;
 
+  bool get muteVideoWhenInBackground => _options.muteVideoWhenInBackground;
+  bool get muteAudioWhenInBackground => _options.muteAudioWhenInBackground;
+
   final _tokenManager = TokenManager();
   final _subscriptions = Subscriptions();
   late final CoordinatorClient _client;
@@ -429,30 +432,33 @@ class StreamVideo extends Disposable {
     try {
       final activeCallCid = _state.activeCall.valueOrNull?.callCid;
 
-      if (state.isPaused &&
-          activeCallCid == null &&
-          !_options.keepConnectionsAliveWhenInBackground) {
-        _logger.i(() => '[onAppState] close connection');
-        _subscriptions.cancel(_idEvents);
-        await _client.closeConnection();
-      } else if (state.isPaused && activeCallCid != null) {
-        final callState = activeCall?.state.value;
-        final isVideoEnabled =
-            callState?.localParticipant?.isVideoEnabled ?? false;
-        final isAudioEnabled =
-            callState?.localParticipant?.isAudioEnabled ?? false;
-
-        if (_options.muteVideoWhenInBackground && isVideoEnabled) {
-          await activeCall?.setCameraEnabled(enabled: false);
-          _mutedCameraByStateChange = true;
-          _logger.v(() => 'Muted camera track since app was paused.');
-        }
-        if (_options.muteAudioWhenInBackground && isAudioEnabled) {
-          await activeCall?.setMicrophoneEnabled(enabled: false);
-          _mutedAudioByStateChange = true;
-          _logger.v(() => 'Muted audio track since app was paused.');
+      if (state.isPaused) {
+        // Handle app paused state
+        if (activeCallCid == null &&
+            !_options.keepConnectionsAliveWhenInBackground) {
+          _logger.i(() => '[onAppState] close connection');
+          _subscriptions.cancel(_idEvents);
+          await _client.closeConnection();
+        } else if (activeCallCid != null) {
+          final callState = activeCall?.state.value;
+          final isVideoEnabled =
+              callState?.localParticipant?.isVideoEnabled ?? false;
+          final isAudioEnabled =
+              callState?.localParticipant?.isAudioEnabled ?? false;
+
+          if (_options.muteVideoWhenInBackground && isVideoEnabled) {
+            await activeCall?.setCameraEnabled(enabled: false);
+            _mutedCameraByStateChange = true;
+            _logger.v(() => 'Muted camera track since app was paused.');
+          }
+          if (_options.muteAudioWhenInBackground && isAudioEnabled) {
+            await activeCall?.setMicrophoneEnabled(enabled: false);
+            _mutedAudioByStateChange = true;
+            _logger.v(() => 'Muted audio track since app was paused.');
+          }
         }
       } else if (state.isResumed) {
+        // Handle app resumed state
         _logger.i(() => '[onAppState] open connection');
         await _client.openConnection();
         _subscriptions.add(_idEvents, _client.events.listen(_onEvent));
@@ -610,20 +616,23 @@ class StreamVideo extends Disposable {
       cid: calls.first.callCid!,
     );
 
-    callResult.fold(success: (result) async {
-      final call = result.data;
-      await call.accept();
+    callResult.fold(
+      success: (result) async {
+        final call = result.data;
+        await call.accept();
 
-      onCallAccepted?.call(call);
+        onCallAccepted?.call(call);
 
-      return true;
-    }, failure: (error) {
-      _logger.d(
-        () =>
-            '[consumeAndAcceptActiveCall] error consuming incoming call: $error',
-      );
-      return false;
-    });
+        return true;
+      },
+      failure: (error) {
+        _logger.d(
+          () =>
+              '[consumeAndAcceptActiveCall] error consuming incoming call: $error',
+        );
+        return false;
+      },
+    );
 
     return false;
   }

packages/stream_video/lib/src/webrtc/rtc_track/rtc_local_track.dart

@@ -158,6 +158,7 @@ class RtcLocalTrack<T extends MediaConstraints> extends RtcTrack {
     streamLog.i(_tag, () => 'Enabling track $trackId');
     try {
       mediaTrack.enabled = true;
+
       for (final track in clonedTracks) {
         track.enabled = true;
       }

packages/stream_video/pubspec.yaml

@@ -30,7 +30,7 @@ dependencies:
   rxdart: ^0.28.0
   sdp_transform: ^0.3.2
   state_notifier: ^1.0.0
-  stream_webrtc_flutter: ^0.12.9
+  stream_webrtc_flutter: ^0.12.9+1
   synchronized: ^3.1.0
   system_info2: ^4.0.0
   tart: ^0.5.1

packages/stream_video_flutter/CHANGELOG.md

@@ -1,15 +1,23 @@
 ## Upcoming
 
 ✅ Added
-- Introduced `disposeAfterResolvingRinging()` and `consumeAndAcceptActiveCall()` methods in `StreamVideo` to simplify the ringing flow implementation.
+* Introduced `disposeAfterResolvingRinging()` and `consumeAndAcceptActiveCall()` methods in `StreamVideo` to simplify the ringing flow implementation.
     - Refer to the updated [Incoming Call Documentation](https://getstream.io/video/docs/flutter/incoming-calls/overview/) or the [Ringing Tutorial](https://getstream.io/video/sdk/flutter/tutorial/ringing/) for more details.
 
 🔄 Changed
-- Deprecated the `backgroundVoipCallHandler` parameter in `StreamVideoPushNotificationManager`, as it is no longer required for iOS ringing to function in a terminated state.
+* Deprecated the `backgroundVoipCallHandler` parameter in `StreamVideoPushNotificationManager`, as it is no longer required for iOS ringing to function in a terminated state.
 
 🐞 Fixed
 * Center alignment of buttons in `StreamLobbyVideo` to support more screen sizes.
 
+🚧 (Breaking) Picture-in-Picture (PiP) Improvements & Fixes
+* **Fixed:** PiP not working on Android 15.
+* **Fixed:** PiP not displaying other participants' screen sharing.
+* **Added support for iOS 18 Multitasking Camera Access changes.** From **iOS 18**, you can easily enable camera usage while the app is in the background (e.g., for PiP). Refer to [Picture in Picture documentation](https://getstream.io/video/docs/flutter/advanced/picture_in_picture/) for details.
+* Added `disablePictureInPictureWhenScreenSharing` configuration option to `PictureInPictureConfiguration`. When **true** (default), PiP is disabled if the local device is screen sharing.
+* ❗ Breaking Change: `ignoreLocalParticipantVideo` parameter in `IOSPictureInPictureConfiguration` is replaced by `includeLocalParticipantVideo`. By default, local video **is enabled** and will appear in PiP mode if the iOS device supports **Multitasking Camera Access**.
+* ❗ Breaking Change: `ignoreLocalParticipantVideo` parameter in `StreamPictureInPictureUiKitView` is also replaced by `includeLocalParticipantVideo`.
+
 ## 0.7.2
 
 🐞 Fixed

packages/stream_video_flutter/android/src/main/kotlin/io/getstream/video/flutter/stream_video_flutter/service/PictureInPictureHelper.kt

@@ -7,6 +7,7 @@ import android.content.pm.PackageManager
 import android.os.Build
 import android.util.Rational
 import io.getstream.video.flutter.stream_video_flutter.service.utils.getBoolean
+import android.app.PictureInPictureUiState
 
 class PictureInPictureHelper {
     companion object {
@@ -41,11 +42,7 @@ class PictureInPictureHelper {
 
                     val params = PictureInPictureParams.Builder()
                     params.setAspectRatio(aspect).apply {
-                        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
-                            setAutoEnterEnabled(true)
-                        }
                         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
-                            setTitle("Video Player")
                             setSeamlessResizeEnabled(true)
                         }
                     }

packages/stream_video_flutter/example/pubspec.yaml

@@ -30,7 +30,7 @@ dependencies:
   stream_video: ^0.7.2
   stream_video_flutter: ^0.7.2
   stream_video_push_notification: ^0.7.2
-  stream_webrtc_flutter: ^0.12.9
+  stream_webrtc_flutter: ^0.12.9+1
 
 dependency_overrides:
   stream_video: