Endpoint
Class that represents a remote participant in a conference.
Methods
setEndpointListener
fun setEndpointListener(endpointListener: ): Unit
Sets the listener to be notified of the endpoint events.
Parameters
endpointListener:
OptionalThe listener to be notified of the endpoint events. If null, previous listener is removed
Returns
type:
Unit
requestVideoSize
fun requestVideoSize(streamId: String
, width: Int
, height: Int
): Unit
Requests the specified video size for the video stream.
The stream resolution may be changed to the closest to the specified width and height.
Parameters
streamId:
String
width:
Int
Requested width of the video stream
height:
Int
Requested height of the video stream
Returns
type:
Unit
startReceiveVideo
fun startReceiveVideo(streamId: String
): Unit
Starts receiving video on the remote video stream.
If the video is already receiving, this method call is ignored.
If the request is processed successfully, EndpointListener.onStartReceivingVideoStream event is invoked.
Parameters
streamId:
String
Returns
type:
Unit
stopReceiveVideo
fun stopReceiveVideo(streamId: String
): Unit
Stops receiving video on the remote video stream.
If the request is processed successfully, EndpointListener.onStopReceivingVideoStream event is invoked with the VideoStreamReceiveStopReason.Manual reason
Parameters
streamId:
String
Returns
type:
Unit
toString
fun toString(): String
Returns
type:
String
Props
id
val id: String
The endpoint id.
Returns
type:
String
username
val username: String?
The username of the endpoint.
Returns
type:
String?
displayName
val displayName: String?
The user display name of the endpoint.
Returns
type:
String?
sipUri
val sipUri: String?
The SIP URI of the endpoint.
Returns
type:
String?
videoStreams
val videoStreams: List<RemoteVideoStream>
All active video streams of the endpoint.
Returns
type:
List<RemoteVideoStream>
audioStreams
val audioStreams: List<RemoteAudioStream>
All active audio streams of the endpoint.
Returns
type:
List<RemoteAudioStream>
isMuted
var isMuted: Boolean
Whether the endpoint's microphone is muted.
Returns
type:
Boolean
isVoiceActivityDetected
var isVoiceActivityDetected: Boolean
Whether the endpoint is currently talking.
Returns
type:
Boolean