SIGN UP

ConferenceEvents

  • ConferenceError
    The event is triggered in case of problems in the conference. Error codes:
    CodeDescription
    100You have reached the maximum limit of endpoints in the conference
    101Endpoint with this id already exists
    102Attempt to enable FORWARD mode in two cases:
    1) without checked “video conference” option in the rule
    2) for Local conference
    103Attempt to turn on video in two cases:
    1) without checked “video conference” option in the rule
    2) for Local conference
  • EndpointAdded
    The event is triggered when the endpoint was added.
  • EndpointRemoved
    The event is triggered when the endpoint was removed.
  • Started
    The event is triggered when the conference has started. I.e., the call of [VoxEngine.createConference] triggers the event.
  • Stopped
    The event is triggered when the conference was stopped. I.e., the call of [Conference.stop] triggers the event.

Events

The event is triggered in case of problems in the conference. Error codes:

CodeDescription
100You have reached the maximum limit of endpoints in the conference
101Endpoint with this id already exists
102Attempt to enable FORWARD mode in two cases:
1) without checked “video conference” option in the rule
2) for Local conference
103Attempt to turn on video in two cases:
1) without checked “video conference” option in the rule
2) for Local conference

Parameters

  • code:

    number

    Error code

  • conference:

    Conference

    that triggered the event

  • endpointId:

    string

    id of a endpoint who caused the error

  • error:

    string

    Error description

The event is triggered when the endpoint was added.

Parameters

  • conference:

    Conference

    that triggered the event

  • direction:

    StringOptional

    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 added endpoint.

  • endpointId:

    String

    The unique ID of endpoint.

  • mode:

    StringOptional

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

The event is triggered when the endpoint was removed.

Parameters

  • conference:

    Conference

    that triggered the event

  • direction:

    StringOptional

    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 removed endpoint.

  • endpointId:

    String

    The unique ID of endpoint.

  • mode:

    StringOptional

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

The event is triggered when the conference has started. I.e., the call of VoxEngine.createConference triggers the event.

Parameters

The event is triggered when the conference was stopped. I.e., the call of Conference.stop triggers the event.

Parameters

  • conference:

    Conference

    that triggered the event

  • cost:

    string

    Conference cost

  • duration:

    string

    Conference duration