feat(llc): Added participants count in CallState (#790)

Author: Brazol

dogfooding/lib/widgets/call_duration_title.dart

@@ -27,7 +27,7 @@ class _CallDurationTitleState extends State<CallDurationTitle> {
   void initState() {
     super.initState();
 
-    widget.call.get().then((value) {
+    widget.call.get(watch: false).then((value) {
       _startedAt = value.foldOrNull(
               success: (callData) =>
                   callData.data.metadata.session.startedAt ?? DateTime.now()) ??

packages/stream_video/CHANGELOG.md

@@ -1,3 +1,29 @@
+## Unreleased
+
+This release introduces a major rework of the join/reconnect flow in the Call class to support Reconnect V2, enhancing reconnection handling across various scenarios. Most updates are within the internals of the Call class, though some changes are outward-facing, including a few breaking changes.
+
+🔄 Changed
+* `Call.reject()` method will now always call `Call.leave()` method internally.
+
+🚧 Breaking changes
+* Removed the deprecated `Call.joinLobby()` method.
+* The `maxDuration` and `maxParticipants` parameters of `Call.getOrCreate()` are now combined into the `StreamLimitsSettings? limits` parameter.
+
+🔄 Dependency updates
+* Updated Firebase dependencies to resolve Xcode 16 build issues.
+
+✅ Added
+* Added the `registerPushDevice` optional parameter (default is `true`) to the `StreamVideo.connect()` method,allowing the prevention of automatic push token registration.
+* Added `participantCount` and `anonymousParticipantCount` to `CallState` reflecting the current number of participants in the call.
+* Introduced the `watch` parameter to `Call.get()` and `Call.getOrCreate()` methods (default is `true`). When set to `true`, this enables the `Call` to listen for coordinator events and update its state accordingly, even before the call is joined (`Call.join()`).
+* Added support for `targetResolution` setting set on the Dashboard to determine the max resolution the video stream.
+
+🐞 Fixed
+* Automatic push token registration by `StreamVideo` now stores registered token in `SharedPreferences`, performing an API call only when the token changes.
+* Fixed premature ringing termination issues.
+* Resolved issues where ringing would not end when the caller terminates the call in an app-terminated state.
+* Fixed issue with call not ending in some cases when only one participant is left and `dropIfAloneInRingingFlow` is set to `true`.
+
 ## 0.5.5
 
 🐞 Fixed

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

@@ -255,6 +255,9 @@ class Call {
     return _connectOptionsOverride ?? _connectOptions;
   }
 
+  /// It is better to pass the [connectOptions] to [join] method,
+  /// setting it directly has to be done carefully. Depending on the moment in the call lifecycle,
+  /// it might be overwritten by default configuration or it might be too late to apply the changes.
   set connectOptions(CallConnectOptions connectOptions) {
     if (state.value.status is CallStatusConnected) {
       _logger.w(
@@ -296,6 +299,7 @@ class Call {
   }
 
   void _observeEvents() {
+    _subscriptions.cancel(_idCoordEvents);
     _subscriptions.add(
       _idCoordEvents,
       _coordinatorClient.events.on<CoordinatorCallEvent>((event) async {
@@ -312,7 +316,7 @@ class Call {
         (status) {
           if (status == InternetStatus.disconnected) {
             _logger.d(() => '[observeReconnectEvents] network disconnected');
-            _awaitNetworkAvailableFuture = awaitNetworkAvailable();
+            _awaitNetworkAvailableFuture = _awaitNetworkAvailable();
             _reconnect(SfuReconnectionStrategy.fast);
           }
         },
@@ -412,11 +416,22 @@ class Call {
           }),
         );
         return _stateManager.coordinatorCallReaction(event);
+      case CoordinatorCallSessionParticipantCountUpdatedEvent _:
+        if (state.value.status.isConnected || state.value.status.isJoined) {
+          return;
+        }
+
+        return _stateManager.setParticipantsCount(
+          totalCount:
+              event.participantsCountByRole.values.fold(0, (a, b) => a + b),
+          anonymousCount: event.anonymousParticipantCount,
+        );
       default:
         break;
     }
   }
 
+  /// Accepts the incoming call.
   Future<Result<None>> accept() async {
     final state = this.state.value;
     _logger.i(() => '[accept] state: $state');
@@ -451,6 +466,7 @@ class Call {
     return result;
   }
 
+  /// Rejects the incoming call.
   Future<Result<None>> reject({CallRejectReason? reason}) async {
     final state = this.state.value;
     _logger.i(() => '[reject] state: $state');
@@ -473,6 +489,7 @@ class Call {
     return result;
   }
 
+  /// Ends the call for all participants.
   Future<Result<None>> end() async {
     final state = this.state.value;
     _logger.d(() => '[end] status: ${state.status}');
@@ -492,6 +509,9 @@ class Call {
     return result;
   }
 
+  /// Joins the call.
+  ///
+  /// - [connectOptions]: optional initial call configuration
   Future<Result<None>> join({
     CallConnectOptions? connectOptions,
   }) async {
@@ -744,8 +764,6 @@ class Call {
     return Result.success(credentials);
   }
 
-  /// Allows you to create a new call with the given parameters
-  /// and joins the call immediately.
   Future<Result<CallJoinedData>> _performJoinCallRequest({
     bool create = false,
     bool video = false,
@@ -865,7 +883,7 @@ class Call {
       _idSessionStats,
       session.stats.listen((stats) {
         _stats.emit(stats);
-        processStats(stats);
+        _processStats(stats);
       }),
     );
 
@@ -900,7 +918,7 @@ class Call {
     );
   }
 
-  void processStats(CallStats stats) {
+  void _processStats(CallStats stats) {
     var publisherStats =
         state.value.publisherStats ?? PeerConnectionStats.empty();
     var subscriberStats =
@@ -1006,6 +1024,11 @@ class Call {
           _stateManager.callPreferences.dropIfAloneInRingingFlow) {
         await leave();
       }
+    } else if (sfuEvent is SfuHealthCheckResponseEvent) {
+      _stateManager.setParticipantsCount(
+        totalCount: sfuEvent.participantCount.total,
+        anonymousCount: sfuEvent.participantCount.anonymous,
+      );
     }
 
     if (sfuEvent is SfuSocketDisconnected) {
@@ -1144,7 +1167,7 @@ class Call {
     );
   }
 
-  Future<InternetStatus> awaitNetworkAvailable() async {
+  Future<InternetStatus> _awaitNetworkAvailable() async {
     _logger.v(() => '[awaitNetworkAwailable] starting timer');
     final fastReconnectTimer = Timer(_fastReconnectDeadline, () {
       _logger.w(() => '[awaitNetworkAwailable] too late for fast reconnect');
@@ -1201,6 +1224,9 @@ class Call {
     return const Result.success(none);
   }
 
+  /// Leaves the call.
+  ///
+  /// - [reason]: optional reason for leaving the call
   Future<Result<None>> leave({DisconnectReason? reason}) async {
     final state = this.state.value;
     _logger.i(() => '[leave] state: $state');
@@ -1250,6 +1276,10 @@ class Call {
     return [...?_session?.getTracks(trackIdPrefix)];
   }
 
+  /// Takes a picture of a VideoTrack at highest possible resolution
+  ///
+  /// - [participant]: the participant whose track to take a screenshot of
+  /// - [trackType]: optional type of track to take a screenshot of, defaults to [SfuTrackType.video]
   Future<ByteBuffer?> takeScreenshot(
     CallParticipantState participant, {
     SfuTrackType? trackType,
@@ -1470,6 +1500,7 @@ class Call {
     });
   }
 
+  /// Adds members to the current call.
   Future<Result<None>> addMembers(List<UserInfo> users) {
     return _coordinatorClient.addMembers(
       callCid: callCid,
@@ -1479,6 +1510,7 @@ class Call {
     );
   }
 
+  /// Removes members from the current call.
   Future<Result<None>> removeMembers(List<String> userIds) {
     return _coordinatorClient.removeMembers(
       callCid: callCid,
@@ -1499,19 +1531,29 @@ class Call {
     );
   }
 
-  /// Receives a call information. You can then use
-  /// the [CallReceivedData] in order to create a [Call] object.
+  /// Loads the information about the call.
+  ///
+  /// - [ringing]: If `true`, sends a VoIP notification, triggering the native call screen on iOS and Android.
+  /// - [notify]: If `true`, sends a standard push notification.
+  /// - [video]: Marks the call as a video call if `true`; otherwise, audio-only.
+  /// - [watch]:  If `true`, listens to coordinator events and updates call state accordingly.
+  /// - [membersLimit]: Sets the total number of members to return as part of the response.
   Future<Result<CallReceivedData>> get({
     int? membersLimit,
     bool ringing = false,
     bool notify = false,
     bool video = false,
+    bool watch = true,
   }) async {
     _logger.d(
       () => '[get] cid: $callCid, membersLimit: $membersLimit'
           ', ringing: $ringing, notify: $notify, video: $video',
     );
 
+    if (watch) {
+      _observeEvents();
+    }
+
     final response = await _coordinatorClient.getCall(
       callCid: callCid,
       membersLimit: membersLimit,
@@ -1538,14 +1580,19 @@ class Call {
     );
   }
 
-  /// Receives a call or creates it with given information. You can then use
-  /// the [CallReceivedOrCreatedData] in order to create a [Call] object.
+  /// Loads the information about the call and creates it if it doesn't exist.
+  ///
+  /// - [ringing]: If `true`, sends a VoIP notification, triggering the native call screen on iOS and Android.
+  /// - [notify]: If `true`, sends a standard push notification.
+  /// - [video]: Marks the call as a video call if `true`; otherwise, audio-only.
+  /// - [watch]:  If `true`, listens to coordinator events and updates call state accordingly.
   Future<Result<CallReceivedOrCreatedData>> getOrCreate({
     List<String> memberIds = const [],
     bool ringing = false,
     bool video = false,
-    String? team,
+    bool watch = true,
     bool? notify,
+    String? team,
     DateTime? startsAt,
     StreamBackstageSettings? backstage,
     StreamLimitsSettings? limits,
@@ -1556,6 +1603,10 @@ class Call {
           'memberIds: $memberIds',
     );
 
+    if (watch) {
+      _observeEvents();
+    }
+
     if (ringing) {
       await _streamVideo.state.setOutgoingCall(this);
     }

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

@@ -289,4 +289,14 @@ mixin StateParticipantMixin on StateNotifier<CallState> {
       }).toList(),
     );
   }
+
+  void setParticipantsCount({
+    required int totalCount,
+    required int anonymousCount,
+  }) {
+    state = state.copyWith(
+      participantCount: totalCount,
+      anonymousParticipantCount: anonymousCount,
+    );
+  }
 }

packages/stream_video/lib/src/call_state.dart

@@ -41,6 +41,8 @@ class CallState extends Equatable {
       localStats: null,
       latencyHistory: const [],
       blockedUserIds: const [],
+      participantCount: 0,
+      anonymousParticipantCount: 0,
       custom: const {},
     );
   }
@@ -76,6 +78,8 @@ class CallState extends Equatable {
     required this.localStats,
     required this.latencyHistory,
     required this.blockedUserIds,
+    required this.participantCount,
+    required this.anonymousParticipantCount,
     required this.custom,
   });
 
@@ -108,6 +112,8 @@ class CallState extends Equatable {
   final LocalStats? localStats;
   final List<int> latencyHistory;
   final List<String> blockedUserIds;
+  final int participantCount;
+  final int anonymousParticipantCount;
   final Map<String, Object> custom;
 
   String get callId => callCid.id;
@@ -154,6 +160,8 @@ class CallState extends Equatable {
     LocalStats? localStats,
     List<int>? latencyHistory,
     List<String>? blockedUserIds,
+    int? participantCount,
+    int? anonymousParticipantCount,
     Map<String, Object>? custom,
   }) {
     return CallState._(
@@ -186,6 +194,9 @@ class CallState extends Equatable {
       localStats: localStats ?? this.localStats,
       latencyHistory: latencyHistory ?? this.latencyHistory,
       blockedUserIds: blockedUserIds ?? this.blockedUserIds,
+      participantCount: participantCount ?? this.participantCount,
+      anonymousParticipantCount:
+          anonymousParticipantCount ?? this.anonymousParticipantCount,
       custom: custom ?? this.custom,
     );
   }
@@ -244,6 +255,8 @@ class CallState extends Equatable {
         localStats,
         latencyHistory,
         blockedUserIds,
+        participantCount,
+        anonymousParticipantCount,
         custom,
       ];
 

packages/stream_video/lib/src/coordinator/open_api/open_api_extensions.dart

@@ -374,6 +374,7 @@ extension CallSessionResponseExt on open.CallSessionResponse {
       endedAt: endedAt,
       liveStartedAt: liveStartedAt,
       liveEndedAt: liveEndedAt,
+      timerEndsAt: timerEndsAt,
     );
   }
 }

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

@@ -16,6 +16,7 @@ class CallSessionData with EquatableMixin {
     this.liveStartedAt,
     this.endedAt,
     this.liveEndedAt,
+    this.timerEndsAt,
   });
 
   final String id;
@@ -27,6 +28,7 @@ class CallSessionData with EquatableMixin {
   final DateTime? endedAt;
   final DateTime? liveStartedAt;
   final DateTime? liveEndedAt;
+  final DateTime? timerEndsAt;
 
   @override
   List<Object?> get props => [
@@ -35,6 +37,7 @@ class CallSessionData with EquatableMixin {
         liveStartedAt,
         liveStartedAt,
         liveEndedAt,
+        timerEndsAt,
       ];
 }
 

packages/stream_video/lib/src/stream_video.dart

@@ -766,7 +766,7 @@ class StreamVideo extends Disposable {
       callType: callType,
       id: id,
     );
-    final callResult = await call.get();
+    final callResult = await call.get(watch: false);
 
     return callResult.fold(
       failure: (failure) {