This class knows how to load and save AIFF files. More...

#include <AiffFileFormat.h>

Inheritance diagram for AudioDataLib::AiffFileFormat:

Classes
class	AiffChunkParser

Public Member Functions
	AiffFileFormat ()

virtual	~AiffFileFormat ()

virtual bool	ReadFromStream (ByteStream &inputStream, FileData *&fileData, Error &error) override

virtual bool	WriteToStream (ByteStream &outputStream, const FileData *fileData, Error &error) override

Public Member Functions inherited from AudioDataLib::FileFormat
	FileFormat ()

virtual	~FileFormat ()

Additional Inherited Members
Static Public Member Functions inherited from AudioDataLib::FileFormat
static std::shared_ptr< FileFormat >	CreateForFile (const std::string &filePath)

Detailed Description

This class knows how to load and save AIFF files.

I don't have it working yet.

Constructor & Destructor Documentation

◆ AiffFileFormat()

AiffFileFormat::AiffFileFormat ( )

◆ ~AiffFileFormat()

AiffFileFormat::~AiffFileFormat ( )

virtual

Member Function Documentation

◆ ReadFromStream()

bool AiffFileFormat::ReadFromStream	(	ByteStream &	inputStream,
		FileData *&	fileData,
		Error &	error )

overridevirtual

The given file data pointer is assigned an instance of some derivative of the FileData class which is, in turn, populated with the data found in the given stream.

Parameters

[in,out]	inputStream	This must be a ByteStream derivative that can handle read operations.
[out]	fileData	On success, this pointer is assigned a heap allocation the user is reponsible for freeing.
[out]	error	This will contain error information if false is returned.

Returns: True is returned on success; false otherwise.

Implements AudioDataLib::FileFormat.

◆ WriteToStream()

bool AiffFileFormat::WriteToStream	(	ByteStream &	outputStream,
		const FileData *	fileData,
		Error &	error )

overridevirtual

The given file data is written to the given stream.

Parameters

[out]	outputStream	This must be a ByteStream derivative that can accept write operations.
[in]	fileData	This is the file data to be written to the stream.
[out]	error	This will contain error information if false is returned.

Returns: True is returned on success; false otherwise.

Implements AudioDataLib::FileFormat.

The documentation for this class was generated from the following files:

Source/Library/FileFormats/AiffFileFormat.h
Source/Library/FileFormats/AiffFileFormat.cpp

Classes

Public Member Functions