Rate this page:

Endpoint

This API is in beta and subject to change.

Interface that represents a remote participant in a conference.

Methods

setEndpointListener

Copy URL
fun setEndpointListener(endpointListener: 

EndpointListener?

):

Unit

This API is in beta and subject to change.

Sets the listener to be notified of the endpoint events.

Parameters

  • endpointListener:

    EndpointListener?

    Optional

    The listener to be notified of the endpoint events. If null, previous listener is removed

Returns

  • type:

    Unit

requestVideoSize

Copy URL
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

Copy URL
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

Copy URL
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

Copy URL
val id: 

String

This API is in beta and subject to change.

The endpoint id.

Returns

  • type:

    String

username

Copy URL
val username: 

String

This API is in beta and subject to change.

The username of the endpoint.

Returns

  • type:

    String

displayName

Copy URL
val displayName: 

String

This API is in beta and subject to change.

The user display name of the endpoint.

Returns

  • type:

    String

sipUri

Copy URL
val sipUri: 

String

This API is in beta and subject to change.

The SIP URI of the endpoint.

Returns

  • type:

    String

videoStreams

Copy URL
val videoStreams: 

List<RemoteVideoStream>

This API is in beta and subject to change.

All active video streams of the endpoint.

Returns

audioStreams

Copy URL
val audioStreams: 

List<RemoteAudioStream>

This API is in beta and subject to change.

All active audio streams of the endpoint.

Returns

isMuted

Copy URL
val isMuted: 

Boolean

This API is in beta and subject to change.

Whether the endpoint's microphone is muted.

Returns

  • type:

    Boolean

isVoiceActivityDetected

Copy URL
val isVoiceActivityDetected: 

Boolean

This API is in beta and subject to change.

Whether the endpoint is currently talking.

Returns

  • type:

    Boolean