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

getCall

Copy URL
getCall(): 

Call

Returns the endpoint's call if the endpoint is not a player or recorder instance.

Returns

getDirection

Copy URL
getDirection(): 

SEND

|

RECEIVE

|

BOTH

Returns the 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 the endpoint id.

Returns

  • type:

    string

manageEndpoint

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

Sets the display name for the specified endpoint. When the display name is set, all SDK clients will receive EndpointEvents.InfoUpdated event.

Parameters

  • displayName:

    string

Returns

  • type:

    void

setMaxBitrate

Copy URL
setMaxBitrate(bitrate: 

number

):

void

Sets the maximum possible video bitrate for the endpoint.

Parameters

  • bitrate:

    number

Returns

  • type:

    void