SIGN UP

Conference

Represents audio and video conference

Methods

add(endpointOptions: EndpointOptions): Endpoint

Create new endpoint and add it to the specified conference.
Important! You can only use this function for a Standalone conference with checked “video conference” option in the rule. Otherwise, you'll receive the ConferenceEvents.ConferenceError event with code 102.
The maximum number of endpoints is 100.

Parameters

Returns

Examples

request:

Example for SDK (FORWARD mode is required):

 VoxEngine.addEventListener(AppEvents.CallAlerting, function (e) {
conf.add({
        call: e.call,
        mode: "FORWARD",
        direction:"BOTH", 
        scheme: e.scheme});
}

Example for PSTN (MIX mode is required):

 VoxEngine.addEventListener(AppEvents.CallAlerting, function (e) {
conf.add({
        call: e.call,
        mode: "MIX",
        direction:"BOTH", 
        scheme: e.scheme});
}
addEventListener(conferenceevent: Function, handler: Function): void

Adds handler for specific event generated by Conference. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler will be called.

Parameters

  • conferenceevent:

    Function

    Event class (i.e., ConferenceEvents.Stopped)

  • handler:

    Function

    Handler function. A single parameter is passed - object with event information

Returns

  • Return:

    void
get(id: string): Endpoint

Get endpoint by the id

Parameters

  • id:

    string

    endpoint id

Returns

getList(): Array

Get endpoint list for current conference

Returns

  • Return:

    Array
removeEventListener(conferenceevent: Function, handler: Function): void

Removes handler for specific event generated by Conference

Parameters

  • conferenceevent:

    Function

    Event class (i.e., ConferenceEvents.Stopped)

  • handler:

    Function
    Optional

    Handler function. If not specified, all event listeners are removed

Returns

  • Return:

    void
sendMediaTo(targetMediaUnit: Call|Conference): void

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

Parameters

Returns

  • Return:

    void
stop(): void

Stop the conference. Triggers the ConferenceEvents.Stopped event.

Returns

  • Return:

    void
stopMediaTo(targetMediaUnit: Call|Conference): void

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

Parameters

  • targetMediaUnit:

    Call|Conference

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

Returns

  • Return:

    void