​

TxConfig

public struct TxConfig

​

Properties

​

DEFAULT_TIMEOUT

public static let DEFAULT_TIMEOUT = 60.0

​

sipUser

public internal(set) var sipUser: String?

​

password

public internal(set) var password: String?

​

token

public internal(set) var token: String?

​

pushNotificationConfig

public internal(set) var pushNotificationConfig: TxPushConfig?

​

ringBackTone

public internal(set) var ringBackTone: String?

​

ringtone

public internal(set) var ringtone: String?

​

reconnectClient

public internal(set) var reconnectClient: Bool = true

​

pushEnvironment

public internal(set) var pushEnvironment: PushEnvironment?

​

debug

public internal(set) var debug: Bool = false

• Note: This flag is different from logLevel:
  • debug: When enabled, sends WebRTC communication statistics to Telnyx servers for monitoring and debugging purposes. See WebRTCStatsReporter class for details on the statistics collected.
  • logLevel: Controls console log output in Xcode when running the app in debug mode.
• Important: The debug flag is disabled by default to minimize data usage.

​

forceRelayCandidate

public internal(set) var forceRelayCandidate: Bool = false

• Note: Enabling this may affect the quality of calls when devices are on the same local network, as all media will be relayed through TURN servers.
• Important: This setting is disabled by default to maintain optimal call quality.

​

enableQualityMetrics

public internal(set) var enableQualityMetrics: Bool = false

​

sendWebRTCStatsViaSocket

public internal(set) var sendWebRTCStatsViaSocket: Bool = false

• Note: This flag is independent of debug and enableQualityMetrics:
  • debug: Enables WebRTC stats collection and real-time metrics
  • enableQualityMetrics: Enables call quality metrics calculation
  • sendWebRTCStatsViaSocket: Enables sending collected stats via socket to Telnyx servers
• Important: This flag is disabled by default to minimize network traffic

​

reconnectTimeout

public internal(set) var reconnectTimeout: Double = DEFAULT_TIMEOUT

• If a call is successfully reconnected within this time, the call continues normally.
• If reconnection fails after this timeout period, the call will be terminated and a reconnectFailed error will be triggered.
• Default value is 60 seconds (defined by DEFAULT_TIMEOUT).
• This timeout helps prevent calls from being stuck in a “reconnecting” state indefinitely.

​

customLogger

public internal(set) var customLogger: TxLogger?

​

Methods

​

init(sipUser:password:pushDeviceToken:ringtone:ringBackTone:pushEnvironment:logLevel:customLogger:reconnectClient:debug:forceRelayCandidate:enableQualityMetrics:sendWebRTCStatsViaSocket:reconnectTimeOut:)

public init(sipUser: String, password: String,
            pushDeviceToken: String? = nil,
            ringtone: String? = nil,
            ringBackTone: String? = nil,
            pushEnvironment: PushEnvironment? = nil,
            logLevel: LogLevel = .none,
            customLogger: TxLogger? = nil,
            reconnectClient: Bool = true,
            debug: Bool = false,
            forceRelayCandidate: Bool = false,
            enableQualityMetrics: Bool = false,
            sendWebRTCStatsViaSocket: Bool = false,
            reconnectTimeOut: Double = DEFAULT_TIMEOUT
)

• Parameters:
  • sipUser: The SIP username for authentication
  • password: The password associated with the SIP user
  • pushDeviceToken: (Optional) The device’s push notification token, required for receiving inbound call notifications
  • ringtone: (Optional) The audio file name to play for incoming calls (e.g., “my-ringtone.mp3”)
  • ringBackTone: (Optional) The audio file name to play while making outbound calls (e.g., “my-ringbacktone.mp3”)
  • pushEnvironment: (Optional) The push notification environment (production or debug)
  • logLevel: (Optional) The verbosity level for SDK logs (defaults to .none)
  • customLogger: (Optional) Custom logger implementation for handling SDK logs. If not provided, the default logger will be used
  • reconnectClient: (Optional) Whether the client should attempt to reconnect automatically. Default is true.
  • debug: (Optional) Enables WebRTC communication statistics reporting to Telnyx servers. Default is false.
  • forceRelayCandidate: (Optional) Controls whether the SDK should force TURN relay for peer connections. Default is false.
  • enableQualityMetrics: (Optional) Controls whether the SDK should deliver call quality metrics. Default is false.
  • sendWebRTCStatsViaSocket: (Optional) Whether to send WebRTC statistics via socket to Telnyx servers. Default is false.
  • reconnectTimeOut: (Optional) Maximum time in seconds the SDK will attempt to reconnect a call after network disruption. Default is 60 seconds.

​

Parameters

​

init(token:pushDeviceToken:ringtone:ringBackTone:pushEnvironment:logLevel:customLogger:reconnectClient:debug:forceRelayCandidate:enableQualityMetrics:sendWebRTCStatsViaSocket:reconnectTimeOut:)

public init(token: String,
            pushDeviceToken: String? = nil,
            ringtone: String? = nil,
            ringBackTone: String? = nil,
            pushEnvironment: PushEnvironment? = nil,
            logLevel: LogLevel = .none,
            customLogger: TxLogger? = nil,
            reconnectClient: Bool = true,
            debug: Bool = false,
            forceRelayCandidate: Bool = false,
            enableQualityMetrics: Bool = false,
            sendWebRTCStatsViaSocket: Bool = false,
            reconnectTimeOut: Double = DEFAULT_TIMEOUT
)

• Parameters:
  • token: JWT token generated from https://developers.telnyx.com/docs/v2/webrtc/quickstart
  • pushDeviceToken: (Optional) The device’s push notification token, required for receiving inbound call notifications
  • ringtone: (Optional) The audio file name to play for incoming calls (e.g., “my-ringtone.mp3”)
  • ringBackTone: (Optional) The audio file name to play while making outbound calls (e.g., “my-ringbacktone.mp3”)
  • pushEnvironment: (Optional) The push notification environment (production or debug)
  • logLevel: (Optional) The verbosity level for SDK logs (defaults to .none)
  • customLogger: (Optional) Custom logger implementation for handling SDK logs. If not provided, the default logger will be used
  • reconnectClient: (Optional) Whether the client should attempt to reconnect automatically. Default is true.
  • debug: (Optional) Enables WebRTC communication statistics reporting to Telnyx servers. Default is false.
  • forceRelayCandidate: (Optional) Controls whether the SDK should force TURN relay for peer connections. Default is false.
  • enableQualityMetrics: (Optional) Controls whether the SDK should deliver call quality metrics. Default is false.
  • sendWebRTCStatsViaSocket: (Optional) Whether to send WebRTC statistics via socket to Telnyx servers. Default is false.
  • reconnectTimeOut: (Optional) Maximum time in seconds the SDK will attempt to reconnect a call after network disruption. Default is 60 seconds.

​

Parameters

​

validateParams()

public func validateParams() throws

• Throws: Throws TxConfig parameters errors