ConferenceEvent
Constants
Connected
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
Disconnected
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 that the conference ended with
EndpointAdded
Triggered after an endpoint is added to a conference.
Listener is called with ConferenceEndpointAddedPayload and payload:
Parameters
conferenceId:
string
Conference id
newEndpointId:
string
Endpoint id
EndpointRemoved
Triggered after the endpoint is removed from a conference.
Listener is called with ConferenceEndpointRemoved and payload:
Parameters
conferenceId:
string
Conference id
removedEndpointId:
string
Endpoint id
Failed
Triggered if a conference has failed.
Listener is called with ConferenceFailed and payload:
Parameters
code:
number
Conference status code
conferenceId:
string
Conference id
headers:
Record<string, string>
OptionalOptional headers passed with the event
reason:
string
Conference failure reason
InfoReceived
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}/${string}
MIME type of an INFO message
MessageReceived
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
ScreenSharingFailed
Triggered when screen sharing has failed to start in a conference.
Listener is called with ConferenceScreenSharingFailed and payload:
Parameters
Conference screen sharing status code
conferenceId:
string
reason:
string
Conference screen sharing failure reason
ScreenSharingStarted
Triggered when screen sharing has started in a conference.
Listener is called with ConferenceScreenSharingStarted and payload:
Parameters
conferenceId:
string
Conference id
StatsReport
Triggered when conference statistics are available for a conference.
Listener is called with ConferenceStatsReport and payload:
Parameters
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<Endpoint.id, { 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.