1. References
  2. VoxEngine
  3. Conference
Rate this page:

Conference

Represents audio or video conference.
Add the following line to your scenario code to use the class:

require(Modules.Conference);

Methods

add

Copy URL
add(parameters: 
EndpointParameters
): 
Endpoint

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

Returns

addEventListener

Copy URL
addEventListener(event: 
ConferenceEvents
, callback: 
Function
): 
void

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

Returns

  • type:

    void

get

Copy URL
get(id: 
string
): 
Endpoint

Gets the endpoint by the id.

Parameters

  • id:

    string

    Endpoint's id

Returns

getList

Copy URL
getList(): 
Endpoint[]

Gets the endpoint list for current conference.

Returns

id

Copy URL
id(): 
string

Returns the conference's id.

Returns

  • type:

    string

removeEventListener

Copy URL
removeEventListener(event: 
ConferenceEvents
, callback: 
Function
): 
void

Removes a handler for the specified ConferenceEvents event.

Parameters

Returns

  • type:

    void

sendMediaTo

Copy URL
sendMediaTo(mediaUnit: 
VoxMediaUnit
, parameters: 
SendMediaParameters
): 
void

Starts sending media (voice and video) from the conference to the media unit.

Parameters

Returns

  • type:

    void

stop

Copy URL
stop(): 
void

Stops the conference. Triggers the ConferenceEvents.Stopped event.

Returns

  • type:

    void

stopMediaTo

Copy URL
stopMediaTo(mediaUnit: 
VoxMediaUnit
): 
void

Stops sending media (voice and video) from the conference to the media unit.

Parameters

  • mediaUnit:

    VoxMediaUnit

    Media unit that does not need to receive media from this conference anymore

Returns

  • type:

    void