fix(ui): await screen share service creation (#1139)

Brazol · web-flow · commit 7bc9eac54940 · 2025-12-23T22:33:05.000+01:00
* await screen share service creation

* add proper result handling

* changelog

* improve parcerable handling

* pip sorting tweak

* changelog
diff --git a/melos.yaml b/melos.yaml
@@ -22,7 +22,7 @@ command:
       device_info_plus: ^12.1.0
       share_plus: ^11.0.0
       stream_chat_flutter: ^9.17.0
-      stream_webrtc_flutter: ^2.2.2
+      stream_webrtc_flutter: ^2.2.3
       stream_video: ^1.2.0
       stream_video_flutter: ^1.2.0
       stream_video_noise_cancellation: ^1.2.0
diff --git a/packages/stream_video/lib/src/sorting/call_participant_sorting_presets.dart b/packages/stream_video/lib/src/sorting/call_participant_sorting_presets.dart
@@ -37,4 +37,16 @@ mixin CallParticipantSortingPresets {
       byRole(['admin', 'host', 'speaker']),
     ],
   );
+
+  /// The sorting preset for PiP layout.
+  /// For picture in picture we don't rely on visibility as it's a separate view not related to the main one.
+  static final pictureInPicture = combineComparators<CallParticipantState>([
+    pinned,
+    screenSharing,
+    dominantSpeaker,
+    speaking,
+    byVideoIngressSource(),
+    publishingVideo,
+    publishingAudio,
+  ]);
 }
diff --git a/packages/stream_video/pubspec.yaml b/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: ^2.2.2
+  stream_webrtc_flutter: ^2.2.3
   synchronized: ^3.1.0
   system_info2: ^4.0.0
   tart: ^0.6.0
diff --git a/packages/stream_video_filters/pubspec.yaml b/packages/stream_video_filters/pubspec.yaml
@@ -15,7 +15,7 @@ dependencies:
     sdk: flutter
   plugin_platform_interface: ^2.0.2
   stream_video: ^1.2.0
-  stream_webrtc_flutter: ^2.2.2
+  stream_webrtc_flutter: ^2.2.3
 
 dev_dependencies:
   flutter_lints: ^6.0.0
diff --git a/packages/stream_video_flutter/CHANGELOG.md b/packages/stream_video_flutter/CHANGELOG.md
@@ -1,6 +1,13 @@
 ## Upcoming
 
-🐞 Fixed
+### ✅ Added
+* Added default sorting preset for Picture-in-Picture mode to prioritize the most relevant participant.
+
+### 🐞 Fixed
+* [Android] Fixed screen share notification tap not opening the app.
+* [Android] Improved screen sharing foreground service reliability:
+  - Added proper synchronization to ensure the foreground service is fully started before initiating media projection.
+  - `startScreenSharingNotificationService` now returns a boolean indicating success/failure, preventing screen share attempts when the service fails to start.
 * [iOS/macOS] Fixed crash when VoIP push is received before Flutter fully initializes from the terminated state.
 
 ## 1.2.0
diff --git a/packages/stream_video_flutter/android/build.gradle b/packages/stream_video_flutter/android/build.gradle
@@ -34,6 +34,7 @@ android {
 
     defaultConfig {
         minSdkVersion 19
+        consumerProguardFiles 'consumer-rules.pro'
     }
 
     dependencies {
diff --git a/packages/stream_video_flutter/android/consumer-rules.pro b/packages/stream_video_flutter/android/consumer-rules.pro
@@ -0,0 +1,13 @@
+-keepclassmembers class * implements android.os.Parcelable {
+    public static final ** CREATOR;
+}
+
+# Keep the specific notification payload classes
+-keep class io.getstream.video.flutter.stream_video_flutter.service.notification.NotificationPayload { *; }
+-keep class io.getstream.video.flutter.stream_video_flutter.service.notification.NotificationOptions { *; }
+-keep class io.getstream.video.flutter.stream_video_flutter.service.notification.NotificationContent { *; }
+-keep class io.getstream.video.flutter.stream_video_flutter.service.notification.NotificationAvatar { *; }
+
+# Keep all classes that use @Parcelize annotation
+-keep @kotlinx.parcelize.Parcelize class * { *; }
+
diff --git a/packages/stream_video_flutter/android/src/main/kotlin/io/getstream/video/flutter/stream_video_flutter/service/ServiceManager.kt b/packages/stream_video_flutter/android/src/main/kotlin/io/getstream/video/flutter/stream_video_flutter/service/ServiceManager.kt
@@ -33,8 +33,13 @@ class ServiceManagerImpl(
         val serviceKey = "$callCid-$type"
         
         if (activeServices.containsKey(serviceKey)) {
-            logger.w { "[start] Service for callCid: $callCid, type: $type already running." }
-            return true
+            if (type == ServiceType.screenSharing && !StreamScreenShareService.isServiceRunning(callCid)) {
+                logger.w { "[start] Service for callCid: $callCid was in activeServices but not in foreground mode. Retrying." }
+                activeServices.remove(serviceKey)
+            } else {
+                logger.w { "[start] Service for callCid: $callCid, type: $type already running." }
+                return true
+            }
         }
         try {
             val nIntent = when(type){
@@ -176,7 +181,14 @@ class ServiceManagerImpl(
         }
         
         val serviceKey = "$actualCallCid-$type"
-        val running = activeServices.containsKey(serviceKey)
+        val inActiveServices = activeServices.containsKey(serviceKey)
+        
+        val running = if (type == ServiceType.screenSharing) {
+            inActiveServices && StreamScreenShareService.isServiceRunning(actualCallCid)
+        } else {
+            inActiveServices
+        }
+        
         logger.d { "[isRunning] callCid: $actualCallCid, type: $type. Result: $running" }
         return running
     }
diff --git a/packages/stream_video_flutter/android/src/main/kotlin/io/getstream/video/flutter/stream_video_flutter/service/StreamCallService.kt b/packages/stream_video_flutter/android/src/main/kotlin/io/getstream/video/flutter/stream_video_flutter/service/StreamCallService.kt
@@ -10,6 +10,7 @@ import android.content.pm.ServiceInfo
 import android.os.Build
 import android.os.IBinder
 import androidx.core.content.ContextCompat
+import androidx.core.content.IntentCompat
 import io.getstream.log.taggedLogger
 import io.getstream.video.flutter.stream_video_flutter.service.notification.NotificationPayload
 import io.getstream.video.flutter.stream_video_flutter.service.notification.StreamNotificationBuilder
@@ -177,14 +178,11 @@ open class StreamCallService : Service() {
     }
 
     private fun getPayloadFromIntent(intent: Intent): NotificationPayload? {
-        @Suppress("DEPRECATION")
-        val payload = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
-            intent.getParcelableExtra("notificationPayload", NotificationPayload::class.java)
-        } else {
-            intent.getParcelableExtra("notificationPayload")
-        }
-
-        return payload
+        return IntentCompat.getParcelableExtra(
+            intent,
+            "notificationPayload",
+            NotificationPayload::class.java
+        )
     }
 
     private fun startNewCall(callCid: String, payload: NotificationPayload, startId: Int) {
diff --git a/packages/stream_video_flutter/android/src/main/kotlin/io/getstream/video/flutter/stream_video_flutter/service/StreamScreenShareService.kt b/packages/stream_video_flutter/android/src/main/kotlin/io/getstream/video/flutter/stream_video_flutter/service/StreamScreenShareService.kt
@@ -4,8 +4,8 @@ import android.app.NotificationManager
 import android.app.Service
 import android.content.Context
 import android.content.Intent
-import android.os.Build
 import android.os.IBinder
+import androidx.core.content.IntentCompat
 import io.getstream.log.taggedLogger
 import io.getstream.video.flutter.stream_video_flutter.R
 import io.getstream.video.flutter.stream_video_flutter.service.notification.NotificationPayload
@@ -107,12 +107,11 @@ internal class StreamScreenShareService : Service() {
     }
 
     private fun getPayloadFromIntent(intent: Intent): NotificationPayload? {
-        @Suppress("DEPRECATION")
-        return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
-            intent.getParcelableExtra("notificationPayload", NotificationPayload::class.java)
-        } else {
-            intent.getParcelableExtra("notificationPayload")
-        }
+        return IntentCompat.getParcelableExtra(
+            intent,
+            "notificationPayload",
+            NotificationPayload::class.java
+        )
     }
 
     private fun startNewScreenShare(callCid: String, payload: NotificationPayload, startId: Int) {
@@ -132,12 +131,15 @@ internal class StreamScreenShareService : Service() {
         if (activeScreenShares.size == 1) {
             try {
                 super.startForeground(notificationId, notification)
+                markServiceAsStarted(callCid)
                 logger.i { "[startNewScreenShare] Service started in foreground for screen share (callCid: $callCid), notificationId: $notificationId" }
             } catch (e: Exception) {
                 logger.e(e) { "[startNewScreenShare] Exception starting foreground for screen share $callCid. Error: ${e.message}" }
                 activeScreenShares.remove(callCid)
             }
         } else {
+            // Service is already in foreground, just mark this callCid as ready
+            markServiceAsStarted(callCid)
             notificationManager.notify(notificationId, notification)
             logger.i { "[startNewScreenShare] Additional screen share notification for callCid: $callCid, notificationId: $notificationId" }
         }
@@ -156,6 +158,7 @@ internal class StreamScreenShareService : Service() {
         logger.i { "[stopScreenShare] Attempting to stop screen share for callCid: $callCid. Active shares: ${activeScreenShares.size}" }
         val screenShareData = activeScreenShares.remove(callCid)
         if (screenShareData != null) {
+            markServiceAsStopped(callCid)
             notificationManager.cancel(screenShareData.notificationId)
             logger.i { "[stopScreenShare] Cancelled notification and removed screen share for callCid: $callCid. Remaining: ${activeScreenShares.size}" }
         } else {
@@ -174,6 +177,7 @@ internal class StreamScreenShareService : Service() {
         super.onDestroy()
         logger.i { "[onDestroy] Service destroying. Clearing ${activeScreenShares.size} screen shares and notifications." }
         activeScreenShares.values.forEach { data ->
+            markServiceAsStopped(data.callCid)
             notificationManager.cancel(data.notificationId)
         }
         activeScreenShares.clear()
@@ -202,5 +206,22 @@ internal class StreamScreenShareService : Service() {
         internal const val ACTION_UPDATE = "UPDATE"
         internal const val ACTION_STOP_SPECIFIC_CALL = "STOP_SPECIFIC_CALL"
         internal const val TRIGGER_SHARE_SCREEN = "SHARE_SCREEN"
+        
+        private val startedServicesCallCids = mutableSetOf<String>()
+        
+        @Synchronized
+        internal fun isServiceRunning(callCid: String): Boolean {
+            return startedServicesCallCids.contains(callCid)
+        }
+        
+        @Synchronized
+        private fun markServiceAsStarted(callCid: String) {
+            startedServicesCallCids.add(callCid)
+        }
+        
+        @Synchronized
+        private fun markServiceAsStopped(callCid: String) {
+            startedServicesCallCids.remove(callCid)
+        }
     }
 }
diff --git a/packages/stream_video_flutter/android/src/main/kotlin/io/getstream/video/flutter/stream_video_flutter/service/notification/StreamNotificationBuilderImpl.kt b/packages/stream_video_flutter/android/src/main/kotlin/io/getstream/video/flutter/stream_video_flutter/service/notification/StreamNotificationBuilderImpl.kt
@@ -97,21 +97,13 @@ internal class StreamNotificationBuilderImpl(
             PendingIntent.FLAG_UPDATE_CURRENT
         }
 
-        val contentIntent = if(type == ServiceType.call) {
-            PendingIntent.getActivity(
-                    context,
-                    0,
-                    intent,
-                    flags,
-            )
-        } else {
-            PendingIntent.getBroadcast(
-                    context,
-                    0,
-                    intent,
-                    PendingIntent.FLAG_IMMUTABLE,
-            )
-        }
+        // Both call and screen share notifications should open the app when tapped
+        val contentIntent = PendingIntent.getActivity(
+            context,
+            0,
+            intent,
+            flags,
+        )
 
         val channelId = getNotificationChannelId()
 
diff --git a/packages/stream_video_flutter/example/pubspec.yaml b/packages/stream_video_flutter/example/pubspec.yaml
@@ -31,7 +31,7 @@ dependencies:
   stream_video: ^1.2.0
   stream_video_flutter: ^1.2.0
   stream_video_push_notification: ^1.2.0
-  stream_webrtc_flutter: ^2.2.2
+  stream_webrtc_flutter: ^2.2.3
 
 dependency_overrides:
   stream_video:
diff --git a/packages/stream_video_flutter/lib/src/call_background/background_service.dart b/packages/stream_video_flutter/lib/src/call_background/background_service.dart
@@ -317,8 +317,9 @@ class StreamBackgroundService {
     }
   }
 
-  // Screen sharing methods
-  Future<void> startScreenSharingNotificationService(Call call) async {
+  /// Starts the screen sharing notification service.
+  /// Returns true if the service was started successfully, false otherwise.
+  Future<bool> startScreenSharingNotificationService(Call call) async {
     final callCid = call.callCid.value;
 
     _logger.d(
@@ -337,10 +338,68 @@ class StreamBackgroundService {
       options: options,
     );
 
-    await StreamVideoFlutterBackground.startService(
-      payload,
-      ServiceType.screenSharing,
+    try {
+      await StreamVideoFlutterBackground.startService(
+        payload,
+        ServiceType.screenSharing,
+      );
+    } catch (e) {
+      _logger.w(
+        () =>
+            '<$callCid> [startScreenSharingNotificationService] Failed to start screen sharing service $e.',
+      );
+
+      return false;
+    }
+
+    // Wait for the foreground service to be fully ready.
+    // Android requires FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION to be running
+    // before screen sharing can be started.
+    if (CurrentPlatform.isAndroid) {
+      final isReady = await _waitForScreenShareServiceReady(callCid);
+      if (!isReady) {
+        _logger.e(
+          () =>
+              '<$callCid> [startScreenSharingNotificationService] Service failed to start.',
+        );
+        return false;
+      }
+    }
+
+    return true;
+  }
+
+  /// Waits for the screen share service to be ready.
+  /// Returns true if ready, false if timeout.
+  Future<bool> _waitForScreenShareServiceReady(String callCid) async {
+    const timeout = Duration(seconds: 3);
+    const interval = Duration(milliseconds: 50);
+    final stopwatch = Stopwatch()..start();
+
+    while (stopwatch.elapsed < timeout) {
+      final isRunning = await StreamVideoFlutterBackground.isServiceRunning(
+        ServiceType.screenSharing,
+        callCid: callCid,
+      );
+
+      if (isRunning) {
+        _logger.d(
+          () =>
+              '<$callCid> [_waitForScreenShareServiceReady] Screen sharing service ready after ${stopwatch.elapsedMilliseconds}ms',
+        );
+
+        return true;
+      }
+
+      await Future<void>.delayed(interval);
+    }
+
+    _logger.w(
+      () =>
+          '<$callCid> [_waitForScreenShareServiceReady] Timeout waiting for service to be ready',
     );
+
+    return false;
   }
 
   Future<void> stopScreenSharingNotificationService(String callCid) async {
diff --git a/packages/stream_video_flutter/lib/src/call_controls/controls/toggle_screen_sharing_option.dart b/packages/stream_video_flutter/lib/src/call_controls/controls/toggle_screen_sharing_option.dart
@@ -91,8 +91,12 @@ class ToggleScreenShareOption extends StatelessWidget {
               return;
             }
 
-            await StreamBackgroundService()
+            final serviceStarted = await StreamBackgroundService()
                 .startScreenSharingNotificationService(call);
+
+            if (!serviceStarted) {
+              return;
+            }
           } else {
             await StreamBackgroundService()
                 .stopScreenSharingNotificationService(
diff --git a/packages/stream_video_flutter/lib/src/call_screen/call_content/picture_in_picture/android_pip_overlay.dart b/packages/stream_video_flutter/lib/src/call_screen/call_content/picture_in_picture/android_pip_overlay.dart
@@ -46,7 +46,9 @@ class _AndroidPipOverlayState extends State<AndroidPipOverlay>
 
   @override
   Sort<CallParticipantState>? get participantSort =>
-      widget.pictureInPictureConfiguration?.sort ?? widget.sort;
+      widget.pictureInPictureConfiguration?.sort ??
+      widget.sort ??
+      CallParticipantSortingPresets.pictureInPicture;
 
   @override
   void initState() {
diff --git a/packages/stream_video_flutter/lib/src/call_screen/call_content/picture_in_picture/stream_picture_in_picture_ui_kit_view.dart b/packages/stream_video_flutter/lib/src/call_screen/call_content/picture_in_picture/stream_picture_in_picture_ui_kit_view.dart
@@ -93,7 +93,7 @@ class _StreamPictureInPictureUiKitViewState
       compare:
           widget.pictureInPictureConfiguration?.sort ??
           widget.participantSort ??
-          CallParticipantSortingPresets.speaker,
+          CallParticipantSortingPresets.pictureInPicture,
     );
 
     if (sorted.isNotEmpty) {
diff --git a/packages/stream_video_flutter/pubspec.yaml b/packages/stream_video_flutter/pubspec.yaml
@@ -25,7 +25,7 @@ dependencies:
   rate_limiter: ^1.0.0
   rxdart: ^0.28.0
   stream_video: ^1.2.0
-  stream_webrtc_flutter: ^2.2.2
+  stream_webrtc_flutter: ^2.2.3
   visibility_detector: ^0.4.0+2
 
 dev_dependencies:
diff --git a/packages/stream_video_noise_cancellation/pubspec.yaml b/packages/stream_video_noise_cancellation/pubspec.yaml
@@ -15,7 +15,7 @@ dependencies:
     sdk: flutter
   plugin_platform_interface: ^2.0.2
   stream_video: ^1.2.0
-  stream_webrtc_flutter: ^2.2.2
+  stream_webrtc_flutter: ^2.2.3
 
 dev_dependencies:
   flutter_lints: ^6.0.0
diff --git a/packages/stream_video_push_notification/pubspec.yaml b/packages/stream_video_push_notification/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ android {`
`34`	`34`
`35`	`35`	`defaultConfig {`
`36`	`36`	`minSdkVersion 19`
	`37`	`+ consumerProguardFiles 'consumer-rules.pro'`
`37`	`38`	`}`
`38`	`39`
`39`	`40`	`dependencies {`