VIEndpoint
Represents a remote call participant.
Props
displayName
String?
displayNameThis endpoint's display name.
Returns
type:
String?
endpointId
String
endpointIdThe endpoint id.
Returns
type:
String
onEndpointRemoved
onEndpointRemovedCallback for getting notified when the endpoint is removed from the call. It is not triggered on call end.
Returns
type:
onEndpointUpdated
onEndpointUpdatedCallback for getting notified when the endpoint information is updated.
Returns
type:
onRemoteVideoStreamAdded
onRemoteVideoStreamAddedCallback for getting notified when the endpoint added the video stream to the call.
Returns
type:
onRemoteVideoStreamRemoved
onRemoteVideoStreamRemovedCallback for getting notified when the endpoint removed the video stream from the call.
Returns
onVoiceActivityStarted
onVoiceActivityStartedCallback for getting notified when a voice activity is detected in a conference call.
Returns
type:
onVoiceActivityStopped
onVoiceActivityStoppedCallback for getting notified when a voice activity is stopped in a conference call.
Returns
type:
place
int?
placePlace 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>
remoteVideoStreamsAll active video streams of the endpoint.
Returns
type:
List<VIVideoStream>
sipUri
String?
sipUriThis endpoint's SIP URI.
Returns
type:
String?
userName
String?
userNameThis 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 video stream.
Valid only for conferences.
Throws VIException, if an error occurred.
Errors:
- ERROR_TIMEOUT - If the operation is not completed in time.
- ERROR_ALREADY_IN_THIS_STATE - If the call is already in the requested state.
- ERROR_INCORRECT_OPERATION - If the call is not connected.
- 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 video stream.
Valid only for conferences.
Throws VIException, if an error occurred.
Errors:
- ERROR_TIMEOUT - If the operation is not completed in time.
- ERROR_ALREADY_IN_THIS_STATE - If the call is already in the requested state.
- ERROR_INCORRECT_OPERATION - If the call is not connected.
- ERROR_INTERNAL - If an internal error occurred.
Parameters
streamId:
String
Remote video stream id
Returns
type:
Future<void>