Endpoint
This API is in beta and subject to change.
Interface that represents a remote participant in a conference.
Methods
setEndpointListener
fun setEndpointListener(endpointListener: ): Unit
This API is in beta and subject to change.
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
This API is in beta and subject to change.
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
This API is in beta and subject to change.
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
This API is in beta and subject to change.
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
Props
id
val id: String
This API is in beta and subject to change.
The endpoint id.
Returns
type:
String
username
val username: String
This API is in beta and subject to change.
The username of the endpoint.
Returns
type:
String
displayName
val displayName: String
This API is in beta and subject to change.
The user display name of the endpoint.
Returns
type:
String
sipUri
val sipUri: String
This API is in beta and subject to change.
The SIP URI of the endpoint.
Returns
type:
String
videoStreams
val videoStreams: List<RemoteVideoStream>
This API is in beta and subject to change.
All active video streams of the endpoint.
Returns
type:
List<RemoteVideoStream>
audioStreams
val audioStreams: List<RemoteAudioStream>
This API is in beta and subject to change.
All active audio streams of the endpoint.
Returns
type:
List<RemoteAudioStream>
isMuted
val isMuted: Boolean
This API is in beta and subject to change.
Whether the endpoint's microphone is muted.
Returns
type:
Boolean
isVoiceActivityDetected
val isVoiceActivityDetected: Boolean
This API is in beta and subject to change.
Whether the endpoint is currently talking.
Returns
type:
Boolean