EndpointListener
Interface that handles events of the remote participant in a conference call.
Methods
onRemoteVideoStreamAdded
fun onRemoteVideoStreamAdded(endpoint: , videoStream: ): Unit
Triggered after the endpoint has added the video stream.
Parameters
endpoint:
The endpoint that triggered this event
videoStream:
Remote video stream
Returns
type:
Unit
onRemoteVideoStreamRemoved
fun onRemoteVideoStreamRemoved(endpoint: , videoStream: ): Unit
Triggered after the endpoint has removed the video stream.
Event is not triggered on a conference end.
Parameters
endpoint:
The endpoint that triggered this event
videoStream:
Remote video stream
Returns
type:
Unit
onEndpointVoiceActivityChanged
fun onEndpointVoiceActivityChanged(endpoint: , voiceDetected: Boolean
): Unit
Triggered when a voice activity of the endpoint is detected or stopped in a conference call.
Parameters
endpoint:
The endpoint that triggered this event
voiceDetected:
Boolean
Whether the remote participant is currently talking
Returns
type:
Unit
onEndpointMuteStateChanged
fun onEndpointMuteStateChanged(endpoint: , muted: Boolean
): Unit
Triggered when a mute status of the enpoint is changed in a conference call.
The event is triggered as the result of Conference.muteAudio API call on an endpoint client.
Parameters
endpoint:
muted:
Boolean
Returns
type:
Unit
onStartReceivingVideoStream
fun onStartReceivingVideoStream(endpoint: , videoStream: ): Unit
Triggered when video receive on a remote video stream is started after previously being stopped.
The event is triggered if:
- Endpoint.startReceiveVideo has been called and the request has been processed successfully.
- 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 the endpoint client has started sending video via Conference.addVideoStream API.
Parameters
endpoint:
The endpoint that triggered this event
videoStream:
The remote video stream where video receive is started
Returns
type:
Unit
onStopReceivingVideoStream
fun onStopReceivingVideoStream(endpoint: , videoStream: , reason: ): Unit
Triggered when video receive on a remote video stream is stopped.
Video receive on a remote video stream can be stopped due to:
- Endpoint.stopReceiveVideo has been called and the request has been processed successfully. In this case the value of the "reason" parameter is VideoStreamReceiveStopReason.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 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 event is invoked.
The event is not triggered if the endpoint client has stopped sending video via Conference.removeVideoStream API.
Parameters
endpoint:
The endpoint that triggered this event
videoStream:
The remote video stream where video receive is stopped
reason:
The reason for the event, such as video receive is disabled by client or automatically
Returns
type:
Unit