ConferenceEvents
Add the following line to your scenario code to use the events:
require(Modules.Conference);
Constants
ConferenceError
The event is triggered in case of problems in the conference.
Parameters
code:
number
Error code
conference:
Conference that triggered the event
endpointId:
undefined
Optionalid of a endpoint who caused the error
error:
string
Error description
EndpointAdded
The event is triggered when the endpoint was added.
Parameters
conference:
Conference that triggered the event
direction:
SEND
Possible values are SEND | RECEIVE | BOTH. SEND provides only sending stream from endpoint to conference; RECEIVE provides only receiving stream from conference to endpoint; BOTH allows both sending and receiving.
endpoint:
endpointId:
string
The unique ID of an endpoint.
mode:
MIX
Possible values are MIX | FORWARD. MIX mode combines all streams in one, FORWARD mode sends only one stream.
EndpointRemoved
The event is triggered when the endpoint was removed.
Parameters
conference:
Conference that triggered the event
direction:
SEND
Possible values are SEND | RECEIVE | BOTH. SEND provides only sending stream from endpoint to conference; RECEIVE provides only receiving stream from conference to endpoint; BOTH allows both sending and receiving.
endpoint:
endpointId:
string
The unique ID of an endpoint.
mode:
MIX
Possible values are MIX | FORWARD. MIX mode combines all streams in one, FORWARD mode sends only one stream.
EndpointUpdated
The event is triggered when the endpoint was updated.
Parameters
conference:
Conference that triggered the event
direction:
SEND
Possible values are SEND | RECEIVE | BOTH. SEND provides only sending stream from endpoint to conference; RECEIVE provides only receiving stream from conference to endpoint; BOTH allows both sending and receiving.
endpoint:
endpointId:
string
The unique ID of an endpoint.
mode:
MIX
Possible values are MIX | FORWARD. MIX mode combines all streams in one, FORWARD mode sends only one stream.
Started
The event is triggered when the conference has started. I.e., the call of VoxEngine.createConference triggers the event.
Parameters
conference:
Conference that triggered the event
Stopped
The event is triggered when the conference was stopped. I.e., the call of Conference.stop triggers the event.
Parameters
conference:
Conference that triggered the event
cost:
string
Conference cost
duration:
string
Conference duration