EndpointEvent
Constants
RemoteMediaAdded
Triggered after an endpoint has added an audio or video stream.
Listener is called with EndpointRemoteMediaAdded and payload:
Parameters
endpointId:
string
Endpoint id.
stream:
Remote audio or video stream.
type:
Remote stream type.
RemoteMediaRemoved
Triggered after an endpoint has removed an audio or video stream.
Listener is called with EndpointRemoteMediaRemoved and payload:
Parameters
endpointId:
string
Endpoint id.
stream:
Remote audio or video stream.
type:
Remote stream type.
StartReceivingAudioStream
Triggered when receiving video on a remote video stream is started after previously being stopped.
Listener is called with EndpointStartReceivingAudioStream and payload:
Parameters
endpointId:
string
Endpoint id.
streamId:
string
Remote audio stream id.
StartReceivingVideoStream
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.
The event is not triggered if the endpoint client has started sending video via the Conference.addStream API.
Listener is called with EndpointStartReceivingVideoStream and payload:
Parameters
endpointId:
string
Endpoint id.
streamId:
string
Remote video stream id.
StopReceivingAudioStream
Triggered when receiving audio on a remote audio stream is stopped.
Listener is called with EndpointStopReceivingAudioStream and payload:
Parameters
endpointId:
string
Endpoint id.
reason:
Reason for the event, such as receiving audio, is disabled by the client or automatically.
streamId:
string
Remote audio stream id.
StopReceivingVideoStream
Triggered when receiving video on a remote video stream is stopped.
Receiving video on a remote video stream can be stopped due to:
- Endpoint.stopReceivingVideo has been called and the request has been processed successfully. In this case the value of the “reason” parameter is StreamReceiveStopReason.Manual.
- 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 StreamReceiveStopReason.Automatic.
If the 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 EndpointEvent.StartReceivingVideoStream event is triggered.
The event is not triggered if the endpoint client has stopped sending video via the Conference.removeStream API.
Listener is called with EndpointStopReceivingVideoStream and payload:
Parameters
endpointId:
string
Endpoint id.
reason:
Reason for the event, such as receiving video, is disabled by the client or automatically.
streamId:
string
Remote video stream id.