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

ParticipantState

data class ParticipantState(var sessionId: String = "", val call: Call, initialUserId: String, val source: <Error class: unknown class> = ParticipantSource.PARTICIPANT_SOURCE_WEBRTC_UNSPECIFIED, var trackLookupPrefix: String = "")

Represents the state of a participant in a call.

A list of participants is shared when you join a call the SFU send you the participant joined event.

Constructors

ParticipantState

constructor(sessionId: String = "", call: Call, initialUserId: String, source: <Error class: unknown class> = ParticipantSource.PARTICIPANT_SOURCE_WEBRTC_UNSPECIFIED, trackLookupPrefix: String = "")

Types

data class Audio(val sessionId: String, val track: AudioTrack?, val enabled: Boolean) : ParticipantState.Media

sealed class Media

data class ScreenSharing(val sessionId: String, val track: VideoTrack?, val enabled: Boolean) : ParticipantState.Media

data class Video(val sessionId: String, val track: VideoTrack?, val enabled: Boolean, val paused: Boolean) : ParticipantState.Media

Properties

val audio: StateFlow<ParticipantState.Audio?>

val audioEnabled: StateFlow<Boolean>

val audioLevel: StateFlow<Float>

val audioLevels: StateFlow<List<Float>>

val audioTrack: StateFlow<AudioTrack?>

The call object

dominantSpeaker

val dominantSpeaker: StateFlow<Boolean>

val image: StateFlow<String>

val isLocal: Boolean

val joinedAt: StateFlow<OffsetDateTime?>

val lastSpeakingAt: StateFlow<OffsetDateTime?>

val name: StateFlow<String>

val networkQuality: StateFlow<NetworkQuality>

val reactions: StateFlow<List<Reaction>>

val roles: StateFlow<List<String>>

val screenSharing: StateFlow<ParticipantState.ScreenSharing?>

screenSharingEnabled

val screenSharingEnabled: StateFlow<Boolean>

screenSharingTrack

val screenSharingTrack: StateFlow<VideoTrack?>

var sessionId: String

The SFU returns a session id for each participant. This session id is unique

val source: <Error class: unknown class>

val speaking: StateFlow<Boolean>

trackLookupPrefix

var trackLookupPrefix: String

A prefix to identify tracks, internal

val userId: StateFlow<String>

val userNameOrId: StateFlow<String>

val video: StateFlow<ParticipantState.Video?>

val videoEnabled: StateFlow<Boolean>

val videoPaused: StateFlow<Boolean>

State that indicates whether the video is paused or not.

val videoTrack: StateFlow<VideoTrack?>

visibleOnScreen

val visibleOnScreen: StateFlow<VisibilityOnScreenState>

Functions

consumeReaction

fun consumeReaction(reaction: Reaction)

suspend fun muteAudio(): Result<MuteUsersResponse>

muteScreenshare

suspend fun muteScreenshare(): Result<MuteUsersResponse>

suspend fun muteVideo(): Result<MuteUsersResponse>

suspend fun pin()

fun setVideoTrack(track: VideoTrack?)

suspend fun unpin()

updateAudioLevel

fun updateAudioLevel(audioLevel: Float)

updateFromParticipantInfo

fun updateFromParticipantInfo(participant: <Error class: unknown class>)

Inherited functions

fun ParticipantState.toCallUser(): CallUser