ConferenceEvent
Constants
Triggered after a conference has been successfully connected.
Listener is called with ConferenceConnected and payload:
Parameters
conferenceId:
string
Conference id.
headers:
Record<string, string>
OptionalOptional headers passed with the event
Triggered after a conference has been disconnected.
Listener is called with ConferenceDisconnected and payload:
Parameters
conferenceId:
string
Conference id.
headers:
Record<string, string>
OptionalOptional headers passed with the event
reason:
Reason why the conference ended
Triggered after an endpoint is added to a conference.
Listener is called with ConferenceEndpointAdded and payload:
Parameters
conferenceId:
string
Conference id.
endpointId:
string
Endpoint id
Triggered after an endpoint is removed from a conference.
Listener is called with ConferenceEndpointRemoved and payload:
Parameters
conferenceId:
string
Conference id.
endpointId:
string
Endpoint id
Triggered if a conference has failed.
Listener is called with ConferenceFailed and payload:
Parameters
code:
number
Conference failure status code
conferenceId:
string
Conference id.
headers:
Record<string, string>
OptionalOptional headers passed with the event
reason:
string
OptionalConference failure reason
Triggered when an INFO message is received within a conference.
Listener is called with ConferenceInfoReceived and payload:
Parameters
body:
string
Body of an INFO message
conferenceId:
string
Conference id.
headers:
Record<string, string>
OptionalOptional headers passed with the event
mimeType:
string
MIME type of an INFO message
Triggered when a message is received within a conference.
Listener is called with ConferenceMessageReceived and payload:
Parameters
conferenceId:
string
Conference id.
text:
string
Content of the message
Triggered when conference statistics are available for a conference.
Listener is called with ConferenceStatsReceived and payload:
Parameters
conferenceId:
string
Conference id.
connection:
Media connectivity statistics
localAudio:
Statistics for all active outgoing audio streams in a conference at the moment of the statistics collection
localVideo:
Statistics for all active outgoing video streams in a conference at the moment of the statistics collection
remote:
Record<Watchable, { audio: RemoteAudioStreamStatsReport, video: RemoteVideoStreamStatsReport }>
Endpoint statistics
timestamp:
number
Time at which the conference statistics are collected, relative to the UNIX epoch (Jan 1, 1970, UTC), in microseconds