Call
Methods
answer
Unit
answer( callSettings)Answers the call. Should be used only for incoming calls.
Parameters
callSettings:
Call settings with additional call parameters, such as preferred video codec, custom data, extra headers etc.
Returns
type:
Unit
Throws
CallException if the call is already answered or RECORD_AUDIO permission is not granted.
hangup
Unit
hangup(Map<String, String>?
headers)Hangs up the call.
Parameters
headers:
Map<String, String>?
OptionalOptional set of headers to be sent to the Voximplant Cloud. Names should begin with "X-" to be processed by SDK
Returns
type:
Unit
hold
Unit
hold(Boolean
enable, callback)Holds or unholds the call.
Parameters
enable:
Boolean
Whether to put the call on hold
callback:
OptionalObject to receive the result of this operation
Returns
type:
Unit
muteAudio
Unit
muteAudio(Boolean
muted)Enables or disables audio from microphone into the call.
Parameters
muted:
Boolean
Whether to mute the microphone
Returns
type:
Unit
reject
Unit
reject( mode, Map<String, String>?
headers)Rejects the call. Should be used only for incoming calls.
Parameters
mode:
headers:
Map<String, String>?
OptionalOptional set of headers to be sent to the Voximplant Cloud. Names should begin with "X-" to be processed by SDK
Returns
type:
Unit
Throws
CallException if the call is already answered or ended
sendDTMF
Unit
sendDTMF(String
tone)Sends DTMF tones to the call.
Parameters
tone:
String
DTMF tones
Returns
type:
Unit
sendInfo
Unit
sendInfo(String
mimeType, String
content, Map<String, String>?
headers)Sends an INFO message within the call.
Parameters
mimeType:
String
MIME type of info
content:
String
Custom string data
headers:
Map<String, String>?
OptionalOptional set of headers to be sent with message. Names should begin with "X-" to be processed by SDK
Returns
type:
Unit
sendMessage
Unit
sendMessage(String
text)Sends a message within the call.
Implemented atop SIP INFO for communication between call endpoint and Voximplant cloud, and is separated from Voximplant messaging API.
Parameters
text:
String
Message text
Returns
type:
Unit
setCallListener
Unit
setCallListener( listener)Sets a listener to be notified of the call events
Parameters
listener:
OptionalThe listener to be notified of call events. If null, previously set listener is removed.
Returns
type:
Unit
setQualityIssueListener
Unit
setQualityIssueListener( listener)Sets QualityIssueListener to monitor issues that affect call quality.
Parameters
listener:
OptionalThe QualityIssueListener instance or null
Returns
type:
Unit
start
Unit
start()Starts the outgoing call.
Returns
type:
Unit
Throws
CallException if the call is already started, if RECORD_AUDIO (for audio and video call) or CAMERA (for video call) permissions are not granted, if the method is called for incoming call.
startSendingVideo
Unit
startSendingVideo( videoStream, callback)Starts sending video in the call.
Parameters
videoStream:
Video stream to be sent within the call
callback:
OptionalObject to receive the result of this operation
Returns
type:
Unit
stopSendingVideo
Unit
stopSendingVideo( callback)Stops sending video in the call.
If the operation is completed successfully, you must close the local video stream that has been previously used to send the video. Otherwise the video resources are not released.
Parameters
callback:
OptionalObject to receive the result of this operation
Returns
type:
Unit
toString
String
toString()Returns
type:
String
Props
currentQualityIssues
public currentQualityIssuesThe current status for all quality issues.
Returns
type:
direction
public directionWhether the call is incoming or outgoing.
Returns
type:
duration
public Long
durationThe call duration in milliseconds.
Returns
type:
Long
id
public String
idThe call id.
Returns
type:
String
isMuted
public Boolean
isMutedWhether the user's microphone is muted. You can change this state via Call.muteAudio.
Returns
type:
Boolean
isOnHold
public Boolean
isOnHoldWhether the call is on hold. You can change this state via Call.hold.
Returns
type:
Boolean
isVideoEnabled
public Boolean
isVideoEnabledWhether video is enabled in the call. True if video send or receive is enabled by current user, false otherwise.
Returns
type:
Boolean
localVideoStream
public localVideoStreamOutgoing video stream during the call or null if the local video is disabled.
Returns
type:
number
public String
numberSpecifies the number used to make outgoing call.
Returns
type:
String
remoteDisplayName
public String?
remoteDisplayNameThe participant's display name.
For incoming calls it is available immediately, for outgoing calls it is available after the CallListener.onCallConnected event.
Returns
type:
String?
remoteSipUri
public String?
remoteSipUriThe participant SIP URI.
For incoming calls it is available immediately, for outgoing calls it is available after the CallListener.onCallConnected event.
Returns
type:
String?
remoteVideoStreams
public List<RemoteVideoStream>
remoteVideoStreamsThe list of remote video streams.
Returns
type:
List<RemoteVideoStream>