TagLib::PropertyMap Class Reference

A map for format-independent <key,valuelist> tag representations. More...

#include <tpropertymap.h>

Inheritance diagram for TagLib::PropertyMap:
Collaboration diagram for TagLib::PropertyMap:

Public Types

typedef SimplePropertyMap::Iterator Iterator
 
typedef
SimplePropertyMap::ConstIterator 
ConstIterator
 

Public Member Functions

 PropertyMap ()
 
 PropertyMap (const PropertyMap &m)
 
 PropertyMap (const SimplePropertyMap &m)
 
virtual ~PropertyMap ()
 
bool insert (const String &key, const StringList &values)
 
bool replace (const String &key, const StringList &values)
 
Iterator find (const String &key)
 
ConstIterator find (const String &key) const
 
bool contains (const String &key) const
 
bool contains (const PropertyMap &other) const
 
PropertyMaperase (const String &key)
 
PropertyMaperase (const PropertyMap &other)
 
PropertyMapmerge (const PropertyMap &other)
 
const StringListoperator[] (const String &key) const
 
StringListoperator[] (const String &key)
 
bool operator== (const PropertyMap &other) const
 
bool operator!= (const PropertyMap &other) const
 
StringListunsupportedData ()
 
const StringListunsupportedData () const
 
void removeEmpty ()
 
String toString () const
 
- Public Member Functions inherited from TagLib::Map< Key, T >
 Map ()
 
 Map (const Map< Key, T > &m)
 
virtual ~Map ()
 
Iterator begin ()
 
ConstIterator begin () const
 
Iterator end ()
 
ConstIterator end () const
 
Map< Key, T > & insert (const Key &key, const T &value)
 
Map< Key, T > & clear ()
 
unsigned int size () const
 
bool isEmpty () const
 
Iterator find (const Key &key)
 
ConstIterator find (const Key &key) const
 
bool contains (const Key &key) const
 
Map< Key, T > & erase (Iterator it)
 
Map< Key, T > & erase (const Key &key)
 
const T & operator[] (const Key &key) const
 
T & operator[] (const Key &key)
 
Map< Key, T > & operator= (const Map< Key, T > &m)
 

Additional Inherited Members

- Protected Member Functions inherited from TagLib::Map< Key, T >
void detach ()
 

Detailed Description

A map for format-independent <key,valuelist> tag representations.

This map implements a generic representation of textual audio metadata ("tags") realized as pairs of a case-insensitive key and a nonempty list of corresponding values, each value being an arbitrary unicode String.

Note that most metadata formats pose additional conditions on the tag keys. The most popular ones (Vorbis, APE, ID3v2) should support all ASCII only words of length between 2 and 16.

This class can contain any tags, but here is a list of "well-known" tags that you might want to use:

Basic tags:

  • TITLE
  • ALBUM
  • ARTIST
  • ALBUMARTIST
  • SUBTITLE
  • TRACKNUMBER
  • DISCNUMBER
  • DATE
  • ORIGINALDATE
  • GENRE
  • COMMENT

Sort names:

  • TITLESORT
  • ALBUMSORT
  • ARTISTSORT
  • ALBUMARTISTSORT

Credits:

  • COMPOSER
  • LYRICIST
  • CONDUCTOR
  • REMIXER
  • PERFORMER:<XXXX>

Other tags:

  • ISRC
  • ASIN
  • BPM
  • COPYRIGHT
  • ENCODEDBY
  • MOOD
  • COMMENT
  • MEDIA
  • LABEL
  • CATALOGNUMBER
  • BARCODE

MusicBrainz identifiers:

  • MUSICBRAINZ_TRACKID
  • MUSICBRAINZ_ALBUMID
  • MUSICBRAINZ_RELEASEGROUPID
  • MUSICBRAINZ_WORKID
  • MUSICBRAINZ_ARTISTID
  • MUSICBRAINZ_ALBUMARTISTID
  • ACOUSTID_ID
  • ACOUSTID_FINGERPRINT
  • MUSICIP_PUID

Member Typedef Documentation

typedef SimplePropertyMap::ConstIterator TagLib::PropertyMap::ConstIterator
typedef SimplePropertyMap::Iterator TagLib::PropertyMap::Iterator

Constructor & Destructor Documentation

TagLib::PropertyMap::PropertyMap ( )
TagLib::PropertyMap::PropertyMap ( const PropertyMap m)
TagLib::PropertyMap::PropertyMap ( const SimplePropertyMap m)

Creates a PropertyMap initialized from a SimplePropertyMap. Copies all entries from m that have valid keys. Invalid keys will be appended to the unsupportedData() list.

virtual TagLib::PropertyMap::~PropertyMap ( )
virtual

Member Function Documentation

bool TagLib::PropertyMap::contains ( const String key) const

Returns true if the map contains values for key.

bool TagLib::PropertyMap::contains ( const PropertyMap other) const

Returns true if this map contains all keys of other and the values coincide for that keys. Does not take the unsupportedData list into account.

PropertyMap& TagLib::PropertyMap::erase ( const String key)

Erase the key and its values from the map.

PropertyMap& TagLib::PropertyMap::erase ( const PropertyMap other)

Erases from this map all keys that appear in other.

Iterator TagLib::PropertyMap::find ( const String key)

Find the first occurrence of key.

ConstIterator TagLib::PropertyMap::find ( const String key) const

Find the first occurrence of key.

bool TagLib::PropertyMap::insert ( const String key,
const StringList values 
)

Inserts values under key in the map. If key already exists, then values will be appended to the existing StringList. The returned value indicates success, i.e. whether key is a valid key.

PropertyMap& TagLib::PropertyMap::merge ( const PropertyMap other)

Merge the contents of other into this PropertyMap. If a key is contained in both maps, the values of the second are appended to that of the first. The unsupportedData() lists are concatenated as well.

bool TagLib::PropertyMap::operator!= ( const PropertyMap other) const

Returns false if and only has the same contents as this map.

bool TagLib::PropertyMap::operator== ( const PropertyMap other) const

Returns true if and only if has the same contents as this map.

const StringList& TagLib::PropertyMap::operator[] ( const String key) const

Returns a reference to the value associated with key.

Note
: If key is not contained in the map, an empty StringList is returned without error.
StringList& TagLib::PropertyMap::operator[] ( const String key)

Returns a reference to the value associated with key.

Note
: If key is not contained in the map, an empty StringList is returned. You can also directly add entries by using this function as an lvalue.
void TagLib::PropertyMap::removeEmpty ( )

Removes all entries which have an empty value list.

bool TagLib::PropertyMap::replace ( const String key,
const StringList values 
)

Replaces any existing values for key with the given values, and simply insert them if key did not exist before. The returned value indicates success, i.e. whether key is a valid key.

String TagLib::PropertyMap::toString ( ) const
StringList& TagLib::PropertyMap::unsupportedData ( )

If a PropertyMap is read from a File object using File::properties(), the StringList returned from this function will represent metadata that could not be parsed into the PropertyMap representation. This could be e.g. binary data, unknown ID3 frames, etc. You can remove items from the returned list, which tells TagLib to remove those unsupported elements if you call File::setProperties() with the same PropertyMap as argument.

const StringList& TagLib::PropertyMap::unsupportedData ( ) const

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