TagLib 1.6.1 (TagLib: TagLib::APE::Tag Class Reference)

TagLib::APE::Tag Class Reference

An APE tag implementation. More...

#include <apetag.h>

Inheritance diagram for TagLib::APE::Tag:
Collaboration diagram for TagLib::APE::Tag:

List of all members.

Public Member Functions

 Tag ()
 Tag (File *file, long footerLocation)
virtual ~Tag ()
ByteVector render () const
virtual String title () const
virtual String artist () const
virtual String album () const
virtual String comment () const
virtual String genre () const
virtual uint year () const
virtual uint track () const
virtual void setTitle (const String &s)
virtual void setArtist (const String &s)
virtual void setAlbum (const String &s)
virtual void setComment (const String &s)
virtual void setGenre (const String &s)
virtual void setYear (uint i)
virtual void setTrack (uint i)
Footerfooter () const
const ItemListMapitemListMap () const
void removeItem (const String &key)
void addValue (const String &key, const String &value, bool replace=true)
void setItem (const String &key, const Item &item)

Static Public Member Functions

static ByteVector fileIdentifier ()

Protected Member Functions

void read ()
void parse (const ByteVector &data)


Detailed Description

An APE tag implementation.

Constructor & Destructor Documentation

TagLib::APE::Tag::Tag (  ) 

Create an APE tag with default values.

Reimplemented from TagLib::Tag.

TagLib::APE::Tag::Tag ( File file,
long  footerLocation 
)

Create an APE tag and parse the data in file with APE footer at tagOffset.

virtual TagLib::APE::Tag::~Tag (  )  [virtual]

Destroys this Tag instance.

Reimplemented from TagLib::Tag.


Member Function Documentation

void TagLib::APE::Tag::addValue ( const String key,
const String value,
bool  replace = true 
)

Adds to the item specified by key the data value. If replace is true, then all of the other values on the same key will be removed first.

virtual String TagLib::APE::Tag::album (  )  const [virtual]

Returns the album name; if no album name is present in the tag String::null will be returned.

Implements TagLib::Tag.

virtual String TagLib::APE::Tag::artist (  )  const [virtual]

Returns the artist name; if no artist name is present in the tag String::null will be returned.

Implements TagLib::Tag.

virtual String TagLib::APE::Tag::comment (  )  const [virtual]

Returns the track comment; if no comment is present in the tag String::null will be returned.

Implements TagLib::Tag.

static ByteVector TagLib::APE::Tag::fileIdentifier (  )  [static]

Returns the string "APETAGEX" suitable for usage in locating the tag in a file.

Footer* TagLib::APE::Tag::footer (  )  const

Returns a pointer to the tag's footer.

virtual String TagLib::APE::Tag::genre (  )  const [virtual]

Returns the genre name; if no genre is present in the tag String::null will be returned.

Implements TagLib::Tag.

const ItemListMap& TagLib::APE::Tag::itemListMap (  )  const

Returns a reference to the item list map. This is an ItemListMap of all of the items in the tag.

This is the most powerfull structure for accessing the items of the tag.

Warning:
You should not modify this data structure directly, instead use setItem() and removeItem().

void TagLib::APE::Tag::parse ( const ByteVector data  )  [protected]

Parses the body of the tag in data.

void TagLib::APE::Tag::read (  )  [protected]

Reads from the file specified in the constructor.

void TagLib::APE::Tag::removeItem ( const String key  ) 

Removes the key item from the tag

ByteVector TagLib::APE::Tag::render (  )  const

Renders the in memory values to a ByteVector suitable for writing to the file.

virtual void TagLib::APE::Tag::setAlbum ( const String s  )  [virtual]

Sets the album to s. If s is String::null then this value will be cleared.

Implements TagLib::Tag.

virtual void TagLib::APE::Tag::setArtist ( const String s  )  [virtual]

Sets the artist to s. If s is String::null then this value will be cleared.

Implements TagLib::Tag.

virtual void TagLib::APE::Tag::setComment ( const String s  )  [virtual]

Sets the comment to s. If s is String::null then this value will be cleared.

Implements TagLib::Tag.

virtual void TagLib::APE::Tag::setGenre ( const String s  )  [virtual]

Sets the genre to s. If s is String::null then this value will be cleared. For tag formats that use a fixed set of genres, the appropriate value will be selected based on a string comparison. A list of available genres for those formats should be available in that type's implementation.

Implements TagLib::Tag.

void TagLib::APE::Tag::setItem ( const String key,
const Item item 
)

Sets the key item to the value of item. If an item with the key is already present, it will be replaced.

virtual void TagLib::APE::Tag::setTitle ( const String s  )  [virtual]

Sets the title to s. If s is String::null then this value will be cleared.

Implements TagLib::Tag.

virtual void TagLib::APE::Tag::setTrack ( uint  i  )  [virtual]

Sets the track to i. If s is 0 then this value will be cleared.

Implements TagLib::Tag.

virtual void TagLib::APE::Tag::setYear ( uint  i  )  [virtual]

Sets the year to i. If s is 0 then this value will be cleared.

Implements TagLib::Tag.

virtual String TagLib::APE::Tag::title (  )  const [virtual]

Returns the track name; if no track name is present in the tag String::null will be returned.

Implements TagLib::Tag.

virtual uint TagLib::APE::Tag::track (  )  const [virtual]

Returns the track number; if there is no track number set, this will return 0.

Implements TagLib::Tag.

virtual uint TagLib::APE::Tag::year (  )  const [virtual]

Returns the year; if there is no year set, this will return 0.

Implements TagLib::Tag.


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