RoomEvents
type RoomEvents = object;Defined in: client-sdk-js/src/Room.ts:77
Properties
Section titled “Properties”activeDeviceChanged
Section titled “activeDeviceChanged”activeDeviceChanged: (kind, deviceId) => void;Defined in: client-sdk-js/src/Room.ts:152
Parameters
Section titled “Parameters”MediaDeviceKind
deviceId
Section titled “deviceId”string
Returns
Section titled “Returns”void
activeSpeakersChanged
Section titled “activeSpeakersChanged”activeSpeakersChanged: (speakers) => void;Defined in: client-sdk-js/src/Room.ts:142
Parameters
Section titled “Parameters”speakers
Section titled “speakers”Returns
Section titled “Returns”void
audioPlaybackChanged
Section titled “audioPlaybackChanged”audioPlaybackChanged: (canPlayback) => void;Defined in: client-sdk-js/src/Room.ts:149
Parameters
Section titled “Parameters”canPlayback
Section titled “canPlayback”boolean
Returns
Section titled “Returns”void
chatMessage
Section titled “chatMessage”chatMessage: (message, participant?) => void;Defined in: client-sdk-js/src/Room.ts:158
Parameters
Section titled “Parameters”message
Section titled “message”participant?
Section titled “participant?”Returns
Section titled “Returns”void
connected
Section titled “connected”connected: () => void;Defined in: client-sdk-js/src/Room.ts:78
Returns
Section titled “Returns”void
connectionQualityChanged
Section titled “connectionQualityChanged”connectionQualityChanged: (quality, participant) => void;Defined in: client-sdk-js/src/Room.ts:145
Parameters
Section titled “Parameters”quality
Section titled “quality”participant
Section titled “participant”Returns
Section titled “Returns”void
connectionStateChanged
Section titled “connectionStateChanged”connectionStateChanged: (state) => void;Defined in: client-sdk-js/src/Room.ts:82
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
dataReceived
Section titled “dataReceived”dataReceived: (payload, participant?) => void;Defined in: client-sdk-js/src/Room.ts:144
Parameters
Section titled “Parameters”payload
Section titled “payload”Uint8Array
participant?
Section titled “participant?”Returns
Section titled “Returns”void
dataTrackPublished
Section titled “dataTrackPublished”dataTrackPublished: (dataTrack, participant) => void;Defined in: client-sdk-js/src/Room.ts:109
Parameters
Section titled “Parameters”dataTrack
Section titled “dataTrack”participant
Section titled “participant”Returns
Section titled “Returns”void
dataTrackUnpublished
Section titled “dataTrackUnpublished”dataTrackUnpublished: (dataTrackSid, participant) => void;Defined in: client-sdk-js/src/Room.ts:113
Parameters
Section titled “Parameters”dataTrackSid
Section titled “dataTrackSid”string
participant
Section titled “participant”Returns
Section titled “Returns”void
disconnected
Section titled “disconnected”disconnected: (reason?) => void;Defined in: client-sdk-js/src/Room.ts:79
Parameters
Section titled “Parameters”reason?
Section titled “reason?”Returns
Section titled “Returns”void
groupCreated
Section titled “groupCreated”groupCreated: (group) => void;Defined in: client-sdk-js/src/Room.ts:176
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
groupDeleted
Section titled “groupDeleted”groupDeleted: (groupId) => void;Defined in: client-sdk-js/src/Room.ts:178
Parameters
Section titled “Parameters”groupId
Section titled “groupId”string
Returns
Section titled “Returns”void
groupParticipantJoined
Section titled “groupParticipantJoined”groupParticipantJoined: (groupId, participant) => void;Defined in: client-sdk-js/src/Room.ts:179
Parameters
Section titled “Parameters”groupId
Section titled “groupId”string
participant
Section titled “participant”Returns
Section titled “Returns”void
groupParticipantLeft
Section titled “groupParticipantLeft”groupParticipantLeft: (groupId, participant) => void;Defined in: client-sdk-js/src/Room.ts:180
Parameters
Section titled “Parameters”groupId
Section titled “groupId”string
participant
Section titled “participant”Returns
Section titled “Returns”void
groupUpdated
Section titled “groupUpdated”groupUpdated: (group) => void;Defined in: client-sdk-js/src/Room.ts:177
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
localAudioSilenceDetected
Section titled “localAudioSilenceDetected”localAudioSilenceDetected: () => void;Defined in: client-sdk-js/src/Room.ts:141
Returns
Section titled “Returns”void
localTrackPublished
Section titled “localTrackPublished”localTrackPublished: (publication, participant) => void;Defined in: client-sdk-js/src/Room.ts:133
Parameters
Section titled “Parameters”publication
Section titled “publication”participant
Section titled “participant”Returns
Section titled “Returns”void
localTrackUnpublished
Section titled “localTrackUnpublished”localTrackUnpublished: (publication, participant) => void;Defined in: client-sdk-js/src/Room.ts:137
Parameters
Section titled “Parameters”publication
Section titled “publication”participant
Section titled “participant”Returns
Section titled “Returns”void
mediaDevicesChanged
Section titled “mediaDevicesChanged”mediaDevicesChanged: () => void;Defined in: client-sdk-js/src/Room.ts:84
Returns
Section titled “Returns”void
mediaDevicesError
Section titled “mediaDevicesError”mediaDevicesError: (error) => void;Defined in: client-sdk-js/src/Room.ts:85
Parameters
Section titled “Parameters”Error
Returns
Section titled “Returns”void
messageDeleted
Section titled “messageDeleted”messageDeleted: (ids, type?) => void;Defined in: client-sdk-js/src/Room.ts:159
Parameters
Section titled “Parameters”string[]
string
Returns
Section titled “Returns”void
participantAttributesChanged
Section titled “participantAttributesChanged”participantAttributesChanged: (changed, participant) => void;Defined in: client-sdk-js/src/Room.ts:97
Parameters
Section titled “Parameters”changed
Section titled “changed”Record<string, string>
participant
Section titled “participant”Returns
Section titled “Returns”void
participantConnected
Section titled “participantConnected”participantConnected: (participant) => void;Defined in: client-sdk-js/src/Room.ts:86
Parameters
Section titled “Parameters”participant
Section titled “participant”Returns
Section titled “Returns”void
participantDisconnected
Section titled “participantDisconnected”participantDisconnected: (participant, reason?) => void;Defined in: client-sdk-js/src/Room.ts:87
Parameters
Section titled “Parameters”participant
Section titled “participant”reason?
Section titled “reason?”Returns
Section titled “Returns”void
participantMetadataChanged
Section titled “participantMetadataChanged”participantMetadataChanged: (prevMetadata, participant) => void;Defined in: client-sdk-js/src/Room.ts:92
Parameters
Section titled “Parameters”prevMetadata
Section titled “prevMetadata”string | undefined
participant
Section titled “participant”Returns
Section titled “Returns”void
participantNameChanged
Section titled “participantNameChanged”participantNameChanged: (name, participant) => void;Defined in: client-sdk-js/src/Room.ts:96
Parameters
Section titled “Parameters”string
participant
Section titled “participant”Returns
Section titled “Returns”void
participantPermissionsChanged
Section titled “participantPermissionsChanged”participantPermissionsChanged: (prevPermissions, participant) => void;Defined in: client-sdk-js/src/Room.ts:154
Parameters
Section titled “Parameters”prevPermissions
Section titled “prevPermissions”| ParticipantPermission
| undefined
participant
Section titled “participant”Returns
Section titled “Returns”void
participantUpdated
Section titled “participantUpdated”participantUpdated: (participant) => void;Defined in: client-sdk-js/src/Room.ts:91
Parameters
Section titled “Parameters”participant
Section titled “participant”Returns
Section titled “Returns”void
reconnected
Section titled “reconnected”reconnected: () => void;Defined in: client-sdk-js/src/Room.ts:81
Returns
Section titled “Returns”void
reconnecting
Section titled “reconnecting”reconnecting: () => void;Defined in: client-sdk-js/src/Room.ts:80
Returns
Section titled “Returns”void
recordingStatusChanged
Section titled “recordingStatusChanged”recordingStatusChanged: (recording) => void;Defined in: client-sdk-js/src/Room.ts:153
Parameters
Section titled “Parameters”recording
Section titled “recording”boolean
Returns
Section titled “Returns”void
roomMetadataChanged
Section titled “roomMetadataChanged”roomMetadataChanged: (metadata) => void;Defined in: client-sdk-js/src/Room.ts:143
Parameters
Section titled “Parameters”metadata
Section titled “metadata”string | undefined
Returns
Section titled “Returns”void
signalConnected
Section titled “signalConnected”signalConnected: () => void;Defined in: client-sdk-js/src/Room.ts:151
Returns
Section titled “Returns”void
signalReconnecting
Section titled “signalReconnecting”signalReconnecting: () => void;Defined in: client-sdk-js/src/Room.ts:83
Returns
Section titled “Returns”void
stateDeleted
Section titled “stateDeleted”stateDeleted: (key, participantSid?, participantIdentity?) => void;Defined in: client-sdk-js/src/Room.ts:166
Parameters
Section titled “Parameters”string
participantSid?
Section titled “participantSid?”string
participantIdentity?
Section titled “participantIdentity?”string
Returns
Section titled “Returns”void
stateUpdated
Section titled “stateUpdated”stateUpdated: (key, value, participantSid?, participantIdentity?) => void;Defined in: client-sdk-js/src/Room.ts:160
Parameters
Section titled “Parameters”string
string
participantSid?
Section titled “participantSid?”string
participantIdentity?
Section titled “participantIdentity?”string
Returns
Section titled “Returns”void
tokenRefreshed
Section titled “tokenRefreshed”tokenRefreshed: (token) => void;Defined in: client-sdk-js/src/Room.ts:181
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
trackMuted
Section titled “trackMuted”trackMuted: (publication, participant) => void;Defined in: client-sdk-js/src/Room.ts:125
Parameters
Section titled “Parameters”publication
Section titled “publication”| LocalTrackPublication
| RemoteTrackPublication
participant
Section titled “participant”Returns
Section titled “Returns”void
trackPublished
Section titled “trackPublished”trackPublished: (publication, participant) => void;Defined in: client-sdk-js/src/Room.ts:101
Parameters
Section titled “Parameters”publication
Section titled “publication”participant
Section titled “participant”Returns
Section titled “Returns”void
trackStreamStateChanged
Section titled “trackStreamStateChanged”trackStreamStateChanged: (publication, streamState, participant) => void;Defined in: client-sdk-js/src/Room.ts:171
Parameters
Section titled “Parameters”publication
Section titled “publication”streamState
Section titled “streamState”participant
Section titled “participant”Returns
Section titled “Returns”void
trackSubscribed
Section titled “trackSubscribed”trackSubscribed: (track, publication, participant) => void;Defined in: client-sdk-js/src/Room.ts:114
Parameters
Section titled “Parameters”publication
Section titled “publication”participant
Section titled “participant”Returns
Section titled “Returns”void
trackSubscriptionFailed
Section titled “trackSubscriptionFailed”trackSubscriptionFailed: (trackSid, participant) => void;Defined in: client-sdk-js/src/Room.ts:119
Parameters
Section titled “Parameters”trackSid
Section titled “trackSid”string
participant
Section titled “participant”Returns
Section titled “Returns”void
trackUnmuted
Section titled “trackUnmuted”trackUnmuted: (publication, participant) => void;Defined in: client-sdk-js/src/Room.ts:129
Parameters
Section titled “Parameters”publication
Section titled “publication”| LocalTrackPublication
| RemoteTrackPublication
participant
Section titled “participant”Returns
Section titled “Returns”void
trackUnpublished
Section titled “trackUnpublished”trackUnpublished: (publication, participant) => void;Defined in: client-sdk-js/src/Room.ts:105
Parameters
Section titled “Parameters”publication
Section titled “publication”participant
Section titled “participant”Returns
Section titled “Returns”void
trackUnsubscribed
Section titled “trackUnsubscribed”trackUnsubscribed: (track, publication, participant) => void;Defined in: client-sdk-js/src/Room.ts:120
Parameters
Section titled “Parameters”publication
Section titled “publication”participant
Section titled “participant”Returns
Section titled “Returns”void
videoPlaybackChanged
Section titled “videoPlaybackChanged”videoPlaybackChanged: (canPlayback) => void;Defined in: client-sdk-js/src/Room.ts:150
Parameters
Section titled “Parameters”canPlayback
Section titled “canPlayback”boolean
Returns
Section titled “Returns”void