Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

TagLib::Vorbis::File Class Reference

An implementation of Ogg::File with Vorbis specific methods. More...

#include <vorbisfile.h>

Inheritance diagram for TagLib::Vorbis::File:

Inheritance graph
[legend]
Collaboration diagram for TagLib::Vorbis::File:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 File (const char *file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
virtual ~File ()
virtual Ogg::XiphCommenttag () const
virtual PropertiesaudioProperties () const
virtual void save ()

Detailed Description

An implementation of Ogg::File with Vorbis specific methods.

This is the central class in the Ogg Vorbis metadata processing collection of classes. It's built upon Ogg::File which handles processing of the Ogg logical bitstream and breaking it down into pages which are handled by the codec implementations, in this case Vorbis specifically.


Constructor & Destructor Documentation

TagLib::Vorbis::File::File const char *  file,
bool  readProperties = true,
Properties::ReadStyle  propertiesStyle = Properties::Average
 

Contructs a Vorbis file from file. If readProperties is true the file's audio properties will also be read using propertiesStyle. If false, propertiesStyle is ignored.

virtual TagLib::Vorbis::File::~File  )  [virtual]
 

Destroys this instance of the File.

Reimplemented from TagLib::Ogg::File.


Member Function Documentation

virtual Properties* TagLib::Vorbis::File::audioProperties  )  const [virtual]
 

Returns the Vorbis::Properties for this file. If no audio properties were read then this will return a null pointer.

Implements TagLib::File.

virtual void TagLib::Vorbis::File::save  )  [virtual]
 

Save the file and its associated tags. This should be reimplemented in the concrete subclasses.

Reimplemented from TagLib::Ogg::File.

virtual Ogg::XiphComment* TagLib::Vorbis::File::tag  )  const [virtual]
 

Returns the XiphComment for this file. XiphComment implements the tag interface, so this serves as the reimplementation of TagLib::File::tag().

Implements TagLib::File.


The documentation for this class was generated from the following file:
Generated on Mon Jun 7 12:51:55 2004 for TagLib by doxygen 1.3.4