refactor: BREAKING merge onGroupCallState and onGroupCallEvent into matrixRTCEventStream with proper types

Author: coder-with-a-bushido

lib/src/voip/backend/mesh_backend.dart

@@ -133,7 +133,7 @@ class MeshBackend extends CallBackend {
   Future<void> _addCall(GroupCallSession groupCall, CallSession call) async {
     _callSessions.add(call);
     _initCall(groupCall, call);
-    groupCall.onGroupCallEvent.add(GroupCallStateChange.callsChanged);
+    groupCall.matrixRTCEventStream.add(GroupCallAddedEvent());
   }
 
   /// init a peer call from group calls.
@@ -183,7 +183,7 @@ class MeshBackend extends CallBackend {
     _registerListenersBeforeCallAdd(replacementCall);
     _initCall(groupCall, replacementCall);
 
-    groupCall.onGroupCallEvent.add(GroupCallStateChange.callsChanged);
+    groupCall.matrixRTCEventStream.add(GroupCallReplacedEvent());
   }
 
   /// Removes a peer call from group calls.
@@ -196,7 +196,7 @@ class MeshBackend extends CallBackend {
 
     _callSessions.removeWhere((element) => call.callId == element.callId);
 
-    groupCall.onGroupCallEvent.add(GroupCallStateChange.callsChanged);
+    groupCall.matrixRTCEventStream.add(GroupCallRemovedEvent());
   }
 
   Future<void> _disposeCall(
@@ -375,7 +375,7 @@ class MeshBackend extends CallBackend {
 
     if (nextActiveSpeaker != null && _activeSpeaker != nextActiveSpeaker) {
       _activeSpeaker = nextActiveSpeaker;
-      groupCall.onGroupCallEvent.add(GroupCallStateChange.activeSpeakerChanged);
+      groupCall.matrixRTCEventStream.add(GroupCallActiveSpeakerChanged());
     }
     _activeSpeakerLoopTimeout?.cancel();
     _activeSpeakerLoopTimeout = Timer(
@@ -401,8 +401,8 @@ class MeshBackend extends CallBackend {
   ) {
     _screenshareStreams.add(stream);
     onStreamAdd.add(stream);
-    groupCall.onGroupCallEvent
-        .add(GroupCallStateChange.screenshareStreamsChanged);
+    groupCall.matrixRTCEventStream
+        .add(GroupCallScreenShareStreamsChanged(GroupCallStreamsChange.added));
   }
 
   Future<void> _replaceScreenshareStream(
@@ -423,8 +423,9 @@ class MeshBackend extends CallBackend {
     _screenshareStreams.replaceRange(streamIndex, 1, [replacementStream]);
 
     await existingStream.dispose();
-    groupCall.onGroupCallEvent
-        .add(GroupCallStateChange.screenshareStreamsChanged);
+    groupCall.matrixRTCEventStream.add(
+      GroupCallScreenShareStreamsChanged(GroupCallStreamsChange.replaced),
+    );
   }
 
   Future<void> _removeScreenshareStream(
@@ -450,8 +451,9 @@ class MeshBackend extends CallBackend {
       await stopMediaStream(stream.stream);
     }
 
-    groupCall.onGroupCallEvent
-        .add(GroupCallStateChange.screenshareStreamsChanged);
+    groupCall.matrixRTCEventStream.add(
+      GroupCallScreenShareStreamsChanged(GroupCallStreamsChange.removed),
+    );
   }
 
   Future<void> _onCallStateChanged(CallSession call, CallState state) async {
@@ -486,8 +488,8 @@ class MeshBackend extends CallBackend {
   ) async {
     _userMediaStreams.add(stream);
     onStreamAdd.add(stream);
-    groupCall.onGroupCallEvent
-        .add(GroupCallStateChange.userMediaStreamsChanged);
+    groupCall.matrixRTCEventStream
+        .add(GroupCallUserMediaStreamsChanged(GroupCallStreamsChange.added));
   }
 
   Future<void> _replaceUserMediaStream(
@@ -508,8 +510,8 @@ class MeshBackend extends CallBackend {
     _userMediaStreams.replaceRange(streamIndex, 1, [replacementStream]);
 
     await existingStream.dispose();
-    groupCall.onGroupCallEvent
-        .add(GroupCallStateChange.userMediaStreamsChanged);
+    groupCall.matrixRTCEventStream
+        .add(GroupCallUserMediaStreamsChanged(GroupCallStreamsChange.replaced));
   }
 
   Future<void> _removeUserMediaStream(
@@ -536,12 +538,12 @@ class MeshBackend extends CallBackend {
       await stopMediaStream(stream.stream);
     }
 
-    groupCall.onGroupCallEvent
-        .add(GroupCallStateChange.userMediaStreamsChanged);
+    groupCall.matrixRTCEventStream
+        .add(GroupCallUserMediaStreamsChanged(GroupCallStreamsChange.removed));
 
     if (_activeSpeaker == stream.participant && _userMediaStreams.isNotEmpty) {
       _activeSpeaker = _userMediaStreams[0].participant;
-      groupCall.onGroupCallEvent.add(GroupCallStateChange.activeSpeakerChanged);
+      groupCall.matrixRTCEventStream.add(GroupCallActiveSpeakerChanged());
     }
   }
 
@@ -663,7 +665,7 @@ class MeshBackend extends CallBackend {
       }
     }
 
-    groupCall.onGroupCallEvent.add(GroupCallStateChange.localMuteStateChanged);
+    groupCall.matrixRTCEventStream.add(GroupCallLocalMutedChanged(muted, kind));
     return;
   }
 
@@ -799,8 +801,8 @@ class MeshBackend extends CallBackend {
 
         _addScreenshareStream(groupCall, localScreenshareStream!);
 
-        groupCall.onGroupCallEvent
-            .add(GroupCallStateChange.localScreenshareStateChanged);
+        groupCall.matrixRTCEventStream
+            .add(GroupCallLocalScreenshareStateChanged(true));
         for (final call in _callSessions) {
           await call.addLocalStream(
             await localScreenshareStream!.stream!.clone(),
@@ -813,7 +815,8 @@ class MeshBackend extends CallBackend {
         return;
       } catch (e, s) {
         Logs().e('[VOIP] Enabling screensharing error', e, s);
-        groupCall.onGroupCallEvent.add(GroupCallStateChange.error);
+        groupCall.matrixRTCEventStream
+            .add(GroupCallStateError(e.toString(), s));
         return;
       }
     } else {
@@ -826,8 +829,8 @@ class MeshBackend extends CallBackend {
 
       await groupCall.sendMemberStateEvent();
 
-      groupCall.onGroupCallEvent
-          .add(GroupCallStateChange.localMuteStateChanged);
+      groupCall.matrixRTCEventStream
+          .add(GroupCallLocalScreenshareStateChanged(false));
       return;
     }
   }

lib/src/voip/group_call_session.dart

@@ -51,12 +51,6 @@ class GroupCallSession {
 
   String groupCallId;
 
-  final CachedStreamController<GroupCallState> onGroupCallState =
-      CachedStreamController();
-
-  final CachedStreamController<GroupCallStateChange> onGroupCallEvent =
-      CachedStreamController();
-
   final CachedStreamController<MatrixRTCCallEvent> matrixRTCEventStream =
       CachedStreamController();
 
@@ -102,8 +96,7 @@ class GroupCallSession {
 
   void setState(GroupCallState newState) {
     state = newState;
-    onGroupCallState.add(newState);
-    onGroupCallEvent.add(GroupCallStateChange.groupCallStateChanged);
+    matrixRTCEventStream.add(GroupCallStateChanged(newState));
   }
 
   bool hasLocalParticipant() {
@@ -268,8 +261,6 @@ class GroupCallSession {
         matrixRTCEventStream
             .add(ParticipantsLeftEvent(participants: anyLeft.toList()));
       }
-
-      onGroupCallEvent.add(GroupCallStateChange.participantsChanged);
     }
   }
 }

lib/src/voip/models/matrixrtc_call_event.dart

@@ -5,16 +5,85 @@ import 'package:matrix/matrix.dart';
 /// often.
 sealed class MatrixRTCCallEvent {}
 
+/// Event type for participants change
 sealed class ParticipantsChangeEvent implements MatrixRTCCallEvent {}
 
 final class ParticipantsJoinEvent implements ParticipantsChangeEvent {
+  /// The participants who joined the call
   final List<CallParticipant> participants;
 
   ParticipantsJoinEvent({required this.participants});
 }
 
 final class ParticipantsLeftEvent implements ParticipantsChangeEvent {
+  /// The participants who left the call
   final List<CallParticipant> participants;
 
   ParticipantsLeftEvent({required this.participants});
 }
+
+/// Group call active speaker changed event
+final class GroupCallActiveSpeakerChanged implements MatrixRTCCallEvent {}
+
+/// Group calls changed event
+sealed class GroupCallsChanged implements MatrixRTCCallEvent {}
+
+final class GroupCallAddedEvent implements GroupCallsChanged {}
+
+final class GroupCallRemovedEvent implements GroupCallsChanged {}
+
+final class GroupCallReplacedEvent implements GroupCallsChanged {}
+
+enum GroupCallStreamsChange {
+  added,
+  removed,
+  replaced,
+}
+
+/// Group call user media streams changed event
+final class GroupCallUserMediaStreamsChanged implements MatrixRTCCallEvent {
+  final GroupCallStreamsChange change;
+  GroupCallUserMediaStreamsChanged(this.change);
+}
+
+/// Group call screen share streams changed event
+final class GroupCallScreenShareStreamsChanged implements MatrixRTCCallEvent {
+  final GroupCallStreamsChange change;
+  GroupCallScreenShareStreamsChanged(this.change);
+}
+
+/// Group call local screenshare state changed event
+final class GroupCallLocalScreenshareStateChanged
+    implements MatrixRTCCallEvent {
+  final bool screensharing;
+  GroupCallLocalScreenshareStateChanged(this.screensharing);
+}
+
+/// Group call local muted changed event
+final class GroupCallLocalMutedChanged implements MatrixRTCCallEvent {
+  final bool muted;
+  final MediaInputKind kind;
+  GroupCallLocalMutedChanged(this.muted, this.kind);
+}
+
+enum GroupCallState {
+  localCallFeedUninitialized,
+  initializingLocalCallFeed,
+  localCallFeedInitialized,
+  entering,
+  entered,
+  ended
+}
+
+/// Group call state changed event
+final class GroupCallStateChanged implements MatrixRTCCallEvent {
+  final GroupCallState state;
+  GroupCallStateChanged(this.state);
+}
+
+/// Group call error event
+final class GroupCallStateError implements MatrixRTCCallEvent {
+  final String msg;
+  final dynamic err;
+  GroupCallStateError(this.msg, this.err);
+}

lib/src/voip/utils/types.dart

@@ -164,24 +164,3 @@ class GroupCallError extends Error {
     return 'Group Call Error: [$code] $msg, err: ${err.toString()}';
   }
 }
-
-enum GroupCallStateChange {
-  groupCallStateChanged,
-  activeSpeakerChanged,
-  callsChanged,
-  userMediaStreamsChanged,
-  screenshareStreamsChanged,
-  localScreenshareStateChanged,
-  localMuteStateChanged,
-  participantsChanged,
-  error
-}
-
-enum GroupCallState {
-  localCallFeedUninitialized,
-  initializingLocalCallFeed,
-  localCallFeedInitialized,
-  entering,
-  entered,
-  ended
-}