Conference
Represents audio or video conference.
Add the following line to your scenario code to use the class:
require(Modules.Conference);
Methods
add
add( parameters)Creates a new Endpoint instance and adds it to the specified conference. IMPORTANT! You can only use this function for a conference with the “video conference” option checked in the routing rule. Otherwise, you receive the ConferenceEvents.ConferenceError event with code 102. The maximum number of endpoints is 100.
Parameters
parameters:
Endpoint parameters
Returns
type:
addEventListener
void
addEventListener( event, Function
callback)Adds a handler for the specified ConferenceEvents event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.
Parameters
event:
Event class (i.e., ConferenceEvents.Started)
callback:
Function
Handler function. A single parameter is passed - object with event information
Returns
type:
void
get
get(string
id)Gets the endpoint by the id.
Parameters
id:
string
Endpoint's id
Returns
type:
id
string
id()Returns the conference's id.
Returns
type:
string
removeEventListener
void
removeEventListener( event, Function
callback)Removes a handler for the specified ConferenceEvents event.
Parameters
event:
Event class (i.e., ConferenceEvents.Started)
callback:
Function
OptionalOptional. Handler function. If not specified, all handler functions are removed
Returns
type:
void
sendMediaTo
void
sendMediaTo( mediaUnit, parameters)Starts sending media (voice and video) from the conference to the media unit.
Parameters
mediaUnit:
Media unit that receives media
parameters:
OptionalOptional. WebSocket interaction only parameters
Returns
type:
void
stopMediaTo
void
stopMediaTo( mediaUnit)Stops sending media (voice and video) from the conference to the media unit.
Parameters
mediaUnit:
Media unit that does not need to receive media from this conference anymore
Returns
type:
void