1. References
  2. Management API
  3. Users
Rate this page:

Conference

Methods

addVideoStream

Copy URL

Starts sending video associated with the provided local video stream.

If the operation is completed successfully, other conference participants receive EndpointListener.onRemoteVideoStreamAdded event.

To start sharing a device screen, use Conference.startScreenSharing API.

Parameters

  • videoStream:

    LocalVideoStream

    Video stream to be sent within the conference

  • callback:

    CallCallback?

    Optional

    Object to receive the result of this operation

Returns

  • type:

    Unit

hangup

Copy URL

Hangs up the conference.

Parameters

  • headers:

    Map<String, String>?

    Optional

    Optional set of headers to be sent to Voximplant Cloud. Names should begin with "X-" to be processed by SDK

Returns

  • type:

    Unit

join

Copy URL

Joins the conference.

Returns

  • type:

    Unit

Throws

CallException if the conference is already started or RECORD_AUDIO permission is not granted

muteAudio

Copy URL

Enables or disables audio transfer from microphone to the call. Other participants receive the EndpointListener.onEndpointMuteStateChanged event.

Parameters

  • muted:

    Boolean

    Whether to mute the microphone

Returns

  • type:

    Unit

removeVideoStream

Copy URL

Stops sending video associated with the provided local video stream.

LocalVideoStream should be additionally closed if the operation is completed successfully, i.e. CallCallback.onSuccess is called. Otherwise the video resources are not released.

If the operation is completed successfully, other conference participants receive EndpointListener.onRemoteVideoStreamRemoved event.

To stop sharing a device screen, use Conference.stopScreenSharing API.

Parameters

  • videoStream:

    LocalVideoStream

    Local video stream that should be stopped sending video

  • callback:

    CallCallback?

    Optional

    Object to receive the result of this operation

Returns

  • type:

    Unit

sendInfo

Copy URL

Sends an INFO message within the conference.

Parameters

  • mimeType:

    String

    MIME type of info

  • content:

    String

    Custom string data

  • headers:

    Map<String, String>?

    Optional

    Optional set of headers to be sent with message. Names should begin with "X-" to be processed by SDK

Returns

  • type:

    Unit

sendMessage

Copy URL

Sends a message within the conference.

Parameters

  • message:

    String

    Message text

Returns

  • type:

    Unit

setConferenceListener

Copy URL

Sets the listener to be notified of the conference events.

Parameters

  • listener:

    ConferenceListener?

    Optional

    The listener to be notified of the conference events. If null, a previously set listener is removed.

Returns

  • type:

    Unit

setQualityIssueListener

Copy URL

Sets QualityIssueListener to monitor issues that affect call quality.

Parameters

Returns

  • type:

    Unit

startScreenSharing

Copy URL

Starts sharing a device screen in the conference call.

If the operation is completed successfully, other conference participants receive the following events:

  1. ConferenceListener.onEndpointAdded
  2. EndpointListener.onRemoteVideoStreamAdded

Parameters

  • videoStream:

    LocalVideoStream

    The local video stream created with ScreenCaptureVideoSource

  • callback:

    CallCallback?

    Optional

    Object to receive the result of this operation

Returns

  • type:

    Unit

stopScreenSharing

Copy URL

Stops sharing a device screen in the conference call.

LocalVideoStream with a ScreenCaptureVideoSource should be additionally closed if the operation is completed successfully.

If the operation is completed successfully, other conference participants receive ConferenceListener.onEndpointRemoved event.

Parameters

  • callback:

    CallCallback?

    Optional

    Object to receive the result of this operation

Returns

  • type:

    Unit

toString

Copy URL

Returns

  • type:

    String

Props

currentQualityIssues

Copy URL

Gets the current status for all quality issues.

Returns

duration

Copy URL

The conference duration in milliseconds.

Returns

  • type:

    Long

endpointId

Copy URL

The conference endpoint id of this client.

Available after ConferenceListener.onConferenceConnected

Returns

  • type:

    String?

endpoints

Copy URL

The list of the endpoints associated with the conference.

Returns

id

Copy URL

The conference id.

Returns

  • type:

    String

isMuted

Copy URL

Whether the current conference participant's microphone is muted. You can change this state via Conference.muteAudio.

Returns

  • type:

    Boolean

localVideoStreams

Copy URL

Local video streams which are currently streaming in the conference.

Returns

number

Copy URL

The number used to make the conference call.

Returns

  • type:

    String

state

Copy URL

The conference state.

Returns