RoomListener

interface RoomListener
Content copied to clipboard

Room Listener, this class provides callbacks that clients should override.

Types

Companion
Link copied to clipboard
object Companion
Content copied to clipboard

Functions

onActiveSpeakersChanged
Link copied to clipboard
open fun onActiveSpeakersChanged(speakers: List<Participant>, room: Room)
Content copied to clipboard
Active speakers changed.
onConnectionQualityChanged
Link copied to clipboard
open fun onConnectionQualityChanged(participant: Participant, quality: ConnectionQuality)
Content copied to clipboard
The connection quality for a participant has changed.
onDataReceived
Link copied to clipboard
open fun onDataReceived(data: ByteArray, participant: RemoteParticipant?, room: Room)
Content copied to clipboard
Received data published by another participant
onDisconnect
Link copied to clipboard
open fun onDisconnect(room: Room, error: Exception?)
Content copied to clipboard
Disconnected from room
onFailedToConnect
Link copied to clipboard
open fun onFailedToConnect(room: Room, error: Throwable)
Content copied to clipboard
Could not connect to the room
onMetadataChanged
Link copied to clipboard
open fun onMetadataChanged(participant: Participant, prevMetadata: String?, room: Room)
Content copied to clipboard
Participant metadata is a simple way for app-specific state to be pushed to all users.
onParticipantConnected
Link copied to clipboard
open fun onParticipantConnected(room: Room, participant: RemoteParticipant)
Content copied to clipboard
When a RemoteParticipant joins after the local participant.
onParticipantDisconnected
Link copied to clipboard
open fun onParticipantDisconnected(room: Room, participant: RemoteParticipant)
Content copied to clipboard
When a RemoteParticipant leaves after the local participant has joined.
onReconnected
Link copied to clipboard
open fun onReconnected(room: Room)
Content copied to clipboard
The reconnect attempt had been successful
onReconnecting
Link copied to clipboard
open fun onReconnecting(room: Room)
Content copied to clipboard
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
onTrackMuted
Link copied to clipboard
open fun onTrackMuted(publication: TrackPublication, participant: Participant, room: Room)
Content copied to clipboard
The participant was muted.
onTrackPublished
Link copied to clipboard
open fun onTrackPublished(publication: LocalTrackPublication, participant: LocalParticipant, room: Room)
Content copied to clipboard
When a new track is published to room after the local participant has joined.
open fun onTrackPublished(publication: RemoteTrackPublication, participant: RemoteParticipant, room: Room)
Content copied to clipboard
When a new track is published to room after the local participant has joined.
onTrackSubscribed
Link copied to clipboard
open fun onTrackSubscribed(track: Track, publication: TrackPublication, participant: RemoteParticipant, room: Room)
Content copied to clipboard
The LocalParticipant has subscribed to a new track.
onTrackSubscriptionFailed
Link copied to clipboard
open fun onTrackSubscriptionFailed(sid: String, exception: Exception, participant: RemoteParticipant, room: Room)
Content copied to clipboard
Could not subscribe to a track
onTrackUnmuted
Link copied to clipboard
open fun onTrackUnmuted(publication: TrackPublication, participant: Participant, room: Room)
Content copied to clipboard
The participant was unmuted.
onTrackUnpublished
Link copied to clipboard
open fun onTrackUnpublished(publication: LocalTrackPublication, participant: LocalParticipant, room: Room)
Content copied to clipboard
LocalParticipant has unpublished a track
open fun onTrackUnpublished(publication: RemoteTrackPublication, participant: RemoteParticipant, room: Room)
Content copied to clipboard
A RemoteParticipant has unpublished a track
onTrackUnsubscribed
Link copied to clipboard
open fun onTrackUnsubscribed(track: Track, publications: TrackPublication, participant: RemoteParticipant, room: Room)
Content copied to clipboard
A subscribed track is no longer available.

Sources

SDK source
Link copied to clipboard