feat: Add audioLevels and activeSpeakers (#882)

* feat: Add audioLevels and activeSpeakers

* doc improvement

Co-authored-by: Maciej Brażewicz <[email protected]>

* Move logic to separate copyWith method

---------

Co-authored-by: Maciej Brażewicz <[email protected]>

Author: renefloor

packages/stream_video/CHANGELOG.md

@@ -1,3 +1,9 @@
+## unreleased
+
+✅ Added
+* Added `CallParticipantState.audioLevels` with the 10 last audio levels of the participant.
+* Added `CallState.activeSpeakers` to get list of currently active speakers.
+
 ## 0.8.2
 
 ✅ Added 

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

@@ -106,7 +106,7 @@ mixin StateSfuMixin on StateNotifier<CallState> {
               level.sessionId == participant.sessionId;
         });
         if (levelInfo != null) {
-          return participant.copyWith(
+          return participant.copyWithUpdatedAudioLevels(
             audioLevel: levelInfo.level,
             isSpeaking: levelInfo.isSpeaking,
           );
@@ -207,17 +207,18 @@ mixin StateSfuMixin on StateNotifier<CallState> {
     final participants = state.callParticipants.map((it) {
       if (it.userId == participant.userId &&
           it.sessionId == participant.sessionId) {
-        return it.copyWith(
-          name: participant.userName,
-          custom: participant.custom,
-          image: participant.userImage,
-          trackIdPrefix: participant.trackLookupPrefix,
-          audioLevel: participant.audioLevel,
-          isSpeaking: participant.isSpeaking,
-          isDominantSpeaker: participant.isDominantSpeaker,
-          connectionQuality: participant.connectionQuality,
-          roles: participant.roles,
-        );
+        return it
+            .copyWith(
+              name: participant.userName,
+              custom: participant.custom,
+              image: participant.userImage,
+              trackIdPrefix: participant.trackLookupPrefix,
+              isSpeaking: participant.isSpeaking,
+              isDominantSpeaker: participant.isDominantSpeaker,
+              connectionQuality: participant.connectionQuality,
+              roles: participant.roles,
+            )
+            .copyWithUpdatedAudioLevels(audioLevel: participant.audioLevel);
       } else {
         return it;
       }

packages/stream_video/lib/src/call_state.dart

@@ -141,6 +141,10 @@ class CallState extends Equatable {
     return callParticipants.where((element) => !element.isLocal).toList();
   }
 
+  List<CallParticipantState> get activeSpeakers {
+    return callParticipants.where((element) => element.isSpeaking).toList();
+  }
+
   /// Returns a copy of this [CallState] with the given fields replaced
   /// with the new values.
   CallState copyWith({

packages/stream_video/lib/src/models/call_participant_state.dart

@@ -14,7 +14,7 @@ import 'viewport_visibility.dart';
 class CallParticipantState
     with EquatableMixin
     implements Comparable<CallParticipantState> {
-  const CallParticipantState({
+  CallParticipantState({
     required this.userId,
     required this.roles,
     required this.name,
@@ -27,12 +27,13 @@ class CallParticipantState
     this.connectionQuality = SfuConnectionQuality.unspecified,
     this.isOnline = false,
     this.audioLevel = 0,
+    List<double>? audioLevels,
     this.isSpeaking = false,
     this.isDominantSpeaker = false,
     this.isPinned = false,
     this.reaction,
     this.viewportVisibility = ViewportVisibility.unknown,
-  });
+  }) : audioLevels = audioLevels ?? [audioLevel];
 
   final String userId;
   final List<String> roles;
@@ -45,7 +46,13 @@ class CallParticipantState
   final bool isLocal;
   final SfuConnectionQuality connectionQuality;
   final bool isOnline;
+
+  /// The latest audio level for the user.
   final double audioLevel;
+
+  /// List of the last 10 audio levels.
+  final List<double> audioLevels;
+
   final bool isSpeaking;
   final bool isDominantSpeaker;
   final bool isPinned;
@@ -54,6 +61,8 @@ class CallParticipantState
 
   /// Returns a copy of this [CallParticipantState] with the given fields
   /// replaced with the new values.
+  ///
+  /// If you want to update the audioLevel, consider using [copyWithUpdatedAudioLevels].
   CallParticipantState copyWith({
     String? userId,
     List<String>? roles,
@@ -67,6 +76,7 @@ class CallParticipantState
     SfuConnectionQuality? connectionQuality,
     bool? isOnline,
     double? audioLevel,
+    List<double>? audioLevels,
     bool? isSpeaking,
     bool? isDominantSpeaker,
     bool? isPinned,
@@ -86,6 +96,7 @@ class CallParticipantState
       connectionQuality: connectionQuality ?? this.connectionQuality,
       isOnline: isOnline ?? this.isOnline,
       audioLevel: audioLevel ?? this.audioLevel,
+      audioLevels: audioLevels ?? this.audioLevels,
       isSpeaking: isSpeaking ?? this.isSpeaking,
       isDominantSpeaker: isDominantSpeaker ?? this.isDominantSpeaker,
       isPinned: isPinned ?? this.isPinned,
@@ -94,6 +105,24 @@ class CallParticipantState
     );
   }
 
+  /// Copies the current state and adds the latest [audioLevel] to the last 10 [audioLevels].
+  CallParticipantState copyWithUpdatedAudioLevels({
+    required double audioLevel,
+    bool? isSpeaking,
+  }) {
+    final levels = audioLevels;
+    levels.add(audioLevel);
+    while (levels.length > 10) {
+      levels.removeAt(0);
+    }
+
+    return copyWith(
+      audioLevel: audioLevel,
+      audioLevels: audioLevels,
+      isSpeaking: isSpeaking,
+    );
+  }
+
   /// Compares two participants.
   ///
   /// The comparison is based on the [CallParticipantSortingPresets.regular].
@@ -119,7 +148,7 @@ class CallParticipantState
         'publishedTracks: $publishedTracks, '
         'isLocal: $isLocal, '
         'connectionQuality: $connectionQuality, isOnline: $isOnline, '
-        'audioLevel: $audioLevel, isSpeaking: $isSpeaking, '
+        'audioLevel: $audioLevel, audioLevels: $audioLevels, isSpeaking: $isSpeaking, '
         'isDominantSpeaker: $isDominantSpeaker, isPinned: $isPinned, '
         'reaction: $reaction, viewportVisibility: $viewportVisibility}';
   }
@@ -138,6 +167,7 @@ class CallParticipantState
         connectionQuality,
         isOnline,
         audioLevel,
+        audioLevels,
         isSpeaking,
         isDominantSpeaker,
         isPinned,

packages/stream_video/test/call_participant_state_sorting_test.dart

@@ -51,7 +51,7 @@ void main() {
     ),
 
     // Muted
-    const CallParticipantState(
+    CallParticipantState(
       name: 'C',
       userId: '3',
       sessionId: '3',