ParticipantEvents
type ParticipantEvents<TPublication> = object;Defined in: client-sdk-js/src/participant/Participant.ts:115
Type Parameters
Section titled “Type Parameters”TPublication
Section titled “TPublication”TPublication extends TrackPublication = TrackPublication
Properties
Section titled “Properties”attributesChanged
Section titled “attributesChanged”attributesChanged: (changedAttributes, participant) => void;Defined in: client-sdk-js/src/participant/Participant.ts:132
Parameters
Section titled “Parameters”changedAttributes
Section titled “changedAttributes”Record<string, string>
participant
Section titled “participant”Participant<TPublication>
Returns
Section titled “Returns”void
chatMessage
Section titled “chatMessage”chatMessage: (message) => void;Defined in: client-sdk-js/src/participant/Participant.ts:144
Parameters
Section titled “Parameters”message
Section titled “message”Returns
Section titled “Returns”void
connectionQualityChanged
Section titled “connectionQualityChanged”connectionQualityChanged: (quality) => void;Defined in: client-sdk-js/src/participant/Participant.ts:137
Parameters
Section titled “Parameters”quality
Section titled “quality”Returns
Section titled “Returns”void
dataReceived
Section titled “dataReceived”dataReceived: (payload) => void;Defined in: client-sdk-js/src/participant/Participant.ts:143
Parameters
Section titled “Parameters”payload
Section titled “payload”Uint8Array
Returns
Section titled “Returns”void
isSpeakingChanged
Section titled “isSpeakingChanged”isSpeakingChanged: (speaking) => void;Defined in: client-sdk-js/src/participant/Participant.ts:136
Parameters
Section titled “Parameters”speaking
Section titled “speaking”boolean
Returns
Section titled “Returns”void
localTrackPublished
Section titled “localTrackPublished”localTrackPublished: (publication) => void;Defined in: client-sdk-js/src/participant/Participant.ts:122
Parameters
Section titled “Parameters”publication
Section titled “publication”TPublication
Returns
Section titled “Returns”void
localTrackUnpublished
Section titled “localTrackUnpublished”localTrackUnpublished: (publication) => void;Defined in: client-sdk-js/src/participant/Participant.ts:123
Parameters
Section titled “Parameters”publication
Section titled “publication”TPublication
Returns
Section titled “Returns”void
metadataChanged
Section titled “metadataChanged”metadataChanged: (metadata, participant) => void;Defined in: client-sdk-js/src/participant/Participant.ts:124
Parameters
Section titled “Parameters”metadata
Section titled “metadata”string | undefined
participant
Section titled “participant”Participant<TPublication>
Returns
Section titled “Returns”void
nameChanged
Section titled “nameChanged”nameChanged: (name, participant) => void;Defined in: client-sdk-js/src/participant/Participant.ts:128
Parameters
Section titled “Parameters”string | undefined
participant
Section titled “participant”Participant<TPublication>
Returns
Section titled “Returns”void
permissionsChanged
Section titled “permissionsChanged”permissionsChanged: (prevPermissions?) => void;Defined in: client-sdk-js/src/participant/Participant.ts:138
Parameters
Section titled “Parameters”prevPermissions?
Section titled “prevPermissions?”Returns
Section titled “Returns”void
trackMuted
Section titled “trackMuted”trackMuted: (publication) => void;Defined in: client-sdk-js/src/participant/Participant.ts:118
Parameters
Section titled “Parameters”publication
Section titled “publication”TPublication
Returns
Section titled “Returns”void
trackPublished
Section titled “trackPublished”trackPublished: (publication) => void;Defined in: client-sdk-js/src/participant/Participant.ts:116
Parameters
Section titled “Parameters”publication
Section titled “publication”TPublication
Returns
Section titled “Returns”void
trackStreamStateChanged
Section titled “trackStreamStateChanged”trackStreamStateChanged: (publication, streamState) => void;Defined in: client-sdk-js/src/participant/Participant.ts:139
Parameters
Section titled “Parameters”publication
Section titled “publication”TPublication
streamState
Section titled “streamState”Returns
Section titled “Returns”void
trackSubscribed
Section titled “trackSubscribed”trackSubscribed: (track, publication) => void;Defined in: client-sdk-js/src/participant/Participant.ts:120
Parameters
Section titled “Parameters”publication
Section titled “publication”TPublication
Returns
Section titled “Returns”void
trackUnmuted
Section titled “trackUnmuted”trackUnmuted: (publication) => void;Defined in: client-sdk-js/src/participant/Participant.ts:119
Parameters
Section titled “Parameters”publication
Section titled “publication”TPublication
Returns
Section titled “Returns”void
trackUnpublished
Section titled “trackUnpublished”trackUnpublished: (publication) => void;Defined in: client-sdk-js/src/participant/Participant.ts:117
Parameters
Section titled “Parameters”publication
Section titled “publication”TPublication
Returns
Section titled “Returns”void
trackUnsubscribed
Section titled “trackUnsubscribed”trackUnsubscribed: (track, publication) => void;Defined in: client-sdk-js/src/participant/Participant.ts:121
Parameters
Section titled “Parameters”publication
Section titled “publication”TPublication
Returns
Section titled “Returns”void