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

Returns the endpoint’s Call instance if the endpoint is not a player or recorder instance.

1
getCall(): Call

getDirection

Returns the endpoint’s direction. SEND provides only outgoing stream from endpoint to conference, RECEIVE provides only incoming stream from conference to endpoint, BOTH allows both incoming and outgoing streams.

1
getDirection(): 'SEND' | 'RECEIVE' | 'BOTH'

getMode

Returns the endpoint’s mode. MIX mode combines all streams in one, FORWARD mode sends only one stream.

1
getMode(): 'MIX' | 'FORWARD'

id

Returns the endpoint’s id.

1
id(): string

manageEndpoint

Enables/disables receiving media streams from other conference participants.

1
manageEndpoint(parameters: ReceiveParameters): Promise<void>

Parameters

setDisplayName

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

1
setDisplayName(displayName: string): void

Parameters