RoomEvent

ActiveSpeakersChanged

class ActiveSpeakersChanged(room: Room, speakers: List<Participant>) : RoomEvent

Active speakers changed.

Connected

class Connected(room: Room) : RoomEvent

Connected to Room

ConnectionQualityChanged

class ConnectionQualityChanged(room: Room, participant: Participant, quality: ConnectionQuality) : RoomEvent

The connection quality for a participant has changed.

DataReceived

class DataReceived(room: Room, data: ByteArray, participant: RemoteParticipant?, topic: String?) : RoomEvent

Received data published by another participant

Disconnected

class Disconnected(room: Room, error: Exception?, reason: DisconnectReason) : RoomEvent

Disconnected from room

FailedToConnect

class FailedToConnect(room: Room, error: Throwable) : RoomEvent

ParticipantConnected

class ParticipantConnected(room: Room, participant: RemoteParticipant) : RoomEvent

When a RemoteParticipant joins after the local participant.

ParticipantDisconnected

class ParticipantDisconnected(room: Room, participant: RemoteParticipant) : RoomEvent

When a RemoteParticipant leaves after the local participant has joined.

ParticipantMetadataChanged

class ParticipantMetadataChanged(room: Room, participant: Participant, prevMetadata: String?) : RoomEvent

Participant metadata is a simple way for app-specific state to be pushed to all users.

ParticipantNameChanged

class ParticipantNameChanged(room: Room, participant: Participant, name: String?) : RoomEvent

ParticipantPermissionsChanged

class ParticipantPermissionsChanged(room: Room, participant: Participant, newPermissions: ParticipantPermission?, oldPermissions: ParticipantPermission?) : RoomEvent

A participant's permissions have changed.

Reconnected

class Reconnected(room: Room) : RoomEvent

The reconnect attempt had been successful

Reconnecting

class Reconnecting(room: Room) : RoomEvent

A network change has been detected and LiveKit attempts to reconnect to the room When reconnect attempts succeed, the room state will be kept, including tracks that are subscribed/published

RecordingStatusChanged

class RecordingStatusChanged(room: Room, isRecording: Boolean) : RoomEvent

The recording of a room has started/stopped.

RoomMetadataChanged

class RoomMetadataChanged(room: Room, newMetadata: String?, prevMetadata: String?) : RoomEvent

TrackE2EEStateEvent

class TrackE2EEStateEvent(room: Room, track: Track, publication: TrackPublication, participant: Participant, state: E2EEState) : RoomEvent

The E2EE state of a track has changed.

TrackMuted

class TrackMuted(room: Room, publication: TrackPublication, participant: Participant) : RoomEvent

The participant was muted.

TrackPublished

class TrackPublished(room: Room, publication: TrackPublication, participant: Participant) : RoomEvent

When a new track is published to room after the local participant has joined.

TrackStreamStateChanged

class TrackStreamStateChanged(room: Room, trackPublication: TrackPublication, streamState: Track.StreamState) : RoomEvent

A track's stream state has changed.

TrackSubscribed

class TrackSubscribed(room: Room, track: Track, publication: TrackPublication, participant: RemoteParticipant) : RoomEvent

The LocalParticipant has subscribed to a new track.

TrackSubscriptionFailed

class TrackSubscriptionFailed(room: Room, sid: String, exception: Exception, participant: RemoteParticipant) : RoomEvent

Could not subscribe to a track

TrackSubscriptionPermissionChanged

class TrackSubscriptionPermissionChanged(room: Room, participant: RemoteParticipant, trackPublication: RemoteTrackPublication, subscriptionAllowed: Boolean) : RoomEvent

A remote track's subscription permissions have changed.

TrackUnmuted

class TrackUnmuted(room: Room, publication: TrackPublication, participant: Participant) : RoomEvent

The participant was unmuted.

TrackUnpublished

class TrackUnpublished(room: Room, publication: TrackPublication, participant: Participant) : RoomEvent

A Participant has unpublished a track

TrackUnsubscribed

class TrackUnsubscribed(room: Room, track: Track, publications: TrackPublication, participant: RemoteParticipant) : RoomEvent

A subscribed track is no longer available.

room

val room: Room

RoomEvent

SDK source

RoomEvent

Types

Properties

Inheritors

Sources