> ## Documentation Index > Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt > Use this file to discover all available pages before exploring further. # WebRTC iOS Client Configuration > TxConfig struct reference for the iOS Voice SDK. Structure used to configure TelnyxRTC client logins, ringtone, ringback tone, logging, and push. **STRUCT** # `TxConfig` ```swift theme={null} public struct TxConfig ``` This structure is intended to used for Telnyx SDK configurations. ## Properties ### `DEFAULT_TIMEOUT` ```swift theme={null} public static let DEFAULT_TIMEOUT = 60.0 ``` Default timeout value for reconnection attempts in seconds. After this period, if a call hasn't successfully reconnected, it will be terminated. ### `sipUser` ```swift theme={null} public internal(set) var sipUser: String? ``` ### `password` ```swift theme={null} public internal(set) var password: String? ``` ### `token` ```swift theme={null} public internal(set) var token: String? ``` ### `pushNotificationConfig` ```swift theme={null} public internal(set) var pushNotificationConfig: TxPushConfig? ``` ### `ringBackTone` ```swift theme={null} public internal(set) var ringBackTone: String? ``` ### `ringtone` ```swift theme={null} public internal(set) var ringtone: String? ``` ### `reconnectClient` ```swift theme={null} public internal(set) var reconnectClient: Bool = true ``` ### `pushEnvironment` ```swift theme={null} public internal(set) var pushEnvironment: PushEnvironment? ``` ### `debug` ```swift theme={null} public internal(set) var debug: Bool = false ``` Enables WebRTC communication statistics reporting to Telnyx servers. * 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` ```swift theme={null} public internal(set) var forceRelayCandidate: Bool = false ``` Controls whether the SDK should force TURN relay for peer connections. When enabled, the SDK will only use TURN relay candidates for ICE gathering, which prevents the "local network access" permission popup from appearing. * 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` ```swift theme={null} public internal(set) var enableQualityMetrics: Bool = false ``` Controls whether the SDK should deliver call quality metrics ### `sendWebRTCStatsViaSocket` ```swift theme={null} public internal(set) var sendWebRTCStatsViaSocket: Bool = false ``` Controls whether the SDK should send WebRTC statistics via socket * 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` ```swift theme={null} public internal(set) var reconnectTimeout: Double = DEFAULT_TIMEOUT ``` Maximum time (in seconds) the SDK will attempt to reconnect a call after network disruption. * 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` ```swift theme={null} public internal(set) var customLogger: TxLogger? ``` Custom logger implementation for handling SDK logs If not provided, the default logger will be used ### `useTrickleIce` ```swift theme={null} public internal(set) var useTrickleIce: Bool = false ``` Controls whether the SDK should use trickle ICE for WebRTC signaling. When enabled, ICE candidates are sent individually as they are discovered, rather than waiting for all candidates to be gathered before sending the offer/answer. * Note: This improves call setup time by allowing ICE connectivity checks to start earlier. * Important: This setting is disabled by default to maintain compatibility with existing implementations. ### `enableCallReports` ```swift theme={null} public internal(set) var enableCallReports: Bool = true ``` Enable automatic call quality reporting to voice-sdk-proxy. When enabled, WebRTC stats are collected periodically during calls and posted to the voice-sdk-proxy /call\_report endpoint when the call ends. * Important: This setting is enabled by default. ### `callReportInterval` ```swift theme={null} public internal(set) var callReportInterval: TimeInterval = 5.0 ``` Interval in seconds for collecting call statistics. Stats are aggregated over each interval and stored locally until call end. * Important: Default is 5 seconds. ### `callReportLogLevel` ```swift theme={null} public internal(set) var callReportLogLevel: String = "debug" ``` Minimum log level to capture for call reports ("debug", "info", "warn", "error"). * Important: Default is "debug" to capture all logs. ### `callReportMaxLogEntries` ```swift theme={null} public internal(set) var callReportMaxLogEntries: Int = 1000 ``` Maximum number of log entries to buffer per call. * Important: Default is 1000 entries to prevent memory issues on long calls. ## Methods ### `init(sipUser:password:pushDeviceToken:ringtone:ringBackTone:pushEnvironment:logLevel:customLogger:reconnectClient:debug:forceRelayCandidate:enableQualityMetrics:sendWebRTCStatsViaSocket:reconnectTimeOut:useTrickleIce:enableCallReports:callReportInterval:callReportLogLevel:callReportMaxLogEntries:)` ```swift theme={null} 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, useTrickleIce: Bool = false, enableCallReports: Bool = true, callReportInterval: TimeInterval = 5.0, callReportLogLevel: String = "debug", callReportMaxLogEntries: Int = 1000 ) ``` Constructor for the Telnyx SDK configuration using SIP credentials. * 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. * useTrickleIce: (Optional) Controls whether the SDK should use trickle ICE for WebRTC signaling. Default is false. * enableCallReports: (Optional) Enable automatic call quality reporting to voice-sdk-proxy. Default is true. * callReportInterval: (Optional) Interval in seconds for collecting call statistics. Default is 5.0. * callReportLogLevel: (Optional) Minimum log level to capture for call reports. Default is "debug". * callReportMaxLogEntries: (Optional) Maximum number of log entries to buffer per call. Default is 1000. #### Parameters | Name | Description | | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | | 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. | | useTrickleIce | (Optional) Controls whether the SDK should use trickle ICE for WebRTC signaling. Default is false. | | enableCallReports | (Optional) Enable automatic call quality reporting to voice-sdk-proxy. Default is true. | | callReportInterval | (Optional) Interval in seconds for collecting call statistics. Default is 5.0. | | callReportLogLevel | (Optional) Minimum log level to capture for call reports. Default is “debug”. | | callReportMaxLogEntries | (Optional) Maximum number of log entries to buffer per call. Default is 1000. | ### `init(token:pushDeviceToken:ringtone:ringBackTone:pushEnvironment:logLevel:customLogger:reconnectClient:debug:forceRelayCandidate:enableQualityMetrics:sendWebRTCStatsViaSocket:reconnectTimeOut:useTrickleIce:enableCallReports:callReportInterval:callReportLogLevel:callReportMaxLogEntries:)` ```swift theme={null} 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, useTrickleIce: Bool = false, enableCallReports: Bool = true, callReportInterval: TimeInterval = 5.0, callReportLogLevel: String = "debug", callReportMaxLogEntries: Int = 1000 ) ``` Constructor for the Telnyx SDK configuration using JWT token authentication. * Parameters: * token: JWT token generated from [https://developers.telnyx.com/docs/v2/webrtc/quickstart](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. * useTrickleIce: (Optional) Controls whether the SDK should use trickle ICE for WebRTC signaling. Default is false. * enableCallReports: (Optional) Enable automatic call quality reporting to voice-sdk-proxy. Default is true. * callReportInterval: (Optional) Interval in seconds for collecting call statistics. Default is 5.0. * callReportLogLevel: (Optional) Minimum log level to capture for call reports. Default is "debug". * callReportMaxLogEntries: (Optional) Maximum number of log entries to buffer per call. Default is 1000. #### Parameters | Name | Description | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | | token | JWT token generated from [https://developers.telnyx.com/docs/v2/webrtc/quickstart](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. | | useTrickleIce | (Optional) Controls whether the SDK should use trickle ICE for WebRTC signaling. Default is false. | | enableCallReports | (Optional) Enable automatic call quality reporting to voice-sdk-proxy. Default is true. | | callReportInterval | (Optional) Interval in seconds for collecting call statistics. Default is 5.0. | | callReportLogLevel | (Optional) Minimum log level to capture for call reports. Default is “debug”. | | callReportMaxLogEntries | (Optional) Maximum number of log entries to buffer per call. Default is 1000. | ### `validateParams()` ```swift theme={null} public func validateParams() throws ``` Validate if TxConfig parameters are valid * Throws: Throws TxConfig parameters errors