1. References
  2. React Native SDK
  3. Voximplant
  4. Endpoint
Rate this page:

Endpoint

Class that represents any remote media unit in a call. Current endpoints can be retrieved via the Call.getEndpoints method.

Methods

off

Copy URL
off(eventType: 
EndpointEventTypes
, event: 
Function
): 
void

Remove a handler for the specified endpoint event.

Parameters

  • eventType:

    EndpointEventTypes

  • event:

    Function

    Optional

    Handler function. If not specified, all handlers for the event will be removed.

Returns

  • type:

    void

on

Copy URL
on(eventType: 
EndpointEventTypes
, 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

Returns

  • type:

    void

requestVideoSize

Copy URL
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

startReceiving

Copy URL
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

Copy URL
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

Copy URL
displayName: 
string

User display name of the endpoint.

id

Copy URL
id: 
string

The endpoint id

sipUri

Copy URL
sipUri: 
string

SIP URI of the endpoint

userName

Copy URL
userName: 
string

User name of the endpoint.

videoStreams

Copy URL
videoStreams: 
VideoStream[]

Video streams of the endpoint.