ConferenceEvents
Add the following line to your scenario code to use the events:
require(Modules.Conference);
Constants
ConferenceError
Triggers in case of errors in the conference.
Parameters
code:
number
Error code.
conference:
Conference that triggered the event.
endpointId:
string
OptionalOptional. The id of the endpoint that caused the error.
error:
string
Error description.
EndpointAdded
Triggered when the endpoint is added.
Parameters
conference:
Conference that triggered the event.
direction:
SEND
SEND provides only outgoing stream from endpoint to conference; RECEIVE provides only incoming stream from conference to endpoint; BOTH allows both incoming and outgoing streams.
endpoint:
The endpoint object.
endpointId:
string
The unique ID of the endpoint.
mode:
MIX
MIX mode combines all streams in one, FORWARD mode sends only one stream.
EndpointManaged
Triggered when the endpoint is manged.
Parameters
conference:
Conference that triggered the event.
direction:
SEND
SEND provides only outgoing stream from endpoint to conference; RECEIVE provides only incoming stream from conference to endpoint; BOTH allows both incoming and outgoing streams.
endpoint:
The endpoint object.
endpointId:
string
The unique ID of the endpoint.
mode:
MIX
MIX mode combines all streams in one, FORWARD mode sends only one stream.
EndpointRemoved
Triggered when the endpoint is removed.
Parameters
conference:
Conference that triggered the event.
direction:
SEND
SEND provides only outgoing stream from endpoint to conference; RECEIVE provides only incoming stream from conference to endpoint; BOTH allows both incoming and outgoing streams.
endpoint:
The endpoint object.
endpointId:
string
The unique ID of the endpoint.
mode:
MIX
MIX mode combines all streams in one, FORWARD mode sends only one stream.
EndpointUpdated
Triggered when the endpoint is updated.
Parameters
conference:
Conference that triggered the event.
direction:
SEND
SEND provides only outgoing stream from endpoint to conference; RECEIVE provides only incoming stream from conference to endpoint; BOTH allows both incoming and outgoing streams.
endpoint:
The endpoint object.
endpointId:
string
The unique ID of the endpoint.
mode:
MIX
MIX mode combines all streams in one, FORWARD mode sends only one stream.
Started
Triggered when the conference has started. I.e., the call of VoxEngine.createConference triggers the event.
Parameters
conference:
Conference that triggered the event.
Stopped
Triggered when the conference is stopped. I.e., the call of Conference.stop triggers the event.
Parameters
conference:
Conference that triggered the event.