Libsoftphone/cz.acrobits.libsoftphone/Instance/Calls

Calls

class Calls

Methods for manipulating calls.

Constructors

Calls

constructor()

Types

Conferences

class Conferences

Methods for manipulating call conferences.

Functions

answerIncoming

@MainThread

open fun answerIncoming(@NonNull call: CallEvent, @NonNull intent: Call.AnswerIntent): Boolean

@MainThread

open fun answerIncoming(@NonNull call: CallEvent, @NonNull media: Call.DesiredMedia): Boolean

Answer an incoming call.

clearDtmfDigits

@MainThread

open fun clearDtmfDigits(@NonNull call: CallEvent)

Clear the DTMF digits buffer of a call.

@MainThread

open fun close(@NonNull call: CallEvent)

Close a call.

executeDtmfAndClear

@MainThread

open fun executeDtmfAndClear(@NonNull call: CallEvent, clear: Boolean)

Execute &clear DTMF program of a call.

open fun findSipHeader(@NonNull call: CallEvent, @NonNull headerName: String): Xml

Find a SIP header in a call.

open fun getActive(): Array<CallEvent>

Get active call(s).

getDefaultIncomingAudioEnergyUpdatePeriodInSeconds

@CheckResult

@MainThread

open fun getDefaultIncomingAudioEnergyUpdatePeriodInSeconds(@NonNull call: CallEvent): Double

Get the default incoming audio energy update period.

getDefaultOutgoingAudioEnergyUpdatePeriodInSeconds

@CheckResult

@MainThread

open fun getDefaultOutgoingAudioEnergyUpdatePeriodInSeconds(@NonNull call: CallEvent): Double

Get the default outgoing audio energy update period.

open fun getDesiredMedia(@NonNull call: CallEvent): Call.DesiredMedia

Get desired media of a call.

open fun getDtmfDigits(@NonNull call: CallEvent): String

Get DTMF digits sent in a call.

open fun getDtmfToDial(@NonNull call: CallEvent): String

Get waiting DTMF to dial.

getIncomingAudioEnergy

@CheckResult

@MainThread

open fun getIncomingAudioEnergy(@NonNull call: CallEvent): Float

Get incoming audio signal energy.

getIncomingAudioEnergyUpdatePeriodInSeconds

@CheckResult

@MainThread

open fun getIncomingAudioEnergyUpdatePeriodInSeconds(@NonNull call: CallEvent): Double

Get the current incoming audio energy update period.

getInviteResponseStatusLine

@CheckResult

@MainThread

@NonNull

open fun getInviteResponseStatusLine(@NonNull call: CallEvent): ResponseStatusLine

Return the status line from the response to INVITE.

open fun getMediaStatus(@NonNull call: CallEvent): Call.MediaStatus

Get call media status.

open fun getNetworkStatus(@NonNull call: CallEvent): NetworkStatus

Get call network status.

getNonTerminalCount

@CheckResult

@MainThread

@IntRange(from = 0)

open fun getNonTerminalCount(): Int

Get count of calls not in terminal state.

getOutgoingAudioEnergy

@CheckResult

@MainThread

open fun getOutgoingAudioEnergy(@NonNull call: CallEvent): Float

Get outgoing audio signal energy.

getOutgoingAudioEnergyUpdatePeriodInSeconds

@CheckResult

@MainThread

open fun getOutgoingAudioEnergyUpdatePeriodInSeconds(@NonNull call: CallEvent): Double

Get the current outgoing audio energy update period.

@CheckResult

@MainThread

open fun getRecommendedIncomingAudioEnergySamplingPeriodInMilliseconds(@NonNull call: CallEvent, updatePeriodInSeconds: Double): Int

Calculate at what intervals should the getIncomingAudioEnergy method be called for the specified incoming audio energy update period.

@CheckResult

@MainThread

open fun getRecommendedOutgoingAudioEnergySamplingPeriodInMilliseconds(@NonNull call: CallEvent, updatePeriodInSeconds: Double): Int

Calculate at what intervals should the getOutgoingAudioEnergy method be called for the specified outgoing audio energy update period.

open fun getState(@NonNull call: CallEvent): Call.State

Get state of a call.

open fun getStatistics(@NonNull call: CallEvent): Call.Statistics

Get call statistics.

hangup

@MainThread

open fun hangup(@NonNull call: CallEvent): Boolean

@MainThread

open fun hangup(@NonNull call: CallEvent, @Nullable reason: String): Boolean

Hang-up a call.

ignoreIncoming

@MainThread

open fun ignoreIncoming(@NonNull call: CallEvent): Boolean

Ignored an incoming call.

isAlive

@CheckResult

@MainThread

open fun isAlive(@NonNull call: CallEvent): Boolean

Check if a call is alive.

isCallWaitingForDtmfConfirmation

@MainThread

open fun isCallWaitingForDtmfConfirmation(@NonNull call: CallEvent): Boolean

Check if a call is waiting for DTMF confirmation.

open fun isHeld(@NonNull call: CallEvent): Call.HoldStates

Check if a call is held.

open fun isRecording(@NonNull call: CallEvent): Call.RecordingStatus

Check if a call is recording.

isSimulatedMicrophone

@CheckResult

@MainThread

open fun isSimulatedMicrophone(): Boolean

Check whether a simulated microphone is running.

open fun isVideoAvailable(@NonNull call: CallEvent): StreamAvailability

Check availability of a video stream.

offersIncomingVideo

@CheckResult

@MainThread

open fun offersIncomingVideo(@NonNull call: CallEvent): Boolean

Check if a call offers supported incoming video stream.

rejectIncoming

@MainThread

open fun rejectIncoming(@NonNull call: CallEvent, @NonNull responseCode: String, @NonNull phrase: String, @Nullable warning: String): Boolean

Reject (hang-up) an incoming call.

rejectIncomingEverywhere

@MainThread

open fun ~~rejectIncomingEverywhere~~(@NonNull call: CallEvent): Boolean

@MainThread

open fun rejectIncomingEverywhere(@NonNull call: CallEvent, @Nullable reason: Call.RejectReason): Boolean

Reject / decline an incoming call.

rejectIncomingHere

@MainThread

open fun ~~rejectIncomingHere~~(@NonNull call: CallEvent): Boolean

@MainThread

open fun rejectIncomingHere(@NonNull call: CallEvent, @NonNull reason: Call.RejectReason): Boolean

Reject (hang-up) an incoming call for this device.

setDesiredMedia

@MainThread

open fun setDesiredMedia(@NonNull call: CallEvent, @NonNull media: Call.DesiredMedia): Boolean

Set desired media for a call.

setHeld

@MainThread

open fun setHeld(@NonNull call: CallEvent, held: Boolean)

Hold or unhold a call.

setIncomingAudioEnergyUpdatePeriodInSeconds

@MainThread

open fun setIncomingAudioEnergyUpdatePeriodInSeconds(@NonNull call: CallEvent, updatePeriodInSeconds: Double)

Set the current incoming audio energy update period.

setOutgoingAudioEnergyUpdatePeriodInSeconds

@MainThread

open fun setOutgoingAudioEnergyUpdatePeriodInSeconds(@NonNull call: CallEvent, updatePeriodInSeconds: Double)

Set the current incoming audio energy update period.

setRecording

@MainThread

open fun setRecording(@NonNull call: CallEvent, recording: Boolean): Boolean

Set call recording.

startSimulatedMicrophone

@MainThread

open fun startSimulatedMicrophone(@NonNull sound: InputStream)

@MainThread

open fun startSimulatedMicrophone(@NonNull sound: InputStream, playOnce: Boolean)

Set simulated microphone.

stopSimulatedMicrophone

@MainThread

open fun stopSimulatedMicrophone()

Stops previously started simulated microphone.