Conference
Methods
fun addVideoStream(videoStream: , callback: ): Unit
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:
Video stream to be sent within the conference
callback:
Object to receive the result of this operation
Returns
type:
Unit
fun hangup(headers: Map<String, String>?
): Unit
Hangs up the conference.
Parameters
headers:
Map<String, String>?
OptionalOptional set of headers to be sent to Voximplant Cloud. Names should begin with "X-" to be processed by SDK
Returns
type:
Unit
@Throws(CallException)fun join(): Unit
Joins the conference.
Returns
type:
Unit
Throws
CallException if the conference is already started or RECORD_AUDIO permission is not granted
fun muteAudio(muted: Boolean
): Unit
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
fun removeVideoStream(videoStream: , callback: ): Unit
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:
Local video stream that should be stopped sending video
callback:
Object to receive the result of this operation
Returns
type:
Unit
fun sendInfo(mimeType: String
, content: String
, headers: Map<String, String>?
): Unit
Sends an INFO message within the conference.
Parameters
mimeType:
String
MIME type of info
content:
String
Custom string data
headers:
Map<String, String>?
Optional set of headers to be sent with message. Names should begin with "X-" to be processed by SDK
Returns
type:
Unit
fun sendMessage(text: String
): Unit
Sends a message within the conference.
Parameters
text:
String
Message text
Returns
type:
Unit
fun setConferenceListener(listener: ): Unit
Sets the listener to be notified of the conference events.
Parameters
listener:
The listener to be notified of the conference events. If null, a previously set listener is removed.
Returns
type:
Unit
fun setQualityIssueListener(listener: ): Unit
Sets QualityIssueListener to monitor issues that affect call quality.
Parameters
listener:
QualityIssueListener instance or null
Returns
type:
Unit
fun startScreenSharing(videoStream: , callback: ): Unit
Starts sharing a device screen in the conference call.
If the operation is completed successfully, other conference participants receive the following events:
Parameters
videoStream:
The local video stream created with ScreenCaptureVideoSource
callback:
Object to receive the result of this operation
Returns
type:
Unit
fun stopScreenSharing(callback: ): Unit
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:
Object to receive the result of this operation
Returns
type:
Unit
fun toString(): String
Returns
type:
String
Props
val currentQualityIssues: Gets the current status for all quality issues.
Returns
type:
val duration: Long
The conference duration in milliseconds.
Returns
type:
Long
val endpointId: String?
The conference endpoint id of this client.
Available after ConferenceListener.onConferenceConnected
Returns
type:
String?
val endpoints: List<Endpoint>
The list of the endpoints associated with the conference.
Returns
type:
List<Endpoint>
val id: String
The conference id.
Returns
type:
String
val isMuted: Boolean
Whether the current conference participant's microphone is muted. You can change this state via Conference.muteAudio.
Returns
type:
Boolean
val localVideoStreams: List<LocalVideoStream>?
Local video streams which are currently streaming in the conference.
Returns
type:
List<LocalVideoStream>?
val number: String
The number used to make the conference call.
Returns
type:
String