Participant

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

Inheritors

Constructors

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

Types

Link copied to clipboard
@Serializable
value class Identity(val value: String)
Link copied to clipboard
Link copied to clipboard
@Serializable
value class Sid(val value: String)

Properties

Link copied to clipboard
@FlowObservable
@get:FlowObservable
var attributes: Map<String, String>

The attributes set on this participant.

Link copied to clipboard
@FlowObservable
@get:FlowObservable
var audioLevel: Float

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

Link copied to clipboard
@FlowObservable
@get:FlowObservable
val audioTrackPublications: List<Pair<TrackPublication, Track?>>

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

Link copied to clipboard
@FlowObservable
@get:FlowObservable
var connectionQuality: ConnectionQuality

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@FlowObservable
@get:FlowObservable
var identity: Participant.Identity?

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

Link copied to clipboard
@FlowObservable
@get:FlowObservable
var isSpeaking: Boolean

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

Link copied to clipboard
val joinedAt: <Error class: unknown class>?

Timestamp when participant joined room, in milliseconds

Link copied to clipboard
@FlowObservable
@get:FlowObservable
var kind: Participant.Kind

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

Link copied to clipboard
@FlowObservable
@get:FlowObservable
var lastSpokeAt: Long?

Timestamp when the participant last started speaking, in milliseconds

Link copied to clipboard
@FlowObservable
@get:FlowObservable
var metadata: String?

The metadata for this participant.

Link copied to clipboard
@FlowObservable
@get:FlowObservable
var name: String?

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

Link copied to clipboard
@FlowObservable
@get:FlowObservable
var participantInfo: <Error class: unknown class>?

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

Link copied to clipboard
@FlowObservable
@get:FlowObservable
var permissions: ParticipantPermission?

The permissions for this participant.

Link copied to clipboard
Link copied to clipboard
@FlowObservable
@get:FlowObservable
var trackPublications: Map<String, TrackPublication>

Maps track sids to their track publications.

Link copied to clipboard
@FlowObservable
@get:FlowObservable
val videoTrackPublications: List<Pair<TrackPublication, Track?>>

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

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard

Retrieves the first track that matches the source, or null

Link copied to clipboard

Retrieves the first track that matches name, or null

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard