NSLogger¶

A logger that writes to iOS's unified logging system.

Inherits the following classes: SparkyStudios::Audio::Amplitude::Logger

Detailed Description¶

This class logs output to the iOS unified logging system with a custom subsystem and category. Messages will appear in the device console, Xcode's debug console, and can be viewed with the Console.app and log command-line tool.

Public Functions¶

Type	Name
	NSLogger (const char * bundleId="com.amplitudeaudiosdk", const char * logTag="AM") Constructs a new NSLogger .
	~NSLogger () override Destructor that releases allocated resources.

Public Functions inherited from SparkyStudios::Audio::Amplitude::Logger¶

See SparkyStudios::Audio::Amplitude::Logger

Type	Name
void	Critical (const char * file, int line, const AmString & message) Logs a critical message.
void	Debug (const char * file, int line, const AmString & message) Logs a debug message.
void	Error (const char * file, int line, const AmString & message) Logs an error message.
void	Info (const char * file, int line, const AmString & message) Logs an informational message.
void	Success (const char * file, int line, const AmString & message) Logs a success message.
void	Warning (const char * file, int line, const AmString & message) Logs a warning message.
virtual	~Logger () = default Default destructor.

Public Static Functions inherited from SparkyStudios::Audio::Amplitude::Logger¶

See SparkyStudios::Audio::Amplitude::Logger

Type	Name
Logger *	GetLogger () Gets the logger instance to use when calling `amLogger` .
void	SetLogger (Logger * loggerInstance) Sets the logger instance to use when calling `amLogger` .

Protected Functions¶

Type	Name
virtual void	Log (eLogMessageLevel level, const char * file, int line, const AmString & message) override Logs a message with the given level.

Protected Functions inherited from SparkyStudios::Audio::Amplitude::Logger¶

See SparkyStudios::Audio::Amplitude::Logger

Type	Name
virtual void	Log (eLogMessageLevel level, const char * file, int line, const AmString & message) = 0 Logs a message with the given level.

Public Functions Documentation¶

NSLogger

Constructs a new NSLogger .

explicit Amplitude::NSLogger::NSLogger (
    const char * bundleId="com.amplitudeaudiosdk",
    const char * logTag="AM"
)

Parameters:

bundleId The bundle identifier of the application.
logTag A custom category to use when logging. This is used along with the subsystem identifier for organizing and filtering logs. Defaults to AM.

~NSLogger

Destructor that releases allocated resources.

Amplitude::NSLogger::~NSLogger () override

Protected Functions Documentation¶

Log

Logs a message with the given level.

virtual void Amplitude::NSLogger::Log (
    eLogMessageLevel level,
    const char * file,
    int line,
    const AmString & message
) override

Parameters:

level The level of the log message.
file The file where the message was logged.
line The line where the message was logged.
message The message to log.

Implements SparkyStudios::Audio::Amplitude::Logger::Log

The documentation for this class was generated from the following file: include/SparkyStudios/Audio/Amplitude/IO/iOS/NSLogger.h