TagLib API Documentation

TagLib::Ogg::File Class Reference

An implementation of TagLib::File with some helpers for Ogg based formats. More...

#include <oggfile.h>

Inheritance diagram for TagLib::Ogg::File:

TagLib::File TagLib::Vorbis::File List of all members.

Public Member Functions

virtual ~File ()
ByteVector packet (uint i)
void setPacket (uint i, const ByteVector &p)
const PageHeaderfirstPageHeader ()
const PageHeaderlastPageHeader ()
virtual void save ()

Protected Member Functions

 File (const char *file)

Detailed Description

An implementation of TagLib::File with some helpers for Ogg based formats.

This is an implementation of Ogg file page and packet rendering and is of use to Ogg based formats. While the API is small this handles the non-trivial details of breaking up an Ogg stream into packets and makes these available (via subclassing) to the codec meta data implementations.

Definition at line 45 of file oggfile.h.


Constructor & Destructor Documentation

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

Destroys this File instance.

Reimplemented from TagLib::File.

Reimplemented in TagLib::Vorbis::File.

TagLib::Ogg::File::File const char *  file  )  [protected]
 

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

Note:
This constructor is protected since Ogg::File shouldn't be instantiated directly but rather should be used through the codec specific subclasses.

Reimplemented from TagLib::File.


Member Function Documentation

ByteVector TagLib::Ogg::File::packet uint  i  ) 
 

Returns the packet contents for the i-th packet (starting from zero) in the Ogg bitstream.

Warning:
The requires reading at least the packet header for every page up to the requested page.

void TagLib::Ogg::File::setPacket uint  i,
const ByteVector p
 

Sets the packet with index i to the value p.

const PageHeader* TagLib::Ogg::File::firstPageHeader  ) 
 

Returns a pointer to the PageHeader for the first page in the stream or null if the page could not be found.

const PageHeader* TagLib::Ogg::File::lastPageHeader  ) 
 

Returns a pointer to the PageHeader for the last page in the stream or null if the page could not be found.

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

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

Implements TagLib::File.

Reimplemented in TagLib::Vorbis::File.


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for TagLib Version 1.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Jan 22 05:44:23 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2003