| TagLib 1.13 |  |

Public Types | Public Member Functions | Static Public Member Functions | List of all members
TagLib::MPEG::File Class Reference

An MPEG file class with some useful methods specific to MPEG. More...

`#include <mpegfile.h>`

Inheritance diagram for TagLib::MPEG::File:
[legend]
Collaboration diagram for TagLib::MPEG::File:
[legend]

## Public Types
enum | TagTypes { NoTags = 0x0000 , ID3v1 = 0x0001 , ID3v2 = 0x0002 , APE = 0x0004 , AllTags = 0xffff }
Public Types inherited from TagLib::File
enum | Position { Beginning , Current , End }
enum | StripTags { StripNone , StripOthers }
enum | DuplicateTags { Duplicate , DoNotDuplicate }

## Public Member Functions
| File (FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
| File (FileName file, ID3v2::FrameFactory *frameFactory, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
| File (IOStream *stream, ID3v2::FrameFactory *frameFactory, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
virtual | ~File ()
virtual Tag * | tag () const
PropertyMap | properties () const
void | removeUnsupportedProperties (const StringList &properties)
PropertyMap | setProperties (const PropertyMap &)
virtual Properties * | audioProperties () const
virtual bool | save ()
bool | save (int tags)
TAGLIB_DEPRECATED bool | save (int tags, bool stripOthers)
TAGLIB_DEPRECATED bool | save (int tags, bool stripOthers, int id3v2Version)
TAGLIB_DEPRECATED bool | save (int tags, bool stripOthers, int id3v2Version, bool duplicateTags)
bool | save (int tags, StripTags strip, ID3v2::Version version=ID3v2::v4, DuplicateTags duplicate=Duplicate)
ID3v2::Tag * | ID3v2Tag (bool create=false)
ID3v1::Tag * | ID3v1Tag (bool create=false)
APE::Tag * | APETag (bool create=false)
bool | strip (int tags=AllTags)
bool | strip (int tags, bool freeMemory)
TAGLIB_DEPRECATED void | setID3v2FrameFactory (const ID3v2::FrameFactory *factory)
long | firstFrameOffset ()
long | nextFrameOffset (long position)
long | previousFrameOffset (long position)
long | lastFrameOffset ()
bool | hasID3v1Tag () const
bool | hasID3v2Tag () const
bool | hasAPETag () const
Public Member Functions inherited from TagLib::File
virtual | ~File ()
FileName | name () const
virtual Tag * | tag () const =0
PropertyMap | properties () const
void | removeUnsupportedProperties (const StringList &properties)
PropertyMap | setProperties (const PropertyMap &properties)
virtual AudioProperties * | audioProperties () const =0
virtual bool | save ()=0
ByteVector | readBlock (unsigned long length)
void | writeBlock (const ByteVector &data)
long | find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
long | rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
void | insert (const ByteVector &data, unsigned long start=0, unsigned long replace=0)
void | removeBlock (unsigned long start=0, unsigned long length=0)
bool | readOnly () const
bool | isOpen () const
bool | isValid () const
void | seek (long offset, Position p=Beginning)
void | clear ()
long | tell () const
long | length ()

## Static Public Member Functions
static bool | isSupported (IOStream *stream)
Static Public Member Functions inherited from TagLib::File
static TAGLIB_DEPRECATED bool | isReadable (const char *file)
static TAGLIB_DEPRECATED bool | isWritable (const char *name)

## Additional Inherited Members
Protected Member Functions inherited from TagLib::File
| File (FileName file)
| File (IOStream *stream)
void | setValid (bool valid)
void | truncate (long length)
Static Protected Member Functions inherited from TagLib::File
static unsigned int | bufferSize ()

## Detailed Description

An MPEG file class with some useful methods specific to MPEG.

This implements the generic TagLib::File API and additionally provides access to properties that are distinct to MPEG files, notably access to the different ID3 tags.

## Member Enumeration Documentation

## ◆ TagTypes

enum TagLib::MPEG::File::TagTypes

This set of flags is used for various operations and is suitable for being OR-ed together.

Enumerator
NoTags | Empty set. Matches no tag types.
ID3v1 | Matches ID3v1 tags.
ID3v2 | Matches ID3v2 tags.
APE | Matches APE tags.
AllTags | Matches all tag types.

## Constructor & Destructor Documentation

## ◆ File() [1/3]

TagLib::MPEG::File::File | ( | FileName | file,
|  | bool | readProperties = `true`,
|  | Properties::ReadStyle | propertiesStyle = `Properties::Average`
| ) |  |

Constructs an MPEG file from file. If readProperties is true the file's audio properties will also be read.

Note
  In the current implementation, propertiesStyle is ignored.

Deprecated:
  This constructor will be dropped in favor of the one below in a future version.

## ◆ File() [2/3]

TagLib::MPEG::File::File | ( | FileName | file,
|  | ID3v2::FrameFactory * | frameFactory,
|  | bool | readProperties = `true`,
|  | Properties::ReadStyle | propertiesStyle = `Properties::Average`
| ) |  |

Constructs an MPEG file from file. If readProperties is true the file's audio properties will also be read.

If this file contains and ID3v2 tag the frames will be created using frameFactory.

Note
  In the current implementation, propertiesStyle is ignored.

## ◆ File() [3/3]

TagLib::MPEG::File::File | ( | IOStream * | stream,
|  | ID3v2::FrameFactory * | frameFactory,
|  | bool | readProperties = `true`,
|  | Properties::ReadStyle | propertiesStyle = `Properties::Average`
| ) |  |

Constructs an MPEG file from stream. If readProperties is true the file's audio properties will also be read.

Note
  TagLib will not take ownership of the stream, the caller is responsible for deleting it after the File object.

If this file contains and ID3v2 tag the frames will be created using frameFactory.

Note
  In the current implementation, propertiesStyle is ignored.

## ◆ ~File()

virtual TagLib::MPEG::File::~File | ( |  | ) |
| virtual

Destroys this instance of the File.

Reimplemented from TagLib::File.

## Member Function Documentation

## ◆ APETag()

APE::Tag * TagLib::MPEG::File::APETag | ( | bool | create = `false` | ) |

Returns a pointer to the APE tag of the file.

If create is false (the default) this may return a null pointer if there is no valid APE tag. If create is true it will create an APE tag if one does not exist and returns a valid pointer.

Note
  This may return a valid pointer regardless of whether or not the file on disk has an APE tag. Use hasAPETag() to check if the file on disk actually has an APE tag.
  The Tag is still owned by the MPEG::File and should not be deleted by the user. It will be deleted when the file (object) is destroyed.

See also
  hasAPETag()

## ◆ audioProperties()

virtual Properties * TagLib::MPEG::File::audioProperties | ( |  | ) | const
| virtual

Returns the MPEG::Properties for this file. If no audio properties were read then this will return a null pointer.

Implements TagLib::File.

## ◆ firstFrameOffset()

long TagLib::MPEG::File::firstFrameOffset | ( |  | ) |

Returns the position in the file of the first MPEG frame.

## ◆ hasAPETag()

bool TagLib::MPEG::File::hasAPETag | ( |  | ) | const

Returns whether or not the file on disk actually has an APE tag.

See also
  APETag()

## ◆ hasID3v1Tag()

bool TagLib::MPEG::File::hasID3v1Tag | ( |  | ) | const

Returns whether or not the file on disk actually has an ID3v1 tag.

See also
  ID3v1Tag()

## ◆ hasID3v2Tag()

bool TagLib::MPEG::File::hasID3v2Tag | ( |  | ) | const

Returns whether or not the file on disk actually has an ID3v2 tag.

See also
  ID3v2Tag()

## ◆ ID3v1Tag()

ID3v1::Tag * TagLib::MPEG::File::ID3v1Tag | ( | bool | create = `false` | ) |

Returns a pointer to the ID3v1 tag of the file.

If create is false (the default) this may return a null pointer if there is no valid ID3v1 tag. If create is true it will create an ID3v1 tag if one does not exist and returns a valid pointer.

Note
  This may return a valid pointer regardless of whether or not the file on disk has an ID3v1 tag. Use hasID3v1Tag() to check if the file on disk actually has an ID3v1 tag.
  The Tag is still owned by the MPEG::File and should not be deleted by the user. It will be deleted when the file (object) is destroyed.

See also
  hasID3v1Tag()

## ◆ ID3v2Tag()

ID3v2::Tag * TagLib::MPEG::File::ID3v2Tag | ( | bool | create = `false` | ) |

Returns a pointer to the ID3v2 tag of the file.

If create is false (the default) this may return a null pointer if there is no valid ID3v2 tag. If create is true it will create an ID3v2 tag if one does not exist and returns a valid pointer.

Note
  This may return a valid pointer regardless of whether or not the file on disk has an ID3v2 tag. Use hasID3v2Tag() to check if the file on disk actually has an ID3v2 tag.
  The Tag is still owned by the MPEG::File and should not be deleted by the user. It will be deleted when the file (object) is destroyed.

See also
  hasID3v2Tag()

## ◆ isSupported()

static bool TagLib::MPEG::File::isSupported | ( | IOStream * | stream | ) |
| static

Returns whether or not the given stream can be opened as an MPEG file.

Note
  This method is designed to do a quick check. The result may not necessarily be correct.

## ◆ lastFrameOffset()

long TagLib::MPEG::File::lastFrameOffset | ( |  | ) |

Returns the position in the file of the last MPEG frame.

## ◆ nextFrameOffset()

long TagLib::MPEG::File::nextFrameOffset | ( | long | position | ) |

Returns the position in the file of the next MPEG frame, using the current position as start

## ◆ previousFrameOffset()

long TagLib::MPEG::File::previousFrameOffset | ( | long | position | ) |

Returns the position in the file of the previous MPEG frame, using the current position as start

## ◆ properties()

PropertyMap TagLib::MPEG::File::properties | ( |  | ) | const

Implements the reading part of the unified property interface. If the file contains more than one tag, only the first one (in the order ID3v2, APE, ID3v1) will be converted to the PropertyMap.

## ◆ removeUnsupportedProperties()

void TagLib::MPEG::File::removeUnsupportedProperties | ( | const StringList & | properties | ) |

## ◆ save() [1/6]

virtual bool TagLib::MPEG::File::save | ( |  | ) |
| virtual

Save the file. If at least one tag – ID3v1 or ID3v2 – exists this will duplicate its content into the other tag. This returns true if saving was successful.

If neither exists or if both tags are empty, this will strip the tags from the file.

This is the same as calling save(AllTags);

If you would like more granular control over the content of the tags, with the concession of generality, use parameterized save call below.

See also
  save(int tags)

Implements TagLib::File.

## ◆ save() [2/6]

bool TagLib::MPEG::File::save | ( | int | tags | ) |

Save the file. This will attempt to save all of the tag types that are specified by OR-ing together TagTypes values. The save() method above uses AllTags. This returns true if saving was successful.

This strips all tags not included in the mask, but does not modify them in memory, so later calls to save() which make use of these tags will remain valid. This also strips empty tags.

## ◆ save() [3/6]

TAGLIB_DEPRECATED bool TagLib::MPEG::File::save | ( | int | tags,
|  | bool | stripOthers
| ) |  |

Deprecated:
  Use save(int, StripTags, ID3v2::Version, DuplicateTags).

## ◆ save() [4/6]

TAGLIB_DEPRECATED bool TagLib::MPEG::File::save | ( | int | tags,
|  | bool | stripOthers,
|  | int | id3v2Version
| ) |  |

Deprecated:
  Use save(int, StripTags, ID3v2::Version, DuplicateTags).

## ◆ save() [5/6]

TAGLIB_DEPRECATED bool TagLib::MPEG::File::save | ( | int | tags,
|  | bool | stripOthers,
|  | int | id3v2Version,
|  | bool | duplicateTags
| ) |  |

Deprecated:
  Use save(int, StripTags, ID3v2::Version, DuplicateTags).

## ◆ save() [6/6]

bool TagLib::MPEG::File::save | ( | int | tags,
|  | StripTags | strip,
|  | ID3v2::Version | version = `ID3v2::v4`,
|  | DuplicateTags | duplicate = `Duplicate`
| ) |  |

Save the file. This will attempt to save all of the tag types that are specified by OR-ing together TagTypes values.

strip can be set to strip all tags except those in tags. Those tags will not be modified in memory, and thus remain valid.

version specifies the ID3v2 version to be used for writing tags. By default, the latest standard, ID3v2.4 is used.

If duplicate is set to DuplicateTags and at least one tag – ID3v1 or ID3v2 – exists this will duplicate its content into the other tag.

## ◆ setID3v2FrameFactory()

TAGLIB_DEPRECATED void TagLib::MPEG::File::setID3v2FrameFactory | ( | const ID3v2::FrameFactory * | factory | ) |

Set the ID3v2::FrameFactory to something other than the default.

See also
  ID3v2FrameFactory

Deprecated:
  This value should be passed in via the constructor.

## ◆ setProperties()

PropertyMap TagLib::MPEG::File::setProperties | ( | const PropertyMap & |  | ) |

Implements the writing part of the unified tag dictionary interface. In order to avoid problems with deprecated tag formats, this method always creates an ID3v2 tag if necessary. If an ID3v1 tag exists, it will be updated as well, within the limitations of that format. The returned PropertyMap refers to the ID3v2 tag only.

## ◆ strip() [1/2]

bool TagLib::MPEG::File::strip | ( | int | tags,
|  | bool | freeMemory
| ) |  |

This will strip the tags that match the OR-ed together TagTypes from the file. By default it strips all tags. It returns true if the tags are successfully stripped.

If freeMemory is true the ID3 and APE tags will be deleted and pointers to them will be invalidated.

Note
  This will update the file immediately.

## ◆ strip() [2/2]

bool TagLib::MPEG::File::strip | ( | int | tags = `AllTags` | ) |

This will strip the tags that match the OR-ed together TagTypes from the file. By default it strips all tags. It returns true if the tags are successfully stripped.

This is equivalent to strip(tags, true)

Note
  This will also invalidate pointers to the ID3 and APE tags as their memory will be freed.
  This will update the file immediately.

## ◆ tag()

virtual Tag * TagLib::MPEG::File::tag | ( |  | ) | const
| virtual

Returns a pointer to a tag that is the union of the ID3v2 and ID3v1 tags. The ID3v2 tag is given priority in reading the information – if requested information exists in both the ID3v2 tag and the ID3v1 tag, the information from the ID3v2 tag will be returned.

If you would like more granular control over the content of the tags, with the concession of generality, use the tag-type specific calls.

Note
  As this tag is not implemented as an ID3v2 tag or an ID3v1 tag, but a union of the two this pointer may not be cast to the specific tag types.

See also
  ID3v1Tag()
  ID3v2Tag()
  APETag()

Implements TagLib::File.

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

- mpegfile.h