TagLib API Documentation

TagLib::ID3v2::UnknownFrame Class Reference

A frame type unknown to TagLib. More...

#include <unknownframe.h>

Inheritance diagram for TagLib::ID3v2::UnknownFrame:

TagLib::ID3v2::Frame List of all members.

Public Member Functions

 UnknownFrame (const ByteVector &data)
virtual ~UnknownFrame ()
virtual String toString () const
ByteVector data () const

Protected Member Functions

virtual void parseFields (const ByteVector &data)
virtual ByteVector renderFields () const

Friends

class FrameFactory

Detailed Description

A frame type unknown to TagLib.

This class represents a frame type not known (or more often simply unimplemented) in TagLib. This is here provide a basic API for manipulating the binary data of unknown frames and to provide a means of rendering such unknown frames.

Please note that a cleaner way of handling frame types that TagLib does not understand is to subclass ID3v2::Frame and ID3v2::FrameFactory to have your frame type supported through the standard ID3v2 mechanism.

Definition at line 44 of file unknownframe.h.


Constructor & Destructor Documentation

TagLib::ID3v2::UnknownFrame::UnknownFrame const ByteVector data  ) 
 

virtual TagLib::ID3v2::UnknownFrame::~UnknownFrame  )  [virtual]
 


Member Function Documentation

virtual String TagLib::ID3v2::UnknownFrame::toString  )  const [virtual]
 

This returns the textual representation of the data in the frame. Subclasses must reimplement this method to provide a string representation of the frame's data.

Implements TagLib::ID3v2::Frame.

ByteVector TagLib::ID3v2::UnknownFrame::data  )  const
 

Returns the field data (everything but the header) for this frame.

virtual void TagLib::ID3v2::UnknownFrame::parseFields const ByteVector data  )  [protected, virtual]
 

Called by parse() to parse the field data. It makes this information available through the public API. This must be overridden by the subclasses.

Implements TagLib::ID3v2::Frame.

virtual ByteVector TagLib::ID3v2::UnknownFrame::renderFields  )  const [protected, virtual]
 

Render the field data back to a binary format in a ByteVector. This must be overridden by subclasses.

Implements TagLib::ID3v2::Frame.


Friends And Related Function Documentation

friend class FrameFactory [friend]
 

Reimplemented from TagLib::ID3v2::Frame.

Definition at line 46 of file unknownframe.h.


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:22 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2003