Agora RTC Objective-C API Reference  Refactor
Properties
AgoraLogConfig Class Reference

Inherits <NSObject>.

Properties

NSString *_Nullable filePath
 
NSInteger fileSizeInKB
 
AgoraLogLevel level
 

Property Documentation

◆ filePath

- (NSString* _Nullable) filePath
readwritenonatomiccopy

The absolute path of log files.

Ensure that the directory for the log files exists and is writable. The default file path is as follows:

  • iOS: App Sandbox/Library/caches/agorasdk.log
  • macOS:
    • Sandbox enabled: App Sandbox/Library/Logs/agorasdk.log, such as /Users/<username>/Library/Containers/<App Bundle Identifier>/Data/Library/Logs/agorasdk.log
    • Sandbox disabled: ~/Library/Logs/agorasdk.log

◆ fileSizeInKB

- (NSInteger) fileSizeInKB
readwritenonatomicassign

The size (KB) of a log file.

The default value is 1024 KB. If you set this parameter to 1024 KB, the SDK outputs at most 5 MB log files; if you set it to less than 1024 KB, the setting is invalid, and the maximum size of a log file is still 1024 KB.

◆ level

- (AgoraLogLevel) level
readwritenonatomicassign

The output log level of the SDK. See details in AgoraLogLevel.

For example, if you set the log level to AgoraLogLevelWarn, the SDK outputs the logs within levels AgoraLogLevelFatal, AgoraLogLevelError, and AgoraLogLevelWarn.