TagLib::Tag Class Reference

A simple, generic interface to common audio meta data fields. More...

#include <tag.h>

Inheritance diagram for TagLib::Tag:

[legend]

List of all members.

Public Member Functions
virtual	~Tag ()
virtual String	title () const =0
virtual String	artist () const =0
virtual String	album () const =0
virtual String	comment () const =0
virtual String	genre () const =0
virtual uint	year () const =0
virtual uint	track () const =0
virtual void	setTitle (const String &s)=0
virtual void	setArtist (const String &s)=0
virtual void	setAlbum (const String &s)=0
virtual void	setComment (const String &s)=0
virtual void	setGenre (const String &s)=0
virtual void	setYear (uint i)=0
virtual void	setTrack (uint i)=0
virtual bool	isEmpty () const
Static Public Member Functions
static void	duplicate (const Tag *source, Tag *target, bool overwrite=true)
Protected Member Functions
	Tag ()

---

Detailed Description

A simple, generic interface to common audio meta data fields.

This is an attempt to abstract away the difference in the meta data formats of various audio codecs and tagging schemes. As such it is generally a subset of what is available in the specific formats but should be suitable for most applications. This is meant to compliment the generic APIs found in TagLib::AudioProperties, TagLib::File and TagLib::FileRef.

---

Constructor & Destructor Documentation

virtual TagLib::Tag::~Tag

(

)

[virtual]

Detroys this Tag instance.

Reimplemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, and TagLib::ID3v2::Tag.

TagLib::Tag::Tag

(

)

[protected]

Construct a Tag. This is protected since tags should only be instantiated through subclasses.

Reimplemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, and TagLib::ID3v2::Tag.

---

Member Function Documentation

virtual String TagLib::Tag::title

(

)

const [pure virtual]

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

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual String TagLib::Tag::artist

(

)

const [pure virtual]

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

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual String TagLib::Tag::album

(

)

const [pure virtual]

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

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual String TagLib::Tag::comment

(

)

const [pure virtual]

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

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual String TagLib::Tag::genre

(

)

const [pure virtual]

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

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual uint TagLib::Tag::year

(

)

const [pure virtual]

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

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual uint TagLib::Tag::track

(

)

const [pure virtual]

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

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual void TagLib::Tag::setTitle

(

const String &

s

)

[pure virtual]

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

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual void TagLib::Tag::setArtist

(

const String &

s

)

[pure virtual]

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

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual void TagLib::Tag::setAlbum

(

const String &

s

)

[pure virtual]

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

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual void TagLib::Tag::setComment

(

const String &

s

)

[pure virtual]

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

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual void TagLib::Tag::setGenre

(

const String &

s

)

[pure 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.

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual void TagLib::Tag::setYear

(

uint

i

)

[pure virtual]

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

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual void TagLib::Tag::setTrack

(

uint

i

)

[pure virtual]

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

Implemented in TagLib::APE::Tag, TagLib::ID3v1::Tag, TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

virtual bool TagLib::Tag::isEmpty

(

)

const [virtual]

Returns true if the tag does not contain any data. This should be reimplemented in subclasses that provide more than the basic tagging abilities in this class.

Reimplemented in TagLib::ID3v2::Tag, and TagLib::Ogg::XiphComment.

static void TagLib::Tag::duplicate	(	const Tag *	source,
		Tag *	target,
		bool	overwrite = true
	)			[static]

Copies the generic data from one tag to another.

Note:

This will no affect any of the lower level details of the tag. For instance if any of the tag type specific data (maybe a URL for a band) is set, this will not modify or copy that. This just copies using the API in this class.

If overwrite is true then the values will be unconditionally copied. If false only empty values will be overwritten.

---

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

• tag.h