fix(llc): Improved participant sorting based on source type (#1073)

* Improved participant sorting based on source type

* changelog

Author: Brazol

packages/stream_video/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Unreleased
+
+🔄 Changed
+- The `byParticipantSource` participant sorting now accepts a list of sources. The default sorting for `speaker` and `livestream` presets now include other ingress sources.
+
 ## 0.11.0
 
 🚧 Build breaking changes

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

@@ -2762,7 +2762,7 @@ class Call {
     AudioConstraints? constraints,
   }) async {
     if (enabled && !hasPermission(CallPermission.sendAudio)) {
-      return Result.error('Missing permission to send video');
+      return Result.error('Missing permission to send audio');
     }
 
     if (enabled && CurrentPlatform.isAndroid) {

packages/stream_video/lib/src/sorting/call_participant_sorting_presets.dart

@@ -21,6 +21,7 @@ mixin CallParticipantSortingPresets {
     dominantSpeaker,
     ifInvisibleBy(speaking),
     ifInvisibleBy(byReactionType('raised-hand')),
+    ifInvisibleBy(byVideoIngressSource()),
     ifInvisibleBy(publishingVideo),
     ifInvisibleBy(publishingAudio),
   ]);
@@ -31,7 +32,7 @@ mixin CallParticipantSortingPresets {
       ifInvisibleBy(dominantSpeaker),
       ifInvisibleBy(speaking),
       ifInvisibleBy(byReactionType('raised-hand')),
-      ifInvisibleBy(byParticipantSource(SfuParticipantSource.rtmp)),
+      ifInvisibleBy(byVideoIngressSource()),
       ifInvisibleBy(publishingVideo),
       ifInvisibleBy(publishingAudio),
       byRole(['admin', 'host', 'speaker']),

packages/stream_video/lib/src/sorting/call_participant_state_sorting.dart

@@ -55,23 +55,35 @@ int pinned(CallParticipantState a, CallParticipantState b) {
 }
 
 /// A comparator factory which creates a comparator which prioritizes
-/// participants who are from a specific source (e.g., WebRTC, RTMP, WHIP...).
+/// participants who are from a specific sources (e.g., WebRTC, RTMP, WHIP...).
 Comparator<CallParticipantState> byParticipantSource(
-  SfuParticipantSource source,
+  List<SfuParticipantSource> sources,
 ) {
-  return (CallParticipantState a, CallParticipantState b) {
-    if (a.participantSource == source && b.participantSource != source) {
-      return -1;
-    }
+  double sourcePriority(SfuParticipantSource? source) {
+    if (source == null) return double.maxFinite;
 
-    if (a.participantSource != source && b.participantSource == source) {
-      return 1;
-    }
+    final index = sources.indexOf(source);
+    return index == -1 ? double.maxFinite : index.toDouble();
+  }
 
+  return (CallParticipantState a, CallParticipantState b) {
+    final priorityA = sourcePriority(a.participantSource);
+    final priorityB = sourcePriority(b.participantSource);
+    if (priorityA < priorityB) return -1;
+    if (priorityA > priorityB) return 1;
     return 0;
   };
 }
 
+Comparator<CallParticipantState> byVideoIngressSource() {
+  return byParticipantSource([
+    SfuParticipantSource.rtmp,
+    SfuParticipantSource.srt,
+    SfuParticipantSource.whip,
+    SfuParticipantSource.rtsp,
+  ]);
+}
+
 /// A comparator creator which will set up a comparator which prioritizes
 /// participants who have a specific reaction.
 Comparator<CallParticipantState> byReactionType(String type) {

packages/stream_video/test/src/call/call_participant_state_sorting_test.dart

@@ -15,9 +15,12 @@ import 'package:stream_video/src/sorting/call_participant_state_sorting.dart';
 
 void main() {
   group('sorting comparators', () {
-    test('byParticipantSource prioritizes requested source', () {
+    test('byParticipantSource prioritizes requested sources', () {
       final comparator = combineComparators<CallParticipantState>([
-        byParticipantSource(SfuParticipantSource.rtmp),
+        byParticipantSource([
+          SfuParticipantSource.rtmp,
+          SfuParticipantSource.sip,
+        ]),
         byName,
       ]);
 
@@ -63,7 +66,7 @@ void main() {
 
       final list = [user1, user3, user4, user2]..sort(comparator);
       expect(list.first, user2);
-      expect(list.map((p) => p.name), ['user2', 'user3', 'user1', 'user4']);
+      expect(list.map((p) => p.name), ['user2', 'user3', 'user4', 'user1']);
     });
 
     test('byReactionType prioritizes given reaction type', () {