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(options: 
EndpointOptions
): 
Endpoint

Create new endpoint and add it to the specified conference. Important! You can only use this function for a conference with the “video conference” option checked in the rule. Otherwise, you'll 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

Get endpoint by the id

Parameters

  • id:

    string

    endpoint id

Returns

getList

Copy URL
getList(): 
Endpoint[]

Get endpoint list for current conference

Returns

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
, optional: 
SendMediaOptions
): 
void

Start sending media (voice and video) from this conference to media unit specified in targetCall.

Parameters

Returns

  • type:

    void

setMaxEndpointBitrate

Copy URL
setMaxEndpointBitrate(bitrate: 
number
): 
void

Parameters

  • bitrate:

    number

Returns

  • type:

    void

stop

Copy URL
stop(): 
void

Stop the conference. Triggers the ConferenceEvents.Stopped event.

Returns

  • type:

    void

stopMediaTo

Copy URL
stopMediaTo(mediaUnit: 
VoxMediaUnit
): 
void

Stop sending media (voice and video) from this conference to media unit specified in targetMediaUnit.

Parameters

  • mediaUnit:

    VoxMediaUnit

    media unit that does not receive media from this conference anymore.

Returns

  • type:

    void