Endpoint
Interface that represents any remote media unit in a call. Current endpoints can be retrieved via the Call.getEndpoints method. Endpoint can be :
Methods
off
off(event: EndpointEvents, handler: (ev: any) => void): voidRemove a handler for the specified event. The method is a shorter equivalent for removeEventListener. If a number of events has the same function as a handler, the method can be called multiple times with the same handler argument.
Parameters
event:
EndpointEvents- OPTIONAL
handler:
(ev: any) => void
Type declaration
(ev: any) => voidParameters
ev:
any
Returns
Return:
void
on
on(event: EndpointEvents, handler: (ev: any) => void, options: EventListenerOption): voidRegister a handler for the specified event. The method is a shorter equivalent for addEventListener. One event can have more than one handler; handlers are executed in order of registration. Use the Endpoint.off method to delete a handler.
Parameters
event:
EndpointEventshandler:
(ev: any) => void- OPTIONAL
options:
EventListenerOption
Type declaration
(ev: any) => voidParameters
ev:
any
Returns
Return:
void
useAudioOutput
useAudioOutput(id: string): voidSet audio output device for current Endpoint. Now supported by Google Chrome only
Parameters
id:
string
Returns
Return:
void
Properties
displayName
Get user display name of the endpoint.
id
Unique ID of current Endpoint
isDefault
mediaRenderers
The list of all mediaRenderers.
userName
Get user name of the endpoint.