CLAM::EAudioFileFormat Class Reference

#include <AudioFileFormats.hxx>

List of all members.

Public Types
enum	{   eWAV = SF_FORMAT_WAV, eAIFF = SF_FORMAT_AIFF, eAU = SF_FORMAT_AU, eRAW = SF_FORMAT_RAW,   ePAF = SF_FORMAT_PAF, eSVX = SF_FORMAT_SVX, eNIST = SF_FORMAT_NIST, eVOC = SF_FORMAT_VOC,   eIRCAM = SF_FORMAT_IRCAM, eW64 = SF_FORMAT_W64, eMAT4 = SF_FORMAT_MAT4, eMAT5 = SF_FORMAT_MAT5,   eVorbisMk1 = 1000 + SF_FORMAT_MAT5, eMpegLayer1 = 1001 + SF_FORMAT_MAT5, eMpegLayer2 = 1002 + SF_FORMAT_MAT5, eMpegLayer3 = 1003 + SF_FORMAT_MAT5 }
Public Types inherited from CLAM::Enum
typedef int	tValue

Public Member Functions
	EAudioFileFormat ()
	EAudioFileFormat (tValue val)
	EAudioFileFormat (std::string s)
virtual Component *	Species () const
	Returns a new object of the same class than the receiver object.
Public Member Functions inherited from CLAM::Enum
const tEnumValue *	GetSymbolMap () const
	Returns the symbol map for the enum.
void	SetValue (const tValue v)
	Changes the value.
void	SetValueSafely (const tValue v) throw (IllegalValue)
	Changes the value safely.
void	SetValue (const std::string &s)
	Changes the value.
void	SetValueSafely (const std::string &s) throw (IllegalValue)
tValue	GetValue () const
	Returns the numeric value.
std::string	GetString () const throw (IllegalValue)
	Returns the symbolic value.
Enum &	operator= (const tValue &v) throw (IllegalValue)
Enum &	operator= (const std::string &v) throw (IllegalValue)
Enum &	operator= (const Enum &v) throw (IllegalValue)
	operator tValue () const
	Conversion operiation as a number.
virtual Component *	DeepCopy () const
	TODO: Copy documentation for this method from Component.
virtual Component *	ShallowCopy () const
	TODO: Copy documentation for this method from Component.
virtual void	StoreOn (Storage &storage) const
	Stores component's subitems on the given Storage.
virtual void	LoadFrom (Storage &storage)
	Loads component's subitems from the given Storage.
virtual	~Enum ()
	The required virtual destructor.
const char *	GetClassName () const
	Return the class name.
Public Member Functions inherited from CLAM::Component
virtual	~Component ()

Static Public Member Functions
static tValue	DefaultValue ()
static tEnumValue *	EnumValues ()
static EAudioFileFormat	FormatFromFilename (std::string filename)

Additional Inherited Members
	Enum (const tEnumValue *values, const tValue &value)
	Construction with a numeric value.
	Enum (const tEnumValue *values, const std::string &value)
	Construction with a symbolic value.

---

Detailed Description

Definition at line 70 of file AudioFileFormats.hxx.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

eWAV
eAIFF
eAU
eRAW
ePAF
eSVX
eNIST
eVOC
eIRCAM
eW64
eMAT4
eMAT5
eVorbisMk1
eMpegLayer1
eMpegLayer2
eMpegLayer3

Definition at line 78 of file AudioFileFormats.hxx.

---

Constructor & Destructor Documentation

CLAM::EAudioFileFormat::EAudioFileFormat ( )

inline

Definition at line 73 of file AudioFileFormats.hxx.

Referenced by Species().

CLAM::EAudioFileFormat::EAudioFileFormat ( tValue  val )

inline

Definition at line 74 of file AudioFileFormats.hxx.

CLAM::EAudioFileFormat::EAudioFileFormat ( std::string  s )

inline

Definition at line 75 of file AudioFileFormats.hxx.

---

Member Function Documentation

static tValue CLAM::EAudioFileFormat::DefaultValue ( )

inlinestatic

Definition at line 98 of file AudioFileFormats.hxx.

References eWAV.

static tEnumValue* CLAM::EAudioFileFormat::EnumValues ( )

inlinestatic

Definition at line 99 of file AudioFileFormats.hxx.

References eAIFF, eAU, eIRCAM, eMAT4, eMAT5, eMpegLayer1, eMpegLayer2, eMpegLayer3, eNIST, ePAF, eRAW, eSVX, eVOC, eVorbisMk1, eW64, and eWAV.

EAudioFileFormat CLAM::EAudioFileFormat::FormatFromFilename ( std::string  filename )

static

Definition at line 28 of file AudioFileFormats.cxx.

References eAIFF, eAU, eIRCAM, eMAT4, eMAT5, eMpegLayer1, eMpegLayer2, eMpegLayer3, eNIST, ePAF, eRAW, eSVX, eVOC, eVorbisMk1, eW64, and eWAV.

Referenced by CLAM::MonoAudioFileWriter::ConcreteConfigure(), and CLAM::MultiChannelAudioFileWriter::ConcreteConfigure().

virtual Component* CLAM::EAudioFileFormat::Species ( ) const

inlinevirtual

Returns a new object of the same class than the receiver object.

To be reimplemented by subclasses.

Returns:

a new allocated component. The pointer belongs to the caller.

Implements CLAM::Enum.

Definition at line 76 of file AudioFileFormats.hxx.

References EAudioFileFormat().

---

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

• AudioFileFormats.hxx
• AudioFileFormats.cxx