EndpointEventTypes
Events that are triggered when Endpoint is updated/edited, removed or started/stopped to receive stream from another Endpoint.
Constants
InfoUpdated
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.
RemoteVideoStreamAdded
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 which endpoint belongs to
endpoint:
Endpoint that triggered the event
name:
string
Name of the event
videoStream:
Remote video stream added
RemoteVideoStreamRemoved
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 which endpoint belongs to
endpoint:
Endpoint that triggered the event
name:
string
Name of the event
videoStream:
Remote video stream removed
Removed
Event is triggered when an Endpoint is removed. The handler function receives an event with the following parameters as an argument.
StartReceiveVideoStream
Triggered when video receive on a remote video stream is started after previously being stopped. Available only for the conference calls. The event is triggered if:
- Endpoint.startReceiving was 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 using Call.sendVideo API.
Parameters
call:
The call which endpoint belongs to
endpoint:
The endpoint that triggered this event.
name:
string
The event name
videoStream:
The remote video stream where video receive is started
StopReceiveVideoStream
Triggered when video receive 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:
- Endpoint.stopReceiving was 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 [EndpointEventsTypes.StartReceiveVideoStream] will be invoked.
The event is not triggered if the endpoint client has stopped sending video using Call.sendVideo API.
Parameters
call:
The call which endpoint belongs to
endpoint:
The endpoint that triggered this event.
name:
string
Name of the event
reason:
The reason for the event, such as video receive is disabled by client or automatically
videoStream:
The remote video stream where video receive is stopped
VoiceActivityStarted
Event is triggered when a voice activity of the endpoint is detected in a conference call.