ApiRTC iOS SDK Documentation

Class Api​RTC

open class ApiRTC  

Properties

test

open var test = "Test"

cloud​Api

public static var cloudApi: CloudApi  

version

public static var version: String  

build

public static var build: String  

is​Cloud​Server​Availability​Checker​Enabled

open private(set) var isCloudServerAvailabilityCheckerEnabled: Bool = false

is​Auto​Reconnect​Enabled

open private(set) var isAutoReconnectEnabled: Bool = true

log​Types

open private(set) var logTypes: [LogType]? 

Enabled log types

is​Socket​Debug​Log​Enabled

open private(set) var isSocketDebugLogEnabled: Bool = false

is​Meta​Info​Log​Enabled

open private(set) var isMetaInfoLogEnabled: Bool = false

is​Presence​Updates​Log​Suppressed

open private(set) var isPresenceUpdatesLogSuppressed: Bool = false

is​Log​ToFile​Enabled

open private(set) var isLogToFileEnabled: Bool = false

Methods

set​Cloud​Server​Availability​Checker(enabled:​)

open class func setCloudServerAvailabilityChecker(enabled: Bool)  

Enables network checker that checks state of network (wi-fi, cellular, none) and connection between SDK and Cloud server. Session connection state will also depend on that. Should be set before Session creation

set​Auto​Reconnect​Enabled(enabled:​)

open class func setAutoReconnectEnabled(enabled: Bool)  

Enables session autoreconnect with network availability

set​Log​Types(_:​)

open class func setLogTypes(_ types: [LogType]?)  

Sets log types

set​Socket​Debug​Log(enabled:​)

open class func setSocketDebugLog(enabled: Bool)  

Enables logging of socket connection debug info (large amount of output)

set​Meta​Info​Log(enabled:​)

open class func setMetaInfoLog(enabled: Bool)  

Enables log emta enfo output (file name, method name, line number)

set​Presence​Log​Suppressed(_:​)

open class func setPresenceLogSuppressed(_ value: Bool)  

Mutes excessive presence updates log output

set​External​Camera​Management​Enabled(_:​)

open class func setExternalCameraManagementEnabled(_ value: Bool)  

Mutes excessive presence updates log output

set​Log​ToFile(enabled:​)

open class func setLogToFile(enabled: Bool)  

Enables log output writing to file that may be retrived by ApiRTC.getLogFileURL() Note that the log file may grow fast with detailed log level

add​ToLog​File(_:​)

open class func addToLogFile(_ string: String)  

Adds arbitrary string to the log file

clear​Log​File()

open class func clearLogFile()  

Cleans log file

get​Log​File​URL()

open class func getLogFileURL() throws -> URL?  

Returns log file URL

set​Audio​Output(_:​)

open class func setAudioOutput(_ output: AudioOutput)  

/