1. References
  2. Web SDK
  3. VoxImplant
  4. Endpoint
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

disableAll

Copy URL
disableAll(): 
void

Disables all the endpoint’s media renderers

Returns

  • type:

    void

enableAll

Copy URL
enableAll(): 
void

Enables all the endpoint’s media renderers

Returns

  • type:

    void

off

Copy URL
off(event: 
EndpointEvents
, handler: 
Function
): 
void

Parameters

Returns

  • type:

    void

on

Copy URL
on(event: 
EndpointEvents
, handler: 
Function
, options: 
EventListenerOption
): 
void

Parameters

  • event:

    EndpointEvents

  • handler:

    Function

  • options:

    EventListenerOption

    Optional

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 media renderers.

sipUri

Copy URL
sipUri: 
string

Get SIP URI of the endpoint

userName

Copy URL
userName: 
string

Get user name of the endpoint.