Rate this page:

Endpoint

Represents any remote media unit in a session. An endpoint can be represented as ASR, Recorder, Player or another Call.
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 object if the endpoint is not a player or recorder instance.

Returns

getDirection

Copy URL
getDirection(): 

SEND

|

RECEIVE

|

BOTH

Returns the endpoint's direction. Possible values are SEND | RECEIVE | BOTH. SEND provides only sending stream from endpoint to conference; RECEIVE provides only receiving stream from conference to endpoint; BOTH allows both sending and receiving.

Returns

  • type:

    SEND

  • type:

    RECEIVE

  • type:

    BOTH

getMode

Copy URL
getMode(): 

MIX

|

FORWARD

Returns the endpoint's mode. Possible values are MIX | FORWARD. MIX mode combines all streams in one, FORWARD mode sends only one stream.

Returns

  • type:

    MIX

  • type:

    FORWARD

id

Copy URL
id(): 

string

Returns the endpoint's id.

Returns

  • type:

    string

manageEndpoint

Copy URL
manageEndpoint(parameters: 

ReceiveParameters

):

Promise<void>

Enables/disables receiving media streams from other conference participants.

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 receive EndpointEvents.InfoUpdated event.

Parameters

  • displayName:

    string

Returns

  • type:

    void