ParticipantEvent
Defined in: client-sdk-js/src/events.ts:345
Events emitted by a Participant instance (local or remote).
Example
Section titled “Example”participant.on(ParticipantEvent.TrackMuted, (publication) => { console.log('track muted', publication.trackName);});Enumeration Members
Section titled “Enumeration Members”AttributesChanged
Section titled “AttributesChanged”AttributesChanged: "attributesChanged";Defined in: client-sdk-js/src/events.ts:405
The participant’s attributes have changed.
args: (changedAttributes: Record<string, string>, participant: {@link Participant})
ChatMessage
Section titled “ChatMessage”ChatMessage: "chatMessage";Defined in: client-sdk-js/src/events.ts:431
A chat message from this participant.
args: (message: {@link ChatMessage})
ConnectionQualityChanged
Section titled “ConnectionQualityChanged”ConnectionQualityChanged: "connectionQualityChanged";Defined in: client-sdk-js/src/events.ts:411
The connection quality of this participant has changed.
DataReceived
Section titled “DataReceived”DataReceived: "dataReceived";Defined in: client-sdk-js/src/events.ts:424
Data received from this participant.
IsSpeakingChanged
Section titled “IsSpeakingChanged”IsSpeakingChanged: "isSpeakingChanged";Defined in: client-sdk-js/src/events.ts:408
The participant’s speaking status has changed.
LocalTrackPublished
Section titled “LocalTrackPublished”LocalTrackPublished: "localTrackPublished";Defined in: client-sdk-js/src/events.ts:385
A local track was published by this participant.
args: (publication: {@link LocalTrackPublication})
LocalTrackUnpublished
Section titled “LocalTrackUnpublished”LocalTrackUnpublished: "localTrackUnpublished";Defined in: client-sdk-js/src/events.ts:392
A local track was unpublished by this participant.
args: (publication: {@link LocalTrackPublication})
MetadataChanged
Section titled “MetadataChanged”MetadataChanged: "metadataChanged";Defined in: client-sdk-js/src/events.ts:395
The participant’s metadata has changed.
NameChanged
Section titled “NameChanged”NameChanged: "nameChanged";Defined in: client-sdk-js/src/events.ts:398
The participant’s display name has changed.
PermissionsChanged
Section titled “PermissionsChanged”PermissionsChanged: "permissionsChanged";Defined in: client-sdk-js/src/events.ts:414
The participant’s permissions have changed.
TrackMuted
Section titled “TrackMuted”TrackMuted: "trackMuted";Defined in: client-sdk-js/src/events.ts:361
One of the participant’s tracks has been muted.
TrackPublished
Section titled “TrackPublished”TrackPublished: "trackPublished";Defined in: client-sdk-js/src/events.ts:351
The participant has published a new track.
args: (publication: {@link TrackPublication})
TrackStreamStateChanged
Section titled “TrackStreamStateChanged”TrackStreamStateChanged: "trackStreamStateChanged";Defined in: client-sdk-js/src/events.ts:421
The stream state of a remote track changed (server paused/resumed forwarding).
args: (publication: {@link RemoteTrackPublication}, streamState: {@link StreamState})
TrackSubscribed
Section titled “TrackSubscribed”TrackSubscribed: "trackSubscribed";Defined in: client-sdk-js/src/events.ts:371
Subscribed to a new track from this participant.
args: (track: {@link RemoteTrack}, publication: {@link RemoteTrackPublication})
TrackUnmuted
Section titled “TrackUnmuted”TrackUnmuted: "trackUnmuted";Defined in: client-sdk-js/src/events.ts:364
One of the participant’s tracks has been unmuted.
TrackUnpublished
Section titled “TrackUnpublished”TrackUnpublished: "trackUnpublished";Defined in: client-sdk-js/src/events.ts:358
The participant has unpublished a track.
args: (publication: {@link TrackPublication})
TrackUnsubscribed
Section titled “TrackUnsubscribed”TrackUnsubscribed: "trackUnsubscribed";Defined in: client-sdk-js/src/events.ts:378
Unsubscribed from a track of this participant.
args: (track: {@link RemoteTrack}, publication: {@link RemoteTrackPublication})