1. References
  2. VoxEngine
  3. Endpoint
Rate this page:

Endpoint

Represents any remote media unit in a session. Endpoint can be ASR, Recorder, Player or another Call (e.g., which is joined to the conference). Add the following line to your scenario code to use the class:

require(Modules.Conference);

Methods

getDirection

Copy URL
getDirection(): 
SEND
 | 
RECEIVE
 | 
BOTH

Returns direction value.

Returns

  • type:

    SEND

  • type:

    RECEIVE

  • type:

    BOTH

getMode

Copy URL
getMode(): 
MIX
 | 
FORWARD

Returns mode value.

Returns

  • type:

    MIX

  • type:

    FORWARD

id

Copy URL
id(): 
string

Returns endpoint id.

Returns

  • type:

    string

manageEndpoint

Beta
Copy URL
manageEndpoint(params: 
ReceiveParameters
): 
Promise<void>

Specifies other endpoints' streams (audio and/or video) to receive.

Parameters

Returns

  • type:

    Promise<void>

setDisplayName

Copy URL
setDisplayName(displayName: 
string
): 
void

Set display name for specified endpoint. When display name is set, all SDKs clients will receive EndpointEvents.InfoUpdated event.

Parameters

  • displayName:

    string

Returns

  • type:

    void

setMaxBitrate

Copy URL
setMaxBitrate(bitrate: 
number
): 
void

Parameters

  • bitrate:

    number

Returns

  • type:

    void