Holds the current closed caption mode for the video call. This object contains information about closed captioning feature availability. This state is updated dynamically based on the server's transcription setting which is io.getstream.android.video.generated.models.TranscriptionSettingsResponse.closedCaptionMode

closedCaptions

val closedCaptions: StateFlow<List<CallClosedCaption>>

Holds the current list of closed captions. This list is updated dynamically and contains at most ClosedCaptionsSettings.maxVisibleCaptions captions.

compositeRecording

val compositeRecording: StateFlow<Boolean>

connection

val connection: StateFlow<RealtimeConnection>

createdAt

val createdAt: StateFlow<OffsetDateTime?>

createdBy

val createdBy: StateFlow<User?>

custom

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

dominantSpeaker

val dominantSpeaker: StateFlow<ParticipantState?>

duration

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.

durationInMs

val durationInMs: StateFlow<Long?>

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

egress

val egress: StateFlow<EgressResponse?>

egressPlayListUrl

val egressPlayListUrl: StateFlow<String?>

endedAt

val endedAt: StateFlow<OffsetDateTime?>

endedByUser

val endedByUser: StateFlow<User?>

errors

val errors: StateFlow<List<ErrorEvent>>

individualRecording

val individualRecording: StateFlow<Boolean>

ingress

val ingress: StateFlow<Ingress?>

isCaptioning

val isCaptioning: StateFlow<Boolean>

Tracks whether closed captioning is currently active for the call. True if captioning is ongoing, false otherwise.

isReconnecting

val isReconnecting: StateFlow<Boolean>

live

val live: StateFlow<Boolean>

the opposite of backstage, if we are live or not

liveDuration

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.

livestream

val ~~livestream~~: StateFlow<ParticipantState.Video?>

localParticipant

val localParticipant: StateFlow<ParticipantState?>

Your own participant state

val me: StateFlow<ParticipantState?>

Your own participant state

members

val members: StateFlow<List<MemberState>>

moderationManager

val moderationManager: ModerationManager

notificationIdFlow

val notificationIdFlow: StateFlow<Int?>

ownCapabilities

val ownCapabilities: StateFlow<List<OwnCapability>>

participantCounts

val participantCounts: StateFlow<ParticipantCount?>

participants

val participants: StateFlow<List<ParticipantState>>

Participants in this call, ordered by the active SortPreset. The list emits whenever the order changes — identity-equal emissions are suppressed by the sorter's internal coalescing so consumers don't recompose for non-changes.

participantVideoEnabledOverrides

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

permissionRequests

val permissionRequests: StateFlow<List<PermissionRequest>>

pinnedParticipants

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

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

rawRecording

val rawRecording: StateFlow<Boolean>

reactions

val reactions: StateFlow<List<ReactionResponse>>

recording

val recording: StateFlow<Boolean>

rejectActionBundle

val rejectActionBundle: StateFlow<Bundle?>

rejectedBy

val rejectedBy: StateFlow<Set<String>>

remoteParticipants

val remoteParticipants: StateFlow<List<ParticipantState>>

Participants other than yourself, in the same sort order as participants. Lazy-initialized to defer resolving _sortedParticipantsState (defined later in this class).

ringingState

val ringingState: StateFlow<RingingState>

scope

val scope: CoroutineScope

screenSharingSession

val screenSharingSession: StateFlow<ScreenSharingSession?>

session

val session: StateFlow<CallSessionResponse?>

settings

val settings: StateFlow<CallSettingsResponse?>

sortedParticipants

val ~~sortedParticipants~~: Flow<List<ParticipantState>>

Deprecated alias for participants. Return type is intentionally declared as Flow (not StateFlow) to preserve binary compatibility with the pre-existing public API — StateFlow is a Flow, so consumers see the same underlying value.

speakingWhileMuted

val speakingWhileMuted: StateFlow<Boolean>

startedAt

val startedAt: StateFlow<OffsetDateTime?>

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

startsAt

val startsAt: StateFlow<OffsetDateTime?>

stats

val stats: CallStats

team

val team: StateFlow<String?>

thumbnail

val thumbnail: StateFlow<String?>

totalParticipants

val totalParticipants: StateFlow<Int>

a count of the total number of participants.

transcribing

val transcribing: StateFlow<Boolean>

updatedAt

val updatedAt: StateFlow<OffsetDateTime?>

updatedAt

Functions

cancelTimeout

fun cancelTimeout()

clearParticipants

fun clearParticipants()

getMember

fun getMember(userId: String): MemberState?

getOrCreateParticipant

fun getOrCreateParticipant(sessionId: String, userId: String, updateFlow: Boolean = false, source: ERROR CLASS: Symbol not found for ParticipantSource = ParticipantSource.PARTICIPANT_SOURCE_WEBRTC_UNSPECIFIED): ParticipantState

getParticipantBySessionId

fun getParticipantBySessionId(sessionId: String): ParticipantState?

handleEvent

fun handleEvent(event: VideoEvent)

hasPermission

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>)

setOwnCapabilities

fun setOwnCapabilities(ownCapability: List<OwnCapability>)

setSortPreset

fun setSortPreset(preset: SortPreset)

Switch the active sort preset.

unpin

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)

updateNotification

fun ~~updateNotification~~(notification: Notification)

fun updateNotification(notificationId: Int, notification: Notification)

updateParticipant

fun updateParticipant(participant: ParticipantState)

updateParticipantSortingOrder

fun updateParticipantSortingOrder(comparator: Comparator<ParticipantState>)

Plug in an ad-hoc Comparator for participant sorting. Overrides the active preset until called again with a different comparator or setSortPreset is invoked.

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.

updateRejectActionBundle

fun updateRejectActionBundle(bundle: Bundle)

updateRejectedBy

fun updateRejectedBy(userId: Set<String>)

upsertParticipants

fun upsertParticipants(participants: List<ParticipantState>)