RoomEvent

livekit-android-sdk/io.livekit.android.events/RoomEvent

Types

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

Active speakers changed. List of speakers are ordered by their audio level. loudest speakers first. This will include the LocalParticipant too.

Connected

class Connected(val room: Room) : RoomEvent

Connected to Room

ConnectionQualityChanged

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

The connection quality for a participant has changed.

DataReceived

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

Received data published by another participant

Disconnected

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

Disconnected from room

FailedToConnect

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

ParticipantConnected

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

When a RemoteParticipant joins after the local participant. It will not emit events for participants that are already in the room

ParticipantDisconnected

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

When a RemoteParticipant leaves after the local participant has joined.

ParticipantMetadataChanged

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

Participant metadata is a simple way for app-specific state to be pushed to all users. When RoomService.UpdateParticipantMetadata is called to change a participant's state, this event will be fired for all clients in the room.

ParticipantNameChanged

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

ParticipantPermissionsChanged

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

A participant's permissions have changed.

Reconnected

class Reconnected(val room: Room) : RoomEvent

The reconnect attempt had been successful

Reconnecting

class Reconnecting(val 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(val room: Room, isRecording: Boolean) : RoomEvent

The recording of a room has started/stopped.

RoomMetadataChanged

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

TrackE2EEStateEvent

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

The E2EE state of a track has changed.

TrackMuted

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

The participant was muted.

TrackPublished

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

When a new track is published to room after the local participant has joined. It will not fire for tracks that are already published

TrackStreamStateChanged

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

A track's stream state has changed.

TrackSubscribed

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

The LocalParticipant has subscribed to a new track. This event will always fire as long as new tracks are ready for use.

TrackSubscriptionFailed

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

Could not subscribe to a track

TrackSubscriptionPermissionChanged

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

A remote track's subscription permissions have changed.

TrackUnmuted

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

The participant was unmuted.

TrackUnpublished

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

A Participant has unpublished a track

TrackUnsubscribed

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

A subscribed track is no longer available. Clients should listen to this event and ensure the track removes all renderers

TranscriptionReceived

class TranscriptionReceived(val room: Room, val transcriptionSegments: List<TranscriptionSegment>, val participant: Participant?, val publication: TrackPublication?) : RoomEvent

Properties

room

val room: Room

RoomEvent

Inheritors

Types

Properties