VIEndpoint
Represents a remote call participant.
Props
displayName
String?
displayName
This endpoint's display name.
Returns
type:
String?
endpointId
String
endpointId
The endpoint id.
Returns
type:
String
onEndpointRemoved
onEndpointRemoved
Callback for getting notified when the endpoint is removed from the call. It is not triggered on call end.
Returns
type:
onEndpointUpdated
onEndpointUpdated
Callback for getting notified when the endpoint information is updated.
Returns
type:
onRemoteVideoStreamAdded
onRemoteVideoStreamAdded
Callback for getting notified when the endpoint added the video stream to the call.
Returns
type:
onRemoteVideoStreamRemoved
onRemoteVideoStreamRemoved
Callback for getting notified when the endpoint removed the video stream from the call.
Returns
onStartReceivingVideoStream
onStartReceivingVideoStream
Callback for getting notified when video receive on a remote video stream is started after previously being stopped. Available only for the conference calls.
Returns
onStopReceivingVideoStream
onStopReceivingVideoStream
Callback for getting notified when video receive on a remote video stream is stopped. Available only for the conference calls.
Returns
onVoiceActivityStarted
onVoiceActivityStarted
Callback for getting notified when a voice activity is detected in a conference call.
Returns
type:
onVoiceActivityStopped
onVoiceActivityStopped
Callback for getting notified when a voice activity is stopped in a conference call.
Returns
type:
place
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
List<VIVideoStream>
remoteVideoStreams
All active video streams of the endpoint.
Returns
type:
List<VIVideoStream>
sipUri
String?
sipUri
This endpoint's SIP URI.
Returns
type:
String?
userName
String?
userName
This endpoint's user name.
Returns
type:
String?
Methods
requestVideoSize
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:
- ERROR_INVALID_ARGUMENTS - If failed to find remote video stream by provided video stream id
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
Future<void>
startReceiving(String
streamId)
Starts receiving video on the remote video stream.
Available only for the conference calls.
If the video is already receiving, this method call is ignored.
If the request is processed successfully, VIStartReceivingVideoStream event will be invoked.
Throws VIException, if an error occurred.
Errors:
- ERROR_INTERNAL - If an internal error occurred.
Parameters
streamId:
String
Remote video stream id
Returns
type:
Future<void>
stopReceiving
Future<void>
stopReceiving(String
streamId)
Stops receiving video on the remote video stream.
Available only for the conference calls.
If the request is processed successfully, VIStopReceivingVideoStream event will be invoked with the reason MANUAL.
Throws VIException, if an error occurred.
Errors:
- ERROR_INTERNAL - If an internal error occurred.
Parameters
streamId:
String
Remote video stream id
Returns
type:
Future<void>