Rate this page:

ConferenceEvents

Add the following line to your scenario code to use the events:

require(Modules.Conference);

Constants

ConferenceError

Copy URL

Triggers in case of errors in the conference.

Parameters

  • code:

    number

    Error code

  • conference:

    Conference

    Conference that triggered the event

  • endpointId:

    string

    Optional

    Optional. The id of the endpoint that caused the error

  • error:

    string

    Error description

EndpointAdded

Copy URL

Triggered when the endpoint is added.

Parameters

  • conference:

    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:

    Endpoint

    The endpoint object.

  • endpointId:

    string

    The unique ID of the endpoint.

  • mode:

    MIX

    Possible values are MIX | FORWARD. MIX mode combines all streams in one, FORWARD mode sends only one stream.

EndpointRemoved

Copy URL

Triggered when the endpoint is removed.

Parameters

  • conference:

    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:

    Endpoint

    The endpoint object.

  • endpointId:

    string

    The unique ID of the endpoint.

  • mode:

    MIX

    Possible values are MIX | FORWARD. MIX mode combines all streams in one, FORWARD mode sends only one stream.

EndpointUpdated

Copy URL

Triggered when the endpoint is updated.

Parameters

  • conference:

    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:

    Endpoint

    The endpoint object.

  • endpointId:

    string

    The unique ID of the endpoint.

  • mode:

    MIX

    Possible values are MIX | FORWARD. MIX mode combines all streams in one, FORWARD mode sends only one stream.

Started

Copy URL

Triggered when the conference has started. I.e., the call of VoxEngine.createConference triggers the event.

Parameters

  • conference:

    Conference

    Conference that triggered the event

Stopped

Copy URL

Triggered when the conference is stopped. I.e., the call of Conference.stop triggers the event.

Parameters

  • conference:

    Conference

    Conference that triggered the event

  • cost:

    string

    Conference cost

  • duration:

    string

    Conference duration