Rate this page:

EndpointEventTypes

Events that are triggered when Endpoint is updated/edited, removed or started/stopped to receive stream from another Endpoint.

Constants

InfoUpdated

Copy URL

Event is triggered when endpoint information such as display name, user name and sip uri is updated. The handler function receives an event with the following parameters as an argument.

Parameters

  • call:

    Call

    Call which endpoint belongs to

  • endpoint:

    Endpoint

    Endpoint that triggered the event

  • name:

    string

    Name of the event

RemoteVideoStreamAdded

Copy URL

Event is triggered after endpoint added video stream to the call. The handler function receives an event with the following parameters as an argument.

Parameters

  • call:

    Call

    Call which endpoint belongs to

  • endpoint:

    Endpoint

    Endpoint that triggered the event

  • name:

    string

    Name of the event

  • videoStream:

    VideoStream

    Remote video stream added

RemoteVideoStreamRemoved

Copy URL

Event is triggered after endpoint removed video stream from the call. Event is not triggered on call end. The handler function receives an event with the following parameters as an argument.

Parameters

  • call:

    Call

    Call which endpoint belongs to

  • endpoint:

    Endpoint

    Endpoint that triggered the event

  • name:

    string

    Name of the event

  • videoStream:

    VideoStream

    Remote video stream removed

Removed

Copy URL

Event is triggered when an Endpoint is removed. The handler function receives an event with the following parameters as an argument.

Parameters

  • call:

    Call

    Call which endpoint belongs to

  • endpoint:

    Endpoint

    Endpoint that triggered the event

  • name:

    string

    Name of the event