Types

Link copied to clipboard
class AttributesChanged(val participant: Participant, val changedAttributes: Map<String, String>, val oldAttributes: Map<String, String>) : ParticipantEvent

When a participant's attributes are changed, fired for all participants

Link copied to clipboard
class DataReceived(val participant: RemoteParticipant, val data: ByteArray, val topic: String?) : ParticipantEvent

Received data published by another participant

Link copied to clipboard

When a new track is published by the local participant.

Link copied to clipboard

Fired when the first remote participant has subscribed to the localParticipant's track

Link copied to clipboard

A LocalParticipant has unpublished a track

Link copied to clipboard
class MetadataChanged(val participant: Participant, val prevMetadata: String?) : ParticipantEvent

When a participant's metadata is updated, fired for all participants

Link copied to clipboard
class NameChanged(val participant: Participant, val name: String?) : ParticipantEvent

When a participant's display name is changed, fired for all participants

Link copied to clipboard
class ParticipantPermissionsChanged(val participant: Participant, val newPermissions: ParticipantPermission?, val oldPermissions: ParticipantPermission?) : ParticipantEvent

A participant's permissions have changed.

Link copied to clipboard
class SpeakingChanged(val participant: Participant, val isSpeaking: Boolean) : ParticipantEvent

Fired when the current participant's isSpeaking property changes. (including LocalParticipant)

Link copied to clipboard
class TrackMuted(val participant: Participant, val publication: TrackPublication) : ParticipantEvent

The participant was muted.

Link copied to clipboard
class TrackPublished(val participant: RemoteParticipant, val publication: RemoteTrackPublication) : ParticipantEvent

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

Link copied to clipboard
class TrackStreamStateChanged(val participant: Participant, val trackPublication: TrackPublication, val streamState: Track.StreamState) : ParticipantEvent

A track's stream state has changed.

Link copied to clipboard
class TrackSubscribed(val participant: RemoteParticipant, val track: Track, val publication: RemoteTrackPublication) : ParticipantEvent

Subscribed to a new track

Link copied to clipboard
class TrackSubscriptionFailed(val participant: RemoteParticipant, val sid: String, val exception: Exception) : ParticipantEvent

Error had occurred while subscribing to a track

Link copied to clipboard
class TrackSubscriptionPermissionChanged(val participant: RemoteParticipant, val trackPublication: RemoteTrackPublication, val subscriptionAllowed: Boolean) : ParticipantEvent

A remote track's subscription permissions have changed.

Link copied to clipboard
class TrackUnmuted(val participant: Participant, val publication: TrackPublication) : ParticipantEvent

The participant was unmuted.

Link copied to clipboard

A RemoteParticipant has unpublished a track

Link copied to clipboard
class TrackUnsubscribed(val participant: RemoteParticipant, val track: Track, val publication: RemoteTrackPublication) : ParticipantEvent

A subscribed track is no longer available. Clients should listen to this event and handle cleanup

Link copied to clipboard
class TranscriptionReceived(val participant: Participant, val transcriptions: List<TranscriptionSegment>, val publication: TrackPublication?) : ParticipantEvent

Properties

Link copied to clipboard