Rate this page:

EndpointEvent

Constants

RemoteVideoStreamAdded
Copy URL

Triggered after an endpoint has added a remote video stream.

Listener is called with EndpointRemoteVideoStreamAdded and payload:

Parameters

RemoteVideoStreamRemoved
Copy URL

Triggered after an endpoint has removed a remote video stream.

Listener is called with EndpointRemoteVideoStreamRemoved and payload:

Parameters

StartReceivingVideoStream
Copy URL

Triggered when receiving video on a remote video stream is started after previously being stopped.

The event is triggered if:

  • Endpoint.startReceivingVideo has been called and the request has been processed successfully.
  • A network issue that caused the Voximplant Cloud to stop receiving video of the remote video stream is gone.

Listener is called with EndpointStartReceivingVideoStream and payload:

Parameters

  • endpointId:

    string

    Endpoint id.

  • streamId:

    string

    Remote video stream id

StopReceivingVideoStream
Copy URL

Triggered when receiving video on a remote video stream is stopped.

Receiving video on a remote video stream can be stopped due to:

If receiving video 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 EndpointStartReceivingVideoStream event is triggered.

Listener is called with EndpointStopReceivingVideoStream and payload:

Parameters

Rate this page: