Endpoint
Interface that represents a remote participant in a conference.
Methods
Registers a handler for the specified event.
One event can have more than one handler; handlers are executed in order of their registration.
Parameters
eventName:
Event name
listener:
(event: AnyEndpointEvent) => void | Promise<void>
Handler function that is triggered when an event of the specified type occurs
options:
Object that specifies characteristics about the event listener
Returns
type:
void
Removes a previously registered handler for the specified event.
Parameters
eventName:
Event name
listener:
(event: AnyEndpointEvent) => void | Promise<void>
Handler function to remove from the event target
Returns
type:
void
Requests the specified video size for a remote video stream.
The stream resolution may be changed to the closest to the specified width and height.
It only makes an impact if the endpoint has enabled the simulcast feature.
Parameters
streamId:
string
Remote video stream id
size:
Requested video frame width and height
Returns
type:
Promise<void>
Throws
CallInvalidArgumentError If the video stream is not found or the requested width or height is not positive
Starts receiving video from the specified remote video stream.
If video is already being received, this method call is ignored.
If the request is processed successfully, the EndpointStartReceivingVideoStream event is triggered.
Parameters
streamId:
string
Remote video stream id
Returns
type:
void
Stops receiving video from the specified remote video stream.
If the request is processed successfully, the EndpointStopReceivingVideoStream event is triggered with the VideoStreamReceiveStopReason.Manual reason.
Parameters
streamId:
string
Remote video stream id
Returns
type:
void
Props
Watchable property that allows getting the remote audio streams associated with the endpoint and observing its changes
Endpoint user display name
Endpoint id
Watchable property that allows getting the remote participant mute status and observing its changes
Watchable property that allows getting the voice activity status of the remote participant and observing its changes
Endpoint SIP URI
Endpoint user name
Watchable property that allows getting the remote video streams associated with the endpoint and observing its changes