ParticipantEvent

Events that are emitted by a Participant instance.

Enumeration Members

`AudioConnected`

An audio object has been connected to the participant.

Value

audioConnected

`AudioConnectionChanged`

An audio object has been connected to or disconnected from the participant.

Value

audioConnectionChanged

`AudioDisconnected`

The audio object has been disconnected from the participant.

Value

audioDisconnected

`ConnectionQualityChanged`

Connection quality was changed for a Participant. It'll receive updates from the local participant, as well as any RemoteParticipants that we are subscribed to.

Provides: (connectionQuality: ConnectionQuality)

Value

connectionQualityChanged

`DataReceived`

Data received from this participant as sender. Data packets provides the ability to use LiveKit to send/receive arbitrary payloads. All participants in the room will receive the messages sent to the room.

Provides: (payload: Uint8Array, kind: DataPacket_Kind)

Value

dataReceived

`IsSpeakingChanged`

Has speaking status changed for the current participant

Provides: (speaking: boolean)

Value

isSpeakingChanged

`LocalTrackPublished`

A local track was published successfully. This event is helpful to know when to update your local UI with the newly published track.

Provides: (LocalTrackPublication)

Value

localTrackPublished

`LocalTrackUnpublished`

A local track was unpublished. This event is helpful to know when to remove the local track from your UI.

When a user stops sharing their screen by pressing "End" on the browser UI, this event will also fire.

Provides: (LocalTrackPublication)

Value

localTrackUnpublished

`ParticipantMetadataChanged`

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, all participants in the room will fire this event. To access the current metadata, see metadata.

Provides: (prevMetadata: string)

Value

participantMetadataChanged

`ParticipantNameChanged`

Participant's display name changed

Provides: (name: string, Participant)

Value

participantNameChanged

`ParticipantPermissionsChanged`

A participant's permission has changed. Currently only fired on LocalParticipant. Provides: (prevPermissions: ParticipantPermission)

Value

participantPermissionsChanged

`PositionChanged`

Emitted when the participant's position has changed.

Value

positionChanged

`TrackMuted`

A track that was muted, fires on both RemoteParticipants andLocalParticipant

Provides: (TrackPublication)

Value

trackMuted

`TrackPublished`

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

A track published doesn't mean the participant has subscribed to it. It's simply reflecting the state of the room.

Provides: (RemoteTrackPublication)

Value

trackPublished

`TrackStreamStateChanged`

StreamState indicates if a subscribed track has been paused by the SFU (typically this happens because of subscriber's bandwidth constraints)

When bandwidth conditions allow, the track will be resumed automatically. TrackStreamStateChanged will also be emitted when that happens.

Provides: (pub: RemoteTrackPublication, streamState: Track.StreamState)

Value

trackStreamStateChanged

`TrackSubscribed`

Successfully subscribed to the RemoteParticipant's track. This event will always fire as long as new tracks are ready for use.

Provides: (RemoteTrack, RemoteTrackPublication)

Value

trackSubscribed

`TrackSubscriptionFailed`

Could not subscribe to a track

Provides: (track sid)

Value

trackSubscriptionFailed

`TrackSubscriptionPermissionChanged`

One of subscribed tracks have changed its permissions for the current participant. If permission was revoked, then the track will no longer be subscribed. If permission was granted, a TrackSubscribed event will be emitted.

Provides: (pub: RemoteTrackPublication, status: TrackPublication.SubscriptionStatus)

Value

trackSubscriptionPermissionChanged