Endpoint
Class that represents any remote media unit in a call. Current endpoints can be retrieved via the Call.getEndpoints method.
Methods
off
off(eventType: , event: Function
): void
Remove a handler for the specified endpoint event.
Parameters
eventType:
event:
Function
OptionalHandler function. If not specified, all handlers for the event will be removed.
Returns
type:
void
on
on(eventType: , event: Function
): void
Register a handler for the specified endpoint event.One event can have more than one handler.
Use the Endpoint.off method to delete a handler.
Parameters
eventType:
event:
Function
Returns
type:
void
requestVideoSize
requestVideoSize(streamId: string
, width: number
, height: number
): Promise<void,CallEventTypes.CallOperationFailed>
Requests the specified video size for the video stream.The stream resolution may be changed to the closest to the specified width and height.
Valid only for conferences.
Parameters
streamId:
string
Remote video stream id
width:
number
Requested width of the video stream
height:
number
Requested height of the video stream
Returns
type:
Promise<void,CallEventTypes.CallOperationFailed>
startReceiving
startReceiving(streamId: string
): void
Starts receiving video on the video stream.Valid only for conferences.
Parameters
streamId:
string
Remote video stream id
Returns
type:
void
stopReceiving
stopReceiving(streamId: string
): void
Stops receiving video on the video stream.Valid only for conferences.
Parameters
streamId:
string
Remote video stream id
Returns
type:
void
Props
displayName
displayName: string
User display name of the endpoint.
id
id: string
The endpoint id
sipUri
sipUri: string
SIP URI of the endpoint
userName
userName: string
User name of the endpoint.