CLAM-Development: CLAM::AudioCodecs::OggVorbisCodec Class Reference

CLAM-Development 1.3

Codec inplementation for the Ogg Vorbis audio file format. More...

#include <OggVorbisCodec.hxx>

List of all members.

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 ()

Detailed Description

Codec inplementation for the Ogg Vorbis audio file format.

Definition at line 32 of file OggVorbisCodec.hxx.

Constructor & Destructor Documentation

CLAM::AudioCodecs::OggVorbisCodec::~OggVorbisCodec ( ) [virtual]

Definition at line 46 of file OggVorbisCodec.cxx.

Member Function Documentation

Stream * CLAM::AudioCodecs::OggVorbisCodec::GetStreamFor ( const AudioFile & ) [virtual]

Returns an Stream object to read or write on.

Implements CLAM::AudioCodecs::Codec.

Definition at line 104 of file OggVorbisCodec.cxx.

OggVorbisCodec & CLAM::AudioCodecs::OggVorbisCodec::Instantiate ( ) [static]

Definition at line 50 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 57 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 91 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 109 of file OggVorbisCodec.cxx.

References CLAM::EAudioFileEncoding::eDefault, CLAM::EAudioFileEndianess::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 152 of file OggVorbisCodec.cxx.

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

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