+1 628 280 6510
+44 203 695 6215

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(3)

Properties(6)

Methods

off

off(event: EndpointEvents, handler: (ev: any) => void): 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

Type declaration

(ev: any) => void

Parameters

  • ev:

    any

Returns

  • Return:

    void

on

on(event: EndpointEvents, handler: (ev: any) => void, 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

Type declaration

(ev: any) => void

Parameters

  • ev:

    any

Returns

  • Return:

    void

useAudioOutput

useAudioOutput(id: string): void

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

Parameters

  • id:

    string

Returns

  • Return:

    void

Properties

displayName

displayName: string

Get user display name of the endpoint.

id

id: string

Unique ID of current Endpoint

isDefault

isDefault: boolean

mediaRenderers

mediaRenderers: MediaRenderer[]

The list of all mediaRenderers.

sipUri

sipUri: string

Get SIP URI of the endpoint

userName

userName: string

Get user name of the endpoint.