TagLib 1.8.0 (TagLib::Ogg::Vorbis::File Class Reference)

TagLib::Ogg::Vorbis::File Class Reference

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

#include <vorbisfile.h>

Inheritance diagram for TagLib::Ogg::Vorbis::File:
Collaboration diagram for TagLib::Ogg::Vorbis::File:

List of all members.

Public Member Functions

 File (FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
 File (IOStream *stream, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
virtual ~File ()
virtual Ogg::XiphCommenttag () const
PropertyMap properties () const
PropertyMap setProperties (const PropertyMap &)
virtual PropertiesaudioProperties () const
virtual bool save ()
- Public Member Functions inherited from TagLib::Ogg::File
ByteVector packet (uint i)
void setPacket (uint i, const ByteVector &p)
const PageHeaderfirstPageHeader ()
const PageHeaderlastPageHeader ()
- Public Member Functions inherited from TagLib::File
FileName name () const
void removeUnsupportedProperties (const StringList &properties)
ByteVector readBlock (ulong length)
void writeBlock (const ByteVector &data)
long find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector::null)
long rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector::null)
void insert (const ByteVector &data, ulong start=0, ulong replace=0)
void removeBlock (ulong start=0, ulong length=0)
bool readOnly () const
bool isOpen () const
bool isValid () const
void seek (long offset, Position p=Beginning)
void clear ()
long tell () const
long length ()

Additional Inherited Members

- Protected Member Functions inherited from TagLib::Ogg::File
 File (FileName file)
 File (IOStream *stream)
- Protected Member Functions inherited from TagLib::File
void setValid (bool valid)
void truncate (long length)

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::Ogg::Vorbis::File::File ( FileName  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.

TagLib::Ogg::Vorbis::File::File ( IOStream stream,
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.

Note:
TagLib will not take ownership of the stream, the caller is responsible for deleting it after the File object.
virtual TagLib::Ogg::Vorbis::File::~File ( )
virtual

Destroys this instance of the File.

Reimplemented from TagLib::Ogg::File.


Member Function Documentation

virtual Properties* TagLib::Ogg::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.

PropertyMap TagLib::Ogg::Vorbis::File::properties ( ) const

Implements the unified property interface – export function. This forwards directly to XiphComment::properties().

Reimplemented from TagLib::File.

virtual bool TagLib::Ogg::Vorbis::File::save ( )
virtual

Save the file and its associated tags. This should be reimplemented in the concrete subclasses. Returns true if the save succeeds.

Warning:
On UNIX multiple processes are able to write to the same file at the same time. This can result in serious file corruption. If you are developing a program that makes use of TagLib from multiple processes you must insure that you are only doing writes to a particular file from one of them.

Reimplemented from TagLib::Ogg::File.

PropertyMap TagLib::Ogg::Vorbis::File::setProperties ( const PropertyMap )

Implements the unified tag dictionary interface – import function. Like properties(), this is a forwarder to the file's XiphComment.

Reimplemented from TagLib::File.

virtual Ogg::XiphComment* TagLib::Ogg::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: