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:

Public Types | |
enum | TagTypes { NoTags = 0x0000, ID3v1 = 0x0001, ID3v2 = 0x0002, AllTags = 0xffff } |
Public Member Functions | |
File (const char *file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average) | |
virtual | ~File () |
virtual Tag * | tag () const |
virtual Properties * | audioProperties () const |
virtual void | save () |
void | save (int tags) |
ID3v2::Tag * | ID3v2Tag (bool create=false) |
ID3v1::Tag * | ID3v1Tag (bool create=false) |
void | strip (int tags=AllTags) |
void | setID3v2FrameFactory (const ID3v2::FrameFactory *factory) |
long | firstFrameOffset () |
long | nextFrameOffset (long position) |
long | previousFrameOffset (long position) |
long | lastFrameOffset () |
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.
Definition at line 46 of file mpegfile.h.
Member Enumeration Documentation
|
This set of flags is used for various operations and is suitable for being OR-ed together.
Definition at line 53 of file mpegfile.h. |
Constructor & Destructor Documentation
|
Contructs an MPEG file from file. If readProperties is true the file's audio properties will also be read using propertiesStyle. If false, propertiesStyle is ignored. |
|
Destroys this instance of the File. Reimplemented from TagLib::File. |
Member Function Documentation
|
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.
Implements TagLib::File. |
|
Returns the MPEG::Properties for this file. If no audio properties were read then this will return a null pointer. Implements TagLib::File. |
|
Save the file. If at least one tag -- ID3v1 or ID3v2 -- exists this will duplicate its content into the other tag. 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 paramaterized save call below.
Implements TagLib::File. |
|
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 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. |
|
Returns a pointer to the ID3v2 tag of the file. This method will return a null pointer if either the file can not be read from. If create is false (the default) it will also 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.
|
|
Returns a pointer to the ID3v1 tag of the file. This method will return a null pointer if either the file can not be read from. If create is false (the default) it will also 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.
|
|
This will strip the tags that match the OR-ed together TagTypes from the file. By default it strips all tags. |
|
Set the ID3v2::FrameFactory to something other than the default.
|
|
Returns the position in the file of the first MPEG frame. |
|
Returns the position in the file of the next MPEG frame, using the current position as start |
|
Returns the position in the file of the previous MPEG frame, using the current position as start |
|
Returns the position in the file of the last MPEG frame. |
The documentation for this class was generated from the following file: