Call and Participant State

When you join a call, we’ll automatically expose state in 3 different places: the Stream Video Client, the Call, and the participants.

var clientState = streamVideo.state;
var callState = call.state;
var participants = call.state.value.callParticipants;

Call State

When a Call is created, users can subscribe to receive notifications about any changes that may occur during the call’s lifecycle. To access the state of a call, use call.state.value to obtain the latest CallState snapshot, or use valueStream to listen for real-time changes to the CallState.

This functionality is particularly useful for determining which parts of the UI or application to render based on the current state or lifecycle of the ongoing call.

For example, you may want to display an indicator to users when a call is being recorded:

StreamBuilder<CallState>(
  stream: call.state.valueStream, // Subscribe to state changes
  builder: (context, snapshot) {
    final state = snapshot.data;
    if (state.isRecording) {
      return CallRecordingUI();
    } else {
      return RegularCallUI();
    }
  },
),

The following fields are available on the call:

Understanding Call Status

The status property of the CallState object indicates the current state of the call. Depending on where you are in the call lifecycle, CallStatus can have one of the following possible values.

By checking the CallStatus value in the CallState object, you can determine the current state of the call and adjust your UI accordingly.

Participant State

var participants = call.state.value.callParticipants;
var localParticipant = call.state.value.localParticipant;

In the call state, you can find the parameter callParticipants. This parameter allows you to access and manipulate the participants present on the call. By using callParticipants, you can easily map over the participants and observe changes in their configuration. For instance, you can keep track of which participant is currently speaking, which participant is the dominant speaker, and which participant is pinned to the call. Additionally, callParticipants allows you to monitor other changes to the call’s configuration as well.

Overall, callParticipants is a powerful tool that provides you with a lot of control and insight into the call’s current state and configuration. By leveraging this parameter effectively, you can create more advanced and robust call applications.

for (final user in call.state.value.callParticipants){
  if (user.isDominantSpeaker){
    setState(() => dominantSpeaker = user);
  }
}

The following fields are available on the participant:

Combining CallState and CallParticipantState makes building custom UIs and integrations a breeze. If there is a property or API that is not exposed for your specific use case, feel free to reach out to us. We are constantly iterating and exposing APIs based on your feedback.

Client State

// Client state is available in the client object
var clientState = StreamVideo.instance.state;