stream-video-android-core/io.getstream.video.android.core/CallState

CallState

class CallState(client: StreamVideo, call: Call, user: User, scope: CoroutineScope)

The CallState class keeps all state for a call It's available on every call object

Samples

Constructors

constructor(client: StreamVideo, call: Call, user: User, scope: CoroutineScope)

Properties

val acceptedBy: StateFlow<Set<String>>

val activeSpeakers: StateFlow<List<ParticipantState>>

val backstage: StateFlow<Boolean>

if we are in backstage mode or not

val blockedUserIds: StateFlow<List<String>>

val blockedUsers: StateFlow<Set<String>>

val broadcasting: StateFlow<Boolean>

if the call is being broadcasted to HLS

capabilitiesByRole

val capabilitiesByRole: StateFlow<Map<String, List<String>>>

val connection: StateFlow<RealtimeConnection>

val createdAt: StateFlow<OffsetDateTime?>

val createdBy: StateFlow<User?>

val custom: StateFlow<Map<String, Any?>>

dominantSpeaker

val dominantSpeaker: StateFlow<ParticipantState?>

val duration: StateFlow<Duration?>

how long the call has been running, rounded to seconds, null if the call didn't start yet

durationInDateFormat

val durationInDateFormat: StateFlow<String?>

how many milliseconds the call has been running in the simple date format.

val durationInMs: StateFlow<Long?>

how many milliseconds the call has been running, null if the call didn't start yet

val egress: StateFlow<EgressResponse?>

egressPlayListUrl

val egressPlayListUrl: StateFlow<String?>

val endedAt: StateFlow<OffsetDateTime?>

val endedByUser: StateFlow<User?>

val errors: StateFlow<List<ErrorEvent>>

val ingress: StateFlow<Ingress?>

val isReconnecting: StateFlow<Boolean>

val live: StateFlow<Boolean>

the opposite of backstage, if we are live or not

val liveDuration: StateFlow<Duration?>

How long the call has been live for, represented as Duration, or null if the call hasn't been live yet. Keeps its value when live ends and resets when live starts again.

liveDurationInMs

val liveDurationInMs: StateFlow<Long?>

How long the call has been live for, in milliseconds, or null if the call hasn't been live yet. Keeps its value when live ends and resets when live starts again.

val livestream: StateFlow<ParticipantState.Video?>

localParticipant

val localParticipant: StateFlow<ParticipantState?>

Your own participant state

val me: StateFlow<ParticipantState?>

Your own participant state

val members: StateFlow<List<MemberState>>

ownCapabilities

val ownCapabilities: StateFlow<List<OwnCapability>>

participantCounts

val participantCounts: StateFlow<ParticipantCount?>

val participants: StateFlow<List<ParticipantState>>

Participants returns a list of participant state object. @see ParticipantState

participantVideoEnabledOverrides

val participantVideoEnabledOverrides: StateFlow<Map<String, Boolean?>>

permissionRequests

val permissionRequests: StateFlow<List<PermissionRequest>>

pinnedParticipants

val pinnedParticipants: StateFlow<Map<String, OffsetDateTime>>

Pinned participants, combined value both from server and local pins.

val reactions: StateFlow<List<ReactionResponse>>

val recording: StateFlow<Boolean>

val rejectedBy: StateFlow<Set<String>>

remoteParticipants

val remoteParticipants: StateFlow<List<ParticipantState>>

participants other than yourself

val ringingState: StateFlow<RingingState>

screenSharingSession

val screenSharingSession: StateFlow<ScreenSharingSession?>

val session: StateFlow<CallSessionResponse?>

val settings: StateFlow<CallSettingsResponse?>

sortedParticipants

val sortedParticipants: Flow<List<ParticipantState>>

Sorted participants based on

speakingWhileMuted

val speakingWhileMuted: StateFlow<Boolean>

val startedAt: StateFlow<OffsetDateTime?>

Will return always null with current SFU implementation - it may be fixed later. For now do not use it.

val startsAt: StateFlow<OffsetDateTime?>

val stats: CallStats

val team: StateFlow<String?>

totalParticipants

val totalParticipants: StateFlow<Int>

a count of the total number of participants.

val transcribing: StateFlow<Boolean>

val updatedAt: StateFlow<OffsetDateTime?>

updatedAt

Functions

clearParticipants

fun clearParticipants()

fun getMember(userId: String): MemberState?

getOrCreateParticipant

fun getOrCreateParticipant(sessionId: String, userId: String, updateFlow: Boolean = false): ParticipantState

getParticipantBySessionId

fun getParticipantBySessionId(sessionId: String): ParticipantState?

fun handleEvent(event: VideoEvent)

fun hasPermission(permission: String): StateFlow<Boolean>

Check if you have permissions to do things like share your audio, video, screen etc

markSpeakingAsMuted

fun markSpeakingAsMuted()

fun pin(userId: String, sessionId: String)

replaceParticipants

fun replaceParticipants(participants: List<ParticipantState>)

fun unpin(sessionId: String)

updateFromResponse

fun updateFromResponse(response: CallResponse)

fun updateFromResponse(callData: CallStateResponseFields)

fun updateFromResponse(response: GetCallResponse)

fun updateFromResponse(response: GetOrCreateCallResponse)

fun updateFromResponse(result: GoLiveResponse)

fun updateFromResponse(response: JoinCallResponse)

fun updateFromResponse(it: QueryCallMembersResponse)

fun updateFromResponse(response: StartHLSBroadcastingResponse)

fun updateFromResponse(result: StopLiveResponse)

fun updateFromResponse(response: UpdateCallResponse)

updateParticipant

fun updateParticipant(participant: ParticipantState)

updateParticipantSortingOrder

fun updateParticipantSortingOrder(comparator: Comparator<ParticipantState>)

Update participant sorting order

updateParticipantVisibility

fun updateParticipantVisibility(sessionId: String, visibilityOnScreenState: VisibilityOnScreenState)

Update participants visibility on the UI.

updateParticipantVisibilityFlow

fun updateParticipantVisibilityFlow(flow: Flow<List<String>>?)

Set a flow to update the participants visibility. The flow should emit lists with currently visible participant session IDs.

upsertParticipants

fun upsertParticipants(participants: List<ParticipantState>)