1. References
  2. Flutter SDK
  3. call
  4. VIEndpoint
Rate this page:

VIEndpoint

Represents a remote call participant.

Props

displayName

Copy URL
String?
 displayName

Endpoint's display name.

Returns

  • type:

    String?

endpointId

Copy URL
String
 endpointId

Endpoint's ID.

Returns

  • type:

    String

onEndpointRemoved

Copy URL
VIEndpointRemoved?
 onEndpointRemoved

Triggered when the endpoint is removed from the call. The event is not triggered on the call end.

Returns

onEndpointUpdated

Copy URL
VIEndpointUpdated?
 onEndpointUpdated

Triggered when the endpoint information is updated.

Returns

onRemoteVideoStreamAdded

Copy URL
VIRemoteVideoStreamAdded?
 onRemoteVideoStreamAdded

Triggered when the endpoint added the video stream to the call.

Returns

onRemoteVideoStreamRemoved

Copy URL
VIRemoteVideoStreamRemoved?
 onRemoteVideoStreamRemoved

Triggered when the endpoint removed the video stream from the call.

Returns

onStartReceivingVideoStream

Copy URL
VIStartReceivingVideoStream?
 onStartReceivingVideoStream

Triggered when video receive on a remote video stream is started after previously being stopped. Available only for the conference calls.

Returns

onStopReceivingVideoStream

Copy URL
VIStopReceivingVideoStream?
 onStopReceivingVideoStream

Triggered when video receive on a remote video stream is stopped. Available only for the conference calls.

Returns

onVoiceActivityStarted

Copy URL
VIVoiceActivityStarted?
 onVoiceActivityStarted

Triggered when a voice activity is detected in a conference call.

Returns

onVoiceActivityStopped

Copy URL
VIVoiceActivityStopped?
 onVoiceActivityStopped

Triggered when a voice activity is stopped in a conference call.

Returns

place

Copy URL
int?
 place

Place of this endpoint in a video conference. May be used as a position of this endpoint’s video stream to render in a video conference call.

Returns

  • type:

    int?

remoteVideoStreams

Copy URL
List<VIVideoStream>
 remoteVideoStreams

All active video streams of the endpoint.

Returns

sipUri

Copy URL
String?
 sipUri

Endpoint's SIP URI.

Returns

  • type:

    String?

userName

Copy URL
String?
 userName

Endpoint's user name.

Returns

  • type:

    String?

Methods

requestVideoSize

Copy URL
Future<void>
 requestVideoSize(
String
 streamId, 
int
 width, 
int
 height)

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.

Throws VIException, if an error occurred.

Errors:

Parameters

  • streamId:

    String

    Remote video stream id

  • width:

    int

    Requested width of the video stream

  • height:

    int

    Requested height of the video stream

Returns

  • type:

    Future<void>

startReceiving

Copy URL
Future<void>
 startReceiving(
String
 streamId)

Starts receiving video on the remote video stream.

Available only for conference calls.

If the video is already receiving, this method call is ignored.

If the request is processed successfully, VIStartReceivingVideoStream event is triggered.

Throws VIException, if an error occurred.

Errors:

Parameters

  • streamId:

    String

    Remote video stream id

Returns

  • type:

    Future<void>

stopReceiving

Copy URL
Future<void>
 stopReceiving(
String
 streamId)

Stops receiving video on the remote video stream.

Available only for conference calls.

If the request is processed successfully, VIStopReceivingVideoStream event is triggered with the reason MANUAL.

Throws VIException, if an error occurred.

Errors:

Parameters

  • streamId:

    String

    Remote video stream id

Returns

  • type:

    Future<void>