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
getCall(): Returns the endpoint's Call object if the endpoint is not a player or recorder instance.
Returns
type:
getDirection
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
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
id(): string
Returns the endpoint's id.
Returns
type:
string
manageEndpoint
manageEndpoint(parameters: ): Promise<void>
Enables/disables receiving media streams from other conference participants.
Parameters
parameters:
Returns
type:
Promise<void>
setDisplayName
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