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
-
AudioService instance to handle audio playback
final
- callEnded → Function
-
Callback function that gets invoked when the call ends
final
- callHandler ↔ CallHandler
-
CallHandler Instance - Single Source of Truth for State Management
getter/setter pair
- callId ↔ String?
-
The unique identifier for the call, used to track the call session
getter/setter pair
- callState ↔ CallState
-
Current Call State - Managed by CallHandler
getter/setter pair
-
customHeaders
↔ Map<
String, String> -
Custom SIP headers to be sent with the call
getter/setter pair
- debug → bool
-
Debug mode flag to enable call quality metrics
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- 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
-
Indicates whether the call is currently on hold
getter/setter pair
- peerConnection ↔ Peer?
-
The Peer connection instance used for WebRTC communication
getter/setter pair
- ringBackFile → String
-
The file path for the ringback audio file (audio played when calling)
final
- ringToneFile → String
-
The file path for the ringtone audio file (audio played when receiving a call)
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sessid → String
-
Session ID for the current call
final
- sessionCallerName ↔ String
-
The caller's name for the current session
getter/setter pair
- sessionCallerNumber ↔ String
-
The caller's number for the current session
getter/setter pair
- sessionClientState ↔ String
-
The client state for the current session, used to pass custom data
getter/setter pair
- sessionDestinationNumber ↔ String
-
The destination number for the current session
getter/setter pair
- speakerPhone ↔ bool
-
Indicates whether the call is currently using speaker phone
getter/setter pair
- txSocket → TxSocket
-
The TxSocket instance used for sending messages to the Telnyx WebRTC server
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
inviteparameter, sending your local specifiedcallerName,callerNumberandclientState -
callQualityMetricsHandler(
CallQualityMetrics metrics) → void - Handles call quality metrics updates.
-
dtmf(
String tone) → void -
Sends a DTMF message with the chosen
toneto the call specified via thecallID -
enableSpeakerPhone(
bool enable) → void -
Enables or disables the speakerphone based on the
enableparameter -
endCall(
) → void -
Attempts to end the call identified via the
callID -
initCallMetrics(
) → void - Initializes call metrics tracking by setting the callback for call quality changes.
-
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
destinationNumberor SIP Destination using the providedcallerName,callerNumberand aclientState -
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 - Handles the remote session received from the peer connection.
-
playAudio(
String filePath) → void - Plays an audio file from the assets directory. Example file path for '/assets/audio/sound.wav'
-
playRingtone(
String filePath) → void - Play ringtone for only web, iOS and Android will use native audio player
-
sendConversationMessage(
String message) → void - AI Assistant Conversation Method. Sends a conversation message to an assistant agent.
-
stopAudio(
) → void - Stops the currently playing audio.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited