CLAM::AudioFile Class Reference
[Audio File I/O]

#include <AudioFile.hxx>

List of all members.

Public Member Functions
	AudioFile ()
	AudioFile (const AudioFile &)
const AudioFile &	operator= (const AudioFile &)
virtual	~AudioFile ()
const Filename &	GetLocation () const
const AudioFileHeader &	GetHeader () const
const AudioTextDescriptors &	GetTextDescriptors () const
AudioTextDescriptors &	GetTextDescriptors ()
void	SetTextDescriptors (const AudioTextDescriptors &descriptors)
EAudioFileCodec	GetCodec () const
bool	IsValid () const
bool	IsReadable () const
bool	IsWritable () const
AudioCodecs::Stream *	GetStream ()
Protected Member Functions
bool	SetHeader (const AudioFileHeader &)
	Usually the header is set into the file using CreateNew or OpenExistig (public) methods.
void	ResolveCodec ()
void	ActivateCodec ()
void	ResetHeaderData ()
Protected Attributes
Filename	mLocation
EAudioFileCodec	mCodec

---

Detailed Description

Definition at line 40 of file AudioFile.hxx.

---

Constructor & Destructor Documentation

CLAM::AudioFile::AudioFile

(

)

Definition at line 26 of file AudioFile.cxx.

Referenced by AudioFile().

CLAM::AudioFile::AudioFile

(

const AudioFile &

obj

)

Definition at line 32 of file AudioFile.cxx.

References AudioFile(), CLAM::EAudioFileCodec::eUnknown, and NULL.

CLAM::AudioFile::~AudioFile

(

)

[virtual]

Definition at line 51 of file AudioFile.cxx.

References mCodec, and mLocation.

---

Member Function Documentation

void CLAM::AudioFile::ActivateCodec

(

)

[protected]

Definition at line 162 of file AudioFile.cxx.

EAudioFileCodec CLAM::AudioFile::GetCodec

(

)

const

Definition at line 136 of file AudioFile.cxx.

Referenced by CLAM::MultiChannelAudioFileReader::GetCodec(), and CLAM::MonoAudioFileReader::GetCodec().

const AudioFileHeader& CLAM::AudioFile::GetHeader

(

)

const [inline]

Definition at line 50 of file AudioFile.hxx.

Referenced by CLAM::MultiChannelAudioFileReader::GetHeader(), CLAM::MonoAudioFileReader::GetHeader(), CLAM::AudioCodecs::OggVorbisAudioStream::OggVorbisAudioStream(), CLAM::AudioCodecs::PCMAudioStream::PCMAudioStream(), and CLAM::AudioCodecs::MpegAudioStream::~MpegAudioStream().

const Filename& CLAM::AudioFile::GetLocation

(

)

const [inline]

Definition at line 49 of file AudioFile.hxx.

References mLocation.

Referenced by CLAM::AudioCodecs::OggVorbisAudioStream::OggVorbisAudioStream(), CLAM::AudioCodecs::PCMAudioStream::PCMAudioStream(), and CLAM::AudioCodecs::MpegAudioStream::~MpegAudioStream().

AudioCodecs::Stream * CLAM::AudioFile::GetStream

(

)

Definition at line 156 of file AudioFile.cxx.

References CLAM::AudioCodecs::Codec::IsReadable(), and mLocation.

Referenced by CLAM::MultiChannelAudioFileWriter::ConcreteStop().

AudioTextDescriptors& CLAM::AudioFile::GetTextDescriptors

(

)

[inline]

Definition at line 52 of file AudioFile.hxx.

const AudioTextDescriptors& CLAM::AudioFile::GetTextDescriptors

(

)

const [inline]

Definition at line 51 of file AudioFile.hxx.

Referenced by CLAM::MultiChannelAudioFileReader::GetTextDescriptors(), and CLAM::MonoAudioFileReader::GetTextDescriptors().

bool CLAM::AudioFile::IsReadable

(

)

const

Definition at line 146 of file AudioFile.cxx.

References mCodec.

bool CLAM::AudioFile::IsValid

(

)

const

Definition at line 141 of file AudioFile.cxx.

bool CLAM::AudioFile::IsWritable

(

)

const

Definition at line 151 of file AudioFile.cxx.

References NULL.

const AudioFile & CLAM::AudioFile::operator=

(

const AudioFile &

obj

)

Definition at line 41 of file AudioFile.cxx.

References mCodec, and mLocation.

void CLAM::AudioFile::ResetHeaderData

(

)

[protected]

Definition at line 169 of file AudioFile.cxx.

void CLAM::AudioFile::ResolveCodec

(

)

[protected]

Definition at line 55 of file AudioFile.cxx.

bool CLAM::AudioFile::SetHeader

(

const AudioFileHeader &

newHeader

)

[protected]

Usually the header is set into the file using CreateNew or OpenExistig (public) methods.

Definition at line 89 of file AudioFile.cxx.

References CLAM::EAudioFileCodec::eMpeg, Instantiate(), and mCodec.

void CLAM::AudioFile::SetTextDescriptors

(

const AudioTextDescriptors &

descriptors

)

[inline]

Definition at line 54 of file AudioFile.hxx.

---

Member Data Documentation

EAudioFileCodec CLAM::AudioFile::mCodec [protected]

Definition at line 73 of file AudioFile.hxx.

Referenced by IsReadable(), operator=(), SetHeader(), and ~AudioFile().

Filename CLAM::AudioFile::mLocation [protected]

Definition at line 72 of file AudioFile.hxx.

Referenced by GetLocation(), GetStream(), operator=(), and ~AudioFile().

---

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

• AudioFile.hxx
• AudioFile.cxx