Call class

The Call class which is used for call related methods such as hold/mute or creating invitations, declining calls, etc.

Constructors

Call.new(TxSocket txSocket, TelnyxClient _txClient, String sessid, String ringToneFile, String ringBackFile, CallHandler callHandler, Function callEnded, bool debug)

Properties

audioService → AudioService

final

callEnded → Function

final

callHandler ↔ CallHandler

CallHandler Instance - Single Source of Truth for State Management

getter/setter pair

callId ↔ String?

getter/setter pair

callState ↔ CallState

Current Call State - Managed by CallHandler

getter/setter pair

customHeaders ↔ Map<String, String>

getter/setter pair

debug → bool

final

hashCode → int

The hash code for this object.

no setter, inherited

onCallQualityChange ↔ CallQualityChangeCallback?

Callback for call quality metrics updates. This will be called periodically with updated metrics when debug mode is enabled.

getter/setter pair

onHold ↔ bool

getter/setter pair

peerConnection ↔ Peer?

getter/setter pair

ringBackFile → String

final

ringToneFile → String

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sessid → String

final

sessionCallerName ↔ String

getter/setter pair

sessionCallerNumber ↔ String

getter/setter pair

sessionClientState ↔ String

getter/setter pair

sessionDestinationNumber ↔ String

getter/setter pair

txSocket → TxSocket

final

Methods

acceptCall(IncomingInviteParams invite, String callerName, String callerNumber, String clientState, {bool isAttach = false, Map<String, String> customHeaders = const {}, bool debug = false}) → Call

Accepts the incoming call specified via the invite parameter, sending your local specified callerName, callerNumber and clientState

callQualityMetricsHandler(CallQualityMetrics metrics) → void

dtmf(String tone) → void

Sends a DTMF message with the chosen tone to the call specified via the callID

enableSpeakerPhone(bool enable) → void

endCall() → void

Attempts to end the call identified via the callID

initCallMetrics() → void

newInvite(String callerName, String callerNumber, String destinationNumber, String clientState, {Map<String, String> customHeaders = const {}, bool debug = false}) → void

Creates an invitation to send to a destinationNumber or SIP Destination using the provided callerName, callerNumber and a clientState

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onHoldUnholdPressed() → void

Either places the call on hold, or unholds the call based on the current hold state.

onMuteUnmutePressed() → void

Either mutes or unmutes local audio based on the current mute state

onRemoteSessionReceived(String? sdp) → void

playAudio(String filePath) → void

playRingtone(String filePath) → void

stopAudio() → void

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited