Rate this page:

EndpointEventTypes

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

Constants

InfoUpdated

Copy URL

Triggered when the endpoint information such as display name, user name and sip uri is updated. Handler function receives the 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

Triggered after an endpoint has added video stream to a call. Handler function receives the 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

Triggered after an endpoint has removed video stream from a call. Event is not triggered on call end. Handler function receives the 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

Triggered when an endpoint is removed. Handler function receives the 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.

StartReceiveVideoStream

Copy URL

Triggered when video receiving on a remote video stream is started after previously being stopped. Available only for the conference calls. The event is triggered if:

  1. Endpoint.startReceiving has been called and the request has been processed successfully.
  2. A network issue that caused the Voximplant cloud to stop video receive of the remote video stream is gone.

The event is not triggered if an endpoint that client has started sending video via the Call.sendVideo API.

Parameters

  • call:

    Call

    Call which endpoint belongs to.

  • endpoint:

    Endpoint

    Endpoint that triggered this event.

  • name:

    string

    Name of the event.

  • videoStream:

    VideoStream

    Remote video stream where video receive is started.

StopReceiveVideoStream

Copy URL

Triggered when video receiving on a remote video stream is stopped. Available only for the conference calls. Video receive on a remote video stream can be stopped due to:

  1. Endpoint.stopReceiving has been called and the request has been processed successfully. In this case the value of the "reason" parameter is VideoStreamReceiveStopReason.MANUAL
  2. Voximplant cloud has detected a network issue on the client and automatically stopped the video. In this case the value of the "reason" parameter is VideoStreamReceiveStopReason.AUTOMATIC

If the video receive is disabled automatically, it may be automatically enabled as soon as the network condition on the device is good and there is enough bandwidth to receive the video on this remote video stream. In this case the [EndpointEventsTypes.StartReceiveVideoStream] event is triggered.

The event is not triggered if an endpoint that client has stopped sending video via the Call.sendVideo API.

Parameters

  • call:

    Call

    Call which endpoint belongs to.

  • endpoint:

    Endpoint

    Endpoint that triggered this event.

  • name:

    string

    Name of the event.

  • Reason for the event, such as video receive is disabled by client or automatically.

  • videoStream:

    VideoStream

    Remote video stream where video receive is stopped.

VoiceActivityStarted

Copy URL

Triggered when a voice activity of an endpoint is detected in a conference call.

Parameters

  • call:

    Call

    Call which endpoint belongs to.

  • endpoint:

    Endpoint

    Endpoint that triggered the event.

  • name:

    string

    Name of the event.

VoiceActivityStopped

Copy URL

Triggered when a voice activity of an endpoint is stopped in a conference call.

Parameters

  • call:

    Call

    Call which endpoint belongs to.

  • endpoint:

    Endpoint

    Endpoint that triggered the event.

  • name:

    string

    Name of the event.