![]() |
|
#include <mpegfile.h>
Public Types | |
enum | TagTypes { NoTags = 0x0000, ID3v1 = 0x0001, ID3v2 = 0x0002, APE = 0x0004, AllTags = 0xffff } |
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) | |
virtual | ~File () |
virtual Tag * | tag () const |
virtual Properties * | audioProperties () const |
virtual bool | save () |
bool | save (int tags) |
bool | save (int tags, bool stripOthers) |
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) |
void | setID3v2FrameFactory (const ID3v2::FrameFactory *factory) |
long | firstFrameOffset () |
long | nextFrameOffset (long position) |
long | previousFrameOffset (long position) |
long | lastFrameOffset () |
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.
TagLib::MPEG::File::File | ( | FileName | file, | |
bool | readProperties = true , |
|||
Properties::ReadStyle | propertiesStyle = Properties::Average | |||
) |
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.
TagLib::MPEG::File::File | ( | FileName | file, | |
ID3v2::FrameFactory * | frameFactory, | |||
bool | readProperties = true , |
|||
Properties::ReadStyle | propertiesStyle = Properties::Average | |||
) |
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. The frames will be created using frameFactory.
virtual TagLib::MPEG::File::~File | ( | ) | [virtual] |
Destroys this instance of the File.
Reimplemented from TagLib::File.
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 will 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.
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.
long TagLib::MPEG::File::firstFrameOffset | ( | ) |
Returns the position in the file of the first MPEG frame.
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 will 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.
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 will 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.
long TagLib::MPEG::File::lastFrameOffset | ( | ) |
Returns the position in the file of the last MPEG frame.
long TagLib::MPEG::File::nextFrameOffset | ( | long | position | ) |
Returns the position in the file of the next MPEG frame, using the current position as start
long TagLib::MPEG::File::previousFrameOffset | ( | long | position | ) |
Returns the position in the file of the previous MPEG frame, using the current position as start
bool TagLib::MPEG::File::save | ( | int | tags, | |
bool | stripOthers | |||
) |
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.
If stripOthers is true 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.
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.
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 paramaterized save call below.
Implements TagLib::File.
void TagLib::MPEG::File::setID3v2FrameFactory | ( | const ID3v2::FrameFactory * | factory | ) |
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.
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)
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.
Implements TagLib::File.