CLAM-Development  1.4.0
Public Member Functions | Protected Member Functions | Protected Attributes
CLAM::AudioFile Class Reference

#include <AudioFile.hxx>

List of all members.

Public Member Functions

 AudioFile ()
 AudioFile (const AudioFile &)
const AudioFileoperator= (const AudioFile &)
virtual ~AudioFile ()
const FilenameGetLocation () const
const AudioFileHeaderGetHeader () const
const AudioTextDescriptorsGetTextDescriptors () const
AudioTextDescriptorsGetTextDescriptors ()
void SetTextDescriptors (const AudioTextDescriptors &descriptors)
EAudioFileCodec GetCodec () const
bool IsValid () const
bool IsReadable () const
bool IsWritable () const
AudioCodecs::StreamGetStream ()

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 35 of file AudioFile.cxx.

CLAM::AudioFile::AudioFile ( const AudioFile obj)

Definition at line 41 of file AudioFile.cxx.

References mCodec, and mLocation.

CLAM::AudioFile::~AudioFile ( )
virtual

Definition at line 60 of file AudioFile.cxx.


Member Function Documentation

void CLAM::AudioFile::ActivateCodec ( )
protected
EAudioFileCodec CLAM::AudioFile::GetCodec ( ) const
const AudioFileHeader& CLAM::AudioFile::GetHeader ( ) const
inline
const Filename& CLAM::AudioFile::GetLocation ( ) const
inline
AudioCodecs::Stream * CLAM::AudioFile::GetStream ( )
const AudioTextDescriptors& CLAM::AudioFile::GetTextDescriptors ( ) const
inline
AudioTextDescriptors& CLAM::AudioFile::GetTextDescriptors ( )
inline

Definition at line 52 of file AudioFile.hxx.

bool CLAM::AudioFile::IsReadable ( ) const
bool CLAM::AudioFile::IsValid ( ) const

Definition at line 150 of file AudioFile.cxx.

References NULL.

bool CLAM::AudioFile::IsWritable ( ) const
const AudioFile & CLAM::AudioFile::operator= ( const AudioFile obj)

Definition at line 50 of file AudioFile.cxx.

References mCodec, and mLocation.

void CLAM::AudioFile::ResetHeaderData ( )
protected

Definition at line 178 of file AudioFile.cxx.

References CLAM::DynamicType::UpdateData().

Referenced by CLAM::AudioFileSource::OpenExisting().

void CLAM::AudioFile::ResolveCodec ( )
protected
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 98 of file AudioFile.cxx.

References CLAM_ASSERT, CLAM::EAudioFileEndianess::eDefault, CLAM::EAudioFileCodec::eOggVorbis, CLAM::EAudioFileCodec::ePCM, CLAM::EAudioFileFormat::eVorbisMk1, Instantiate(), mCodec, and CLAM::DynamicType::UpdateData().

Referenced by CLAM::AudioFileTarget::CreateNew().

void CLAM::AudioFile::SetTextDescriptors ( const AudioTextDescriptors descriptors)
inline

Definition at line 54 of file AudioFile.hxx.


Member Data Documentation

EAudioFileCodec CLAM::AudioFile::mCodec
protected
Filename CLAM::AudioFile::mLocation
protected

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