Rate this page:

Endpoint

Interface that represents any remote media unit in a call. Current endpoints can be retrieved via the Call.getEndpoints method. Endpoint can be :

  1. ASR
  2. Recorder
  3. Player
  4. or another call (e.g. which is joined to the conference)

Methods

off

Copy URL
off(event: 

EndpointEvents

,
handler:

Function

):

void

Remove 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

Returns

  • type:

    void

on

Copy URL
on(event: 

EndpointEvents

,
handler:

Function

,
options:

EventListenerOption

):

void

Register 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

Returns

  • type:

    void

useAudioOutput

Copy URL
useAudioOutput(id: 

string

):

void

Set audio output device for current Endpoint. Now supported by Google Chrome only

Parameters

  • id:

    string

Returns

  • type:

    void

Props

displayName

Copy URL
displayName: 

string

Get user display name of the endpoint.

id

Copy URL
id: 

string

Unique ID of current Endpoint

isDefault

Copy URL
isDefault: 

boolean

mediaRenderers

Copy URL
mediaRenderers: 

MediaRenderer[]

The list of all mediaRenderers.

sipUri

Copy URL
sipUri: 

string

Get SIP URI of the endpoint

userName

Copy URL
userName: 

string

Get user name of the endpoint.