An implementation of TagLib::File with APE specific methods.
More...
#include <apefile.h>
Public Member Functions |
| | File (FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average) |
| virtual | ~File () |
| virtual TagLib::Tag * | tag () const |
| virtual Properties * | audioProperties () const |
| virtual bool | save () |
| ID3v1::Tag * | ID3v1Tag (bool create=false) |
| APE::Tag * | APETag (bool create=false) |
| void | strip (int tags=AllTags) |
| FileName | name () const |
| ByteVector | readBlock (ulong length) |
| void | writeBlock (const ByteVector &data) |
| long | find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector::null) |
| long | rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector::null) |
| void | insert (const ByteVector &data, ulong start=0, ulong replace=0) |
| void | removeBlock (ulong start=0, ulong 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 () |
Detailed Description
An implementation of TagLib::File with APE specific methods.
This implements and provides an interface APE WavPack files to the TagLib::Tag and TagLib::AudioProperties interfaces by way of implementing the abstract TagLib::File API as well as providing some additional information specific to APE files.
Member Enumeration Documentation
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.
|
| APE |
Matches APE tags.
|
| AllTags |
Matches all tag types.
|
Constructor & Destructor Documentation
Contructs an WavPack file from file. If readProperties is true the file's audio properties will also be read using propertiesStyle. If false, propertiesStyle is ignored.
| virtual TagLib::APE::File::~File |
( |
| ) |
|
|
virtual |
Member Function Documentation
| APE::Tag* TagLib::APE::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 a APE tag if one does not exist.
- Note
- The Tag is still owned by the APE::File and should not be deleted by the user. It will be deleted when the file (object) is destroyed.
| virtual Properties* TagLib::APE::File::audioProperties |
( |
| ) |
const |
|
virtual |
Returns the APE::Properties for this file. If no audio properties were read then this will return a null pointer.
Implements TagLib::File.
| ID3v1::Tag* TagLib::APE::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. If there is already an APE tag, the new ID3v1 tag will be placed after it.
- Note
- The Tag is still owned by the APE::File and should not be deleted by the user. It will be deleted when the file (object) is destroyed.
| virtual bool TagLib::APE::File::save |
( |
| ) |
|
|
virtual |
Saves the file.
- Note
- According to the official Monkey's Audio SDK, an APE file can only have either ID3V1 or APE tags, so a parameter is used here.
Implements TagLib::File.
| void TagLib::APE::File::strip |
( |
int |
tags = AllTags | ) |
|
This will remove the tags that match the OR-ed together TagTypes from the file. By default it removes all tags.
- Note
- This will also invalidate pointers to the tags as their memory will be freed.
-
In order to make the removal permanent save() still needs to be called
Returns the Tag for this file. This will be an APE tag, an ID3v1 tag or a combination of the two.
Implements TagLib::File.
The documentation for this class was generated from the following file:
Public Types inherited from TagLib::File