Group io¶

Input/Output API.

Classes¶

Type	Name
class	SparkyStudios::Audio::Amplitude::AssetManagerFile A `File` implementation that reads and writes files from an Android AssetManager.
class	SparkyStudios::Audio::Amplitude::AssetManagerFileSystem A `FileSystem` implementation that reads and writes files from an Android AssetManager.
class	SparkyStudios::Audio::Amplitude::ConsoleLogger A Logger implementation that outputs messages to the console.
class	SparkyStudios::Audio::Amplitude::DiskFile A File implementation that reads and writes files on disk.
class	SparkyStudios::Audio::Amplitude::DiskFileSystem A `FileSystem` implementation that manages files and directories on disk.
class	SparkyStudios::Audio::Amplitude::File Base class used to manage files in a `FileSystem` .
class	SparkyStudios::Audio::Amplitude::FileLogger A Logger implementation that writes log messages to a file.
class	SparkyStudios::Audio::Amplitude::FileSystem Base class for files and resources loaders.
class	SparkyStudios::Audio::Amplitude::LogcatLogger A logger that writes to Android's logcat.
class	SparkyStudios::Audio::Amplitude::Logger The logger class.
class	SparkyStudios::Audio::Amplitude::MappedFile A File implementation that uses memory-mapped I/O for efficient read-only file access.
class	SparkyStudios::Audio::Amplitude::MemoryFile A `File` implementation that reads from and writes to a memory buffer.
class	SparkyStudios::Audio::Amplitude::NSFile A `File` implementation that reads and writes files using Apple's NSFileHandle.
class	SparkyStudios::Audio::Amplitude::NSFileSystem An implementation of the `FileSystem` interface for iOS using NSFileManager.
class	SparkyStudios::Audio::Amplitude::NSLogger A logger that writes to iOS's unified logging system.
class	SparkyStudios::Audio::Amplitude::NullLogger A Logger implementation that discards all log messages.
struct	SparkyStudios::Audio::Amplitude::PackageFileCompressedChunk Describes a compressed chunk in the package file.
struct	SparkyStudios::Audio::Amplitude::PackageFileHeaderDescription Provides metadata about the package file.
struct	SparkyStudios::Audio::Amplitude::PackageFileItemDescription Describes an item in the package file.
class	SparkyStudios::Audio::Amplitude::PackageFileSystem A `FileSystem` implementation that provides access to an Amplitude package file.
class	SparkyStudios::Audio::Amplitude::PackageItemFile A `File` implementation that provides access to an item in an Amplitude package file.
class	SparkyStudios::Audio::Amplitude::Resource An Amplitude resource in a `FileSystem` .

Public Types¶

Type	Name
enum AmUInt8	eFileOpenKind The type of file being opened.
enum AmUInt8	eFileOpenMode Describes the mode in which to open a file.
enum AmUInt8	eFileSeekOrigin Defines from where to seek in the file.
enum AmUInt8	eLogMessageLevel The level of a log message.
enum AmUInt8	ePackageFileCompressionMode Defines the algorithms a package file can be compressed with.

Macros¶

Type	Name
define	amLog (_level_, _message_, ...) `/* multi line expression /` Logs a message with the given level.*
define	amLogCritical (_message_, ...) `[amLog](group__io.md#define-amlog)(Critical, \_message\_, ##\_\_VA\_ARGS\_\_)` Logs a critical message.
define	amLogDebug (_message_, ...) `[amLog](group__io.md#define-amlog)(Debug, \_message\_, ##\_\_VA\_ARGS\_\_)` Logs a debug message.
define	amLogError (_message_, ...) `[amLog](group__io.md#define-amlog)(Error, \_message\_, ##\_\_VA\_ARGS\_\_)` Logs an error message.
define	amLogInfo (_message_, ...) `[amLog](group__io.md#define-amlog)(Info, \_message\_, ##\_\_VA\_ARGS\_\_)` Logs an informational message.
define	amLogSuccess (_message_, ...) `[amLog](group__io.md#define-amlog)(Success, \_message\_, ##\_\_VA\_ARGS\_\_)` Logs a success message.
define	amLogWarning (_message_, ...) `[amLog](group__io.md#define-amlog)(Warning, \_message\_, ##\_\_VA\_ARGS\_\_)` Logs a warning message.
define	amLogger `[SparkyStudios::Audio::Amplitude::Logger::GetLogger](class_sparky_studios_1_1_audio_1_1_amplitude_1_1_logger.md#function-getlogger)()` The global logger instance.

Public Types Documentation¶

eFileOpenKind

The type of file being opened.

enum eFileOpenKind {
    eFileOpenKind_Binary = 0,
    eFileOpenKind_Text = 1
};

eFileOpenMode

Describes the mode in which to open a file.

enum eFileOpenMode {
    eFileOpenMode_Read = 0,
    eFileOpenMode_Write = 1,
    eFileOpenMode_Append = 2,
    eFileOpenMode_ReadWrite = 3,
    eFileOpenMode_ReadAppend = 4
};

eFileSeekOrigin

Defines from where to seek in the file.

enum eFileSeekOrigin {
    eFileSeekOrigin_Start = SEEK_SET,
    eFileSeekOrigin_Current = SEEK_CUR,
    eFileSeekOrigin_End = SEEK_END
};

eLogMessageLevel

The level of a log message.

enum eLogMessageLevel {
    eLogMessageLevel_Debug = 0,
    eLogMessageLevel_Info = 1,
    eLogMessageLevel_Warning = 2,
    eLogMessageLevel_Error = 3,
    eLogMessageLevel_Critical = 4,
    eLogMessageLevel_Success = 5
};

This is used to determine the importance of a log message.

ePackageFileCompressionMode

Defines the algorithms a package file can be compressed with.

enum ePackageFileCompressionMode {
    ePackageFileCompressionMode_Uncompressed,
    ePackageFileCompressionMode_Compressed,
    ePackageFileCompressionMode_Invalid
};

Macro Definition Documentation¶

amLog

Logs a message with the given level.

#define amLog (
    _level_,
    _message_,
    ...
) `/* multi line expression */`

Parameters:

_level_ The level of the log message.
_message_ The message to log.
... The arguments to format the message with.

amLogCritical

Logs a critical message.

#define amLogCritical (
    _message_,
    ...
) `amLog (Critical, _message_, ##__VA_ARGS__)`

Parameters:

_message_ The message to log.
... The arguments to format the message with.

amLogDebug

Logs a debug message.

#define amLogDebug (
    _message_,
    ...
) `amLog (Debug, _message_, ##__VA_ARGS__)`

Parameters:

_message_ The message to log.
... The arguments to format the message with.

amLogError

Logs an error message.

#define amLogError (
    _message_,
    ...
) `amLog (Error, _message_, ##__VA_ARGS__)`

Parameters:

_message_ The message to log.
... The arguments to format the message with.

amLogInfo

Logs an informational message.

#define amLogInfo (
    _message_,
    ...
) `amLog (Info, _message_, ##__VA_ARGS__)`

Parameters:

_message_ The message to log.
... The arguments to format the message with.

amLogSuccess

Logs a success message.

#define amLogSuccess (
    _message_,
    ...
) `amLog (Success, _message_, ##__VA_ARGS__)`

Parameters:

_message_ The message to log.
... The arguments to format the message with.

amLogWarning

Logs a warning message.

#define amLogWarning (
    _message_,
    ...
) `amLog (Warning, _message_, ##__VA_ARGS__)`

Parameters:

_message_ The message to log.
... The arguments to format the message with.

amLogger

The global logger instance.

#define amLogger `SparkyStudios::Audio::Amplitude::Logger::GetLogger ()`