AudioFileInfo Class Reference

#include <AudioFileInfo.h>

Inheritance diagram for AudioFileInfo:

Collaboration diagram for AudioFileInfo:

Public Member Functions
	AudioFileInfo (int16_t pNumChannels=0, int32_t pSampleRateHz=0, int32_t pBytesPerSecond=0, int16_t pByteRate=0, int16_t pBitsPerSample=0)
	Constructor.
virtual	~AudioFileInfo ()=default
virtual void	copyAudioFileInfo (const AudioFileInfo &pAudioFileInfo)
	Copies the values from another AudioFileInfo object.
virtual AudioFileResultType	read (const char *pFilename)
	Reads the info from a WAV file.
virtual AudioFileResultType	read (std::fstream &pInFStream)
	Reads the info from a file stream.
virtual AudioFileResultType	write (std::fstream &pOutFStream)
	Writes the info to a file stream.
virtual int32_t	FileSize () const
void	FileSize (int32_t pFileSize)
virtual int16_t	NumChannels () const
virtual void	NumChannels (int16_t pNumChannels)
virtual int32_t	SampleRateHz () const
virtual void	SampleRateHz (int32_t pSampleRateHz)
virtual int32_t	BytesPerSecond () const
virtual void	BytesPerSecond (int32_t pBytesPerSecond)
virtual int16_t	ByteRate () const
virtual void	ByteRate (int16_t pByteRate)
virtual int16_t	BitsPerSample () const
virtual void	BitsPerSample (int16_t pBitsPerSample)
virtual size_t	BytesPerSample () const

Protected Attributes
int32_t	mFileSize
int16_t	mNumChannels
int32_t	mSampleRateHz
int32_t	mBytesPerSecond
int16_t	mByteRate
int16_t	mBitsPerSample

Constructor & Destructor Documentation

AudioFileInfo()

EOUtils::AudioFileInfo::AudioFileInfo	(	int16_t	pNumChannels = 0,
		int32_t	pSampleRateHz = 0,
		int32_t	pBytesPerSecond = 0,
		int16_t	pByteRate = 0,
		int16_t	pBitsPerSample = 0 )

Constructor.

Parameters

[in]	pNumChannels	The number of channels
[in]	pSampleRateHz	The sample rate (in Hz)
[in]	pBytesPerSecond	The number of bytes per second
[in]	pByteRate	The byte rate (number of bytes per sample * number of channels)
[in]	pBitsPerSample	The number of bits per sample

~AudioFileInfo()

virtual EOUtils::AudioFileInfo::~AudioFileInfo ( )

virtualdefault

Member Function Documentation

BitsPerSample() [1/2]

int16_t EOUtils::AudioFileInfo::BitsPerSample ( ) const

virtual

BitsPerSample() [2/2]

void EOUtils::AudioFileInfo::BitsPerSample ( int16_t pBitsPerSample )

virtual

ByteRate() [1/2]

int16_t EOUtils::AudioFileInfo::ByteRate ( ) const

virtual

ByteRate() [2/2]

void EOUtils::AudioFileInfo::ByteRate ( int16_t pByteRate )

virtual

BytesPerSample()

size_t EOUtils::AudioFileInfo::BytesPerSample ( ) const

virtual

BytesPerSecond() [1/2]

int32_t EOUtils::AudioFileInfo::BytesPerSecond ( ) const

virtual

BytesPerSecond() [2/2]

void EOUtils::AudioFileInfo::BytesPerSecond ( int32_t pBytesPerSecond )

virtual

copyAudioFileInfo()

void EOUtils::AudioFileInfo::copyAudioFileInfo ( const AudioFileInfo & pAudioFileInfo )

virtual

Copies the values from another AudioFileInfo object.

Parameters

[in]

pAudioFileInfo

An AudioFileInfo object to copy the values from

FileSize() [1/2]

int32_t EOUtils::AudioFileInfo::FileSize ( ) const

virtual

FileSize() [2/2]

void EOUtils::AudioFileInfo::FileSize

(

int32_t

pFileSize

)

NumChannels() [1/2]

int16_t EOUtils::AudioFileInfo::NumChannels ( ) const

virtual

NumChannels() [2/2]

void EOUtils::AudioFileInfo::NumChannels ( int16_t pNumChannels )

virtual

read() [1/2]

AudioFileResultType EOUtils::AudioFileInfo::read ( const char * pFilename )

virtual

Reads the info from a WAV file.

Parameters

[in]

pFilename

The name of a WAV file to read from

Returns

An AudioFileResultType object containing error messages on failure, or no errors on success

read() [2/2]

AudioFileResultType EOUtils::AudioFileInfo::read ( std::fstream & pInFStream )

virtual

Reads the info from a file stream.

Parameters

[in]

pInFStream

A file stream object to read the information from. This must be already opened in read and binary mode.

Returns

An AudioFileResultType object containing error messages on failure, or no errors on success

SampleRateHz() [1/2]

int32_t EOUtils::AudioFileInfo::SampleRateHz ( ) const

virtual

SampleRateHz() [2/2]

void EOUtils::AudioFileInfo::SampleRateHz ( int32_t pSampleRateHz )

virtual

write()

AudioFileResultType EOUtils::AudioFileInfo::write ( std::fstream & pOutFStream )

virtual

Writes the info to a file stream.

Parameters

[in]

pOutFStream

A file stream object to write the information to. This must be already opened in write and binary mode.

Returns

An AudioFileResultType object containing error messages on failure, or no errors on success

Member Data Documentation

mBitsPerSample

int16_t EOUtils::AudioFileInfo::mBitsPerSample

protected

mByteRate

int16_t EOUtils::AudioFileInfo::mByteRate

protected

mBytesPerSecond

int32_t EOUtils::AudioFileInfo::mBytesPerSecond

protected

mFileSize

int32_t EOUtils::AudioFileInfo::mFileSize

protected

mNumChannels

int16_t EOUtils::AudioFileInfo::mNumChannels

protected

mSampleRateHz

int32_t EOUtils::AudioFileInfo::mSampleRateHz

protected

---

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

• /home/erico/projects/audio_mixer_cpp/code/common/AudioFileInfo.h
• /home/erico/projects/audio_mixer_cpp/code/common/AudioFileInfo.cpp