livekit-android-sdk/io.livekit.android.room.participant/Participant

Participant

open class Participant(var sid: Participant.Sid, identity: Participant.Identity? = null, @Named(value = "dispatcher_default") coroutineDispatcher: CoroutineDispatcher)

Inheritors

LocalParticipant

RemoteParticipant

Constructors

constructor(sid: Participant.Sid, identity: Participant.Identity? = null, @Named(value = "dispatcher_default") coroutineDispatcher: CoroutineDispatcher)

Types

@Serializable

value class Identity(val value: String)

enum Kind : Enum<Participant.Kind>

@Serializable

value class Sid(val value: String)

Properties

@FlowObservable

@get:FlowObservable

@set:VisibleForTesting

var attributes: Map<String, String>

The attributes set on this participant.

@FlowObservable

@get:FlowObservable

@set:VisibleForTesting

var audioLevel: Float

Changes can be observed by using io.livekit.android.util.flow

audioTrackPublications

@FlowObservable

@get:FlowObservable

val audioTrackPublications: List<Pair<TrackPublication, Track?>>

Changes can be observed by using io.livekit.android.util.flow

connectionQuality

@FlowObservable

@get:FlowObservable

var connectionQuality: ConnectionQuality

Changes can be observed by using io.livekit.android.util.flow

val events: EventListenable<ParticipantEvent>

val hasInfo: Boolean

@FlowObservable

@get:FlowObservable

@set:VisibleForTesting

var identity: Participant.Identity?

The participant's identity on the server. name should be preferred for UI usecases.

@FlowObservable

@get:FlowObservable

@set:VisibleForTesting

var isSpeaking: Boolean

Changes can be observed by using io.livekit.android.util.flow

val joinedAt: <Error class: unknown class>?

Timestamp when participant joined room, in milliseconds

@FlowObservable

@get:FlowObservable

var kind: Participant.Kind

The kind of participant (i.e. a standard client participant, AI agent, etc.)

@FlowObservable

@get:FlowObservable

var lastSpokeAt: Long?

Timestamp when the participant last started speaking, in milliseconds

@FlowObservable

@get:FlowObservable

@set:VisibleForTesting

var metadata: String?

The metadata for this participant.

@FlowObservable

@get:FlowObservable

@set:VisibleForTesting

var name: String?

The participant's name. To be used for user-facing purposes (i.e. when displayed in the UI).

participantInfo

@FlowObservable

@get:FlowObservable

var participantInfo: <Error class: unknown class>?

Changes can be observed by using io.livekit.android.util.flow

@FlowObservable

@get:FlowObservable

var permissions: ParticipantPermission?

The permissions for this participant.

var sid: Participant.Sid

trackPublications

@FlowObservable

@get:FlowObservable

var trackPublications: Map<String, TrackPublication>

Maps track sids to their track publications.

videoTrackPublications

@FlowObservable

@get:FlowObservable

val videoTrackPublications: List<Pair<TrackPublication, Track?>>

Changes can be observed by using io.livekit.android.util.flow

Functions

open operator override fun equals(other: Any?): Boolean

getTrackPublication

open fun getTrackPublication(source: Track.Source): TrackPublication?

Retrieves the first track that matches the source, or null

getTrackPublicationByName

open fun getTrackPublicationByName(name: String): TrackPublication?

Retrieves the first track that matches name, or null

open override fun hashCode(): Int

isCameraEnabled

fun isCameraEnabled(): Boolean

isMicrophoneEnabled

fun isMicrophoneEnabled(): Boolean

isScreenShareEnabled

fun isScreenShareEnabled(): Boolean