CLAM::AudioCodecs::OggVorbisCodec Class Reference

#include <OggVorbisCodec.hxx>

Inheritance diagram for CLAM::AudioCodecs::OggVorbisCodec:

List of all members.

---

Detailed Description

Codec inplementation for the Ogg Vorbis audio file format.

Definition at line 32 of file OggVorbisCodec.hxx.

Public Member Functions
virtual	~OggVorbisCodec ()
virtual bool	IsReadable (std::string uri) const
	Returns whether the filename is readable by the codec.
virtual bool	IsWritable (std::string uri, const AudioFileHeader &) const
	Returns whether codec can write a file with such name and header parameters.
virtual Stream *	GetStreamFor (const AudioFile &)
	Returns an Stream object to read or write on.
virtual void	RetrieveHeaderData (std::string uri, AudioFileHeader &)
	Returns a header structure containing file information (length, encoding.
virtual void	RetrieveTextDescriptors (std::string uri, AudioTextDescriptors &)
	Returns textual meta information embedded on the audio file such ID3 tags.
Static Public Member Functions
static OggVorbisCodec &	Instantiate ()
Protected Member Functions
	OggVorbisCodec ()

---

Constructor & Destructor Documentation

CLAM::AudioCodecs::OggVorbisCodec::OggVorbisCodec

(

)

[protected]

Definition at line 41 of file OggVorbisCodec.cxx.

CLAM::AudioCodecs::OggVorbisCodec::~OggVorbisCodec

(

)

[virtual]

Definition at line 45 of file OggVorbisCodec.cxx.

---

Member Function Documentation

OggVorbisCodec & CLAM::AudioCodecs::OggVorbisCodec::Instantiate

(

)

[static]

Definition at line 49 of file OggVorbisCodec.cxx.

Referenced by CLAM::AudioFile::ResolveCodec().

bool CLAM::AudioCodecs::OggVorbisCodec::IsReadable

(

std::string

filename

)

const [virtual]

Returns whether the filename is readable by the codec.

Implements CLAM::AudioCodecs::Codec.

Definition at line 56 of file OggVorbisCodec.cxx.

References NULL.

bool CLAM::AudioCodecs::OggVorbisCodec::IsWritable	(	std::string	filename,
		const AudioFileHeader &
	)			const [virtual]

Returns whether codec can write a file with such name and header parameters.

Implements CLAM::AudioCodecs::Codec.

Definition at line 90 of file OggVorbisCodec.cxx.

Stream * CLAM::AudioCodecs::OggVorbisCodec::GetStreamFor

(

const AudioFile &

)

[virtual]

Returns an Stream object to read or write on.

Implements CLAM::AudioCodecs::Codec.

Definition at line 103 of file OggVorbisCodec.cxx.

void CLAM::AudioCodecs::OggVorbisCodec::RetrieveHeaderData	(	std::string	uri,
		AudioFileHeader &
	)			[virtual]

Returns a header structure containing file information (length, encoding.

..)

Implements CLAM::AudioCodecs::Codec.

Definition at line 108 of file OggVorbisCodec.cxx.

References CLAM::EAudioFileEndianess::eDefault, CLAM::EAudioFileEncoding::eDefault, CLAM::EAudioFileFormat::eVorbisMk1, NULL, and CLAM::DynamicType::UpdateData().

void CLAM::AudioCodecs::OggVorbisCodec::RetrieveTextDescriptors	(	std::string	uri,
		AudioTextDescriptors &	tdesc
	)			[virtual]

Returns textual meta information embedded on the audio file such ID3 tags.

Reimplemented from CLAM::AudioCodecs::Codec.

Definition at line 151 of file OggVorbisCodec.cxx.

References NULL, and CLAM::DynamicType::UpdateData().

---

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

• OggVorbisCodec.hxx
• OggVorbisCodec.cxx