Call & Participant State

Video Call State

When you join a call, we’ll automatically expose observable objects in 3 different places:

let clientState = streamVideo.state
let callState = call.state
let participants = call.state.participants

Call State

The call state is kept in sync (updates are received) only when you join the call.

Here’s an example of how you can access the call state:

let call = streamVideo.call(callType: "default", callId: "mycall")
let joinResult = try await call.join(create: true)
// state is now available at
let state = call.state

The following fields are available on the call:

Participant State

The CallParticipant is the most essential component used to render a participant in a call. It contains all of the information to render a participant, such as audio & video tracks, availabilities of audio & video, the screen sharing session, reactions, and etc. Here’s how you can subscribe to participants updates:

// all participants
let cancellable = call.state.$participants.sink { participants in
    // ..
}

Filtering of the participants is also supported. You can get all the participants with the role “host”, with the following code:

var hosts: [CallParticipant] {
    call.state.participants.filter { $0.roles.contains("host") }
}

When you join a call with many participants, maximum of 250 participants are returned in the join response. The list of participants is updated dynamically when there are join call events.

The participants that are publishing video, audio or screensharing are prioritized over the other participants in the list.

The total number of participants is updated realtime via health check events. This value is available from the call state’s participantCount property.

You can get the current user with the following code:

let localParticipant: CallParticipant? = call.state.localParticipant

The following fields are available on the participant:

Participants Sorting

If you want to change the default sorting of the participants, you can use the Call object’s method updateParticipantsSorting.

Here’s an example that will sort participants alphabetically, by their name:

let nameComparator: StreamSortComparator<CallParticipant> = {
    comparison($0, $1, keyPath: \.name)
}
let call = streamVideo.call(callType: callType, callId: callId)
call.updateParticipantsSorting(with: [nameComparator])

Client State

// client state is available on the client object
let state = streamVideo.state

And contains these fields: