Rate this page:

Endpoint

Class that represents a remote participant in a conference.

Methods

requestVideoSize

Copy URL

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

setEndpointListener

Copy URL

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

startReceiveVideo

Copy URL

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

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

Copy URL

Returns

  • type:

    String

Props

audioStreams

Copy URL

All active audio streams of the endpoint.

Returns

displayName

Copy URL

The user display name of the endpoint.

Returns

  • type:

    String?

id

Copy URL

The endpoint id.

Returns

  • type:

    String

isMuted

Copy URL

Whether the endpoint's microphone is muted.

Returns

  • type:

    Boolean

isVoiceActivityDetected

Copy URL

Whether the endpoint is currently talking.

Returns

  • type:

    Boolean

sipUri

Copy URL

The SIP URI of the endpoint.

Returns

  • type:

    String?

username

Copy URL

The username of the endpoint.

Returns

  • type:

    String?

videoStreams

Copy URL

All active video streams of the endpoint.

Returns