1. References
  2. Android SDK v3 (Beta)
  3. com.voximplant.android.sdk.calls
  4. Conference
Rate this page:

Conference

Methods

start

Copy URL
@Throws
fun start(): 
Unit

This API is in beta and subject to change.

Starts the conference.

Returns

  • type:

    Unit

hangup

Copy URL
fun hangup(headers: 
Map<String, String>?
): 
Unit

This API is in beta and subject to change.

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

muteAudio

Copy URL
fun muteAudio(muted: 
Boolean
): 
Unit

This API is in beta and subject to change.

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

addVideoStream

Copy URL
fun addVideoStream(videoStream: 
LocalVideoStream
, callback: 
CallCallback?
): 
Unit

This API is in beta and subject to change.

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, user 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

removeVideoStream

Copy URL
fun removeVideoStream(videoStream: 
LocalVideoStream
, callback: 
CallCallback?
): 
Unit

This API is in beta and subject to change.

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.

To close the local video stream, use LocalVideoStream.close API.

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

To stop sharing a device screen, user 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

startScreenSharing

Copy URL
fun startScreenSharing(videoStream: 
LocalVideoStream
, callback: 
CallCallback?
): 
Unit

This API is in beta and subject to change.

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

Returns

  • type:

    Unit

stopScreenSharing

Copy URL
fun stopScreenSharing(callback: 
CallCallback?
): 
Unit

This API is in beta and subject to change.

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

setConferenceListener

Copy URL
fun setConferenceListener(listener: 
ConferenceListener?
): 
Unit

This API is in beta and subject to change.

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

sendMessage

Copy URL
fun sendMessage(message: 
String
): 
Unit

This API is in beta and subject to change.

Sends a message within the conference.

Parameters

  • message:

    String

    Message text

Returns

  • type:

    Unit

sendInfo

Copy URL
fun sendInfo(mimeType: 
String
, content: 
String
, headers: 
Map<String, String>?
): 
Unit

This API is in beta and subject to change.

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

setQualityIssueListener

Copy URL
fun setQualityIssueListener(listener: 
QualityIssueListener?
): 
Unit

This API is in beta and subject to change.

Sets QualityIssueListener to monitor issues that affect call quality.

Parameters

Returns

  • type:

    Unit

Props

id

Copy URL
val id: 
String

This API is in beta and subject to change.

The conference id.

Returns

  • type:

    String

myEndpointId

Copy URL
val myEndpointId: 
String?

This API is in beta and subject to change.

The conference endpoint id of this client.

Available after ConferenceListener.onConferenceConnected

Returns

  • type:

    String?

state

Copy URL
val state: 
CallState

This API is in beta and subject to change.

The conference state.

Returns

endpoints

Copy URL
val endpoints: 
List<Endpoint>

This API is in beta and subject to change.

The list of the endpoints associated with the conference.

Returns

localVideoStreams

Copy URL
val localVideoStreams: 
List<LocalVideoStream>?

This API is in beta and subject to change.

Local video streams which are currently streaming in the conference.

Returns

currentQualityIssues

Copy URL
val currentQualityIssues: 
Map<QualityIssue, QualityIssueLevel>

This API is in beta and subject to change.

Gets the current status for all quality issues.

Returns

isMuted

Copy URL
val isMuted: 
Boolean

This API is in beta and subject to change.

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

Returns

  • type:

    Boolean

number

Copy URL
val number: 
String

This API is in beta and subject to change.

The number used to make the conference call.

Returns

  • type:

    String

duration

Copy URL
val duration: 
Long

This API is in beta and subject to change.

The conference duration in milliseconds.

Returns

  • type:

    Long