An implementation of TagLib::File with MPC specific methods.
More...
#include <mpcfile.h>
|
| File (FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average) |
|
| File (IOStream *stream, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average) |
|
virtual | ~File () |
|
virtual TagLib::Tag * | tag () const |
|
PropertyMap | properties () const |
|
void | removeUnsupportedProperties (const StringList &properties) |
|
PropertyMap | setProperties (const PropertyMap &) |
|
virtual Properties * | audioProperties () const |
|
virtual bool | save () |
|
ID3v1::Tag * | ID3v1Tag (bool create=false) |
|
APE::Tag * | APETag (bool create=false) |
|
void | strip (int tags=AllTags) |
|
TAGLIB_DEPRECATED void | remove (int tags=AllTags) |
|
bool | hasID3v1Tag () const |
|
bool | hasAPETag () const |
|
FileName | name () const |
|
PropertyMap | properties () const |
|
void | removeUnsupportedProperties (const StringList &properties) |
|
PropertyMap | setProperties (const PropertyMap &properties) |
|
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 () |
|
An implementation of TagLib::File with MPC specific methods.
This implements and provides an interface for MPC 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 MPC files. The only invalid tag combination supported is an ID3v1 tag after an APE tag.
◆ 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.
|
◆ File() [1/2]
Constructs an MPC file from file. If readProperties is true the file's audio properties will also be read.
- Note
- In the current implementation, propertiesStyle is ignored.
◆ File() [2/2]
Constructs an MPC 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.
-
In the current implementation, propertiesStyle is ignored.
◆ ~File()
virtual TagLib::MPC::File::~File |
( |
| ) |
|
|
virtual |
◆ APETag()
APE::Tag* TagLib::MPC::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. If there already be an ID3v1 tag, the new APE tag will be placed before it.
- 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::MPC::File::audioProperties |
( |
| ) |
const |
|
virtual |
Returns the MPC::Properties for this file. If no audio properties were read then this will return a null pointer.
Implements TagLib::File.
◆ hasAPETag()
bool TagLib::MPC::File::hasAPETag |
( |
| ) |
const |
Returns whether or not the file on disk actually has an APE tag.
- See also
- APETag()
◆ hasID3v1Tag()
bool TagLib::MPC::File::hasID3v1Tag |
( |
| ) |
const |
Returns whether or not the file on disk actually has an ID3v1 tag.
- See also
- ID3v1Tag()
◆ ID3v1Tag()
ID3v1::Tag* TagLib::MPC::File::ID3v1Tag |
( |
bool |
create = false | ) |
|
Returns a pointer to the ID3v1 tag of the file.
If create is false (the default) this returns 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 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()
◆ isSupported()
static bool TagLib::MPC::File::isSupported |
( |
IOStream * |
stream | ) |
|
|
static |
Returns whether or not the given stream can be opened as an MPC file.
- Note
- This method is designed to do a quick check. The result may not necessarily be correct.
◆ properties()
Implements the unified property interface – export function. If the file contains both an APE and an ID3v1 tag, only the APE tag will be converted to the PropertyMap.
◆ remove()
◆ removeUnsupportedProperties()
void TagLib::MPC::File::removeUnsupportedProperties |
( |
const StringList & |
properties | ) |
|
◆ save()
virtual bool TagLib::MPC::File::save |
( |
| ) |
|
|
virtual |
Saves the file.
This returns true if the save was successful.
Implements TagLib::File.
◆ setProperties()
Implements the unified property interface – import function. Affects only the APEv2 tag which will be created if necessary. If an ID3v1 tag exists, it will be updated as well.
◆ strip()
void TagLib::MPC::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.
- Warning
- This will also invalidate pointers to the tags as their memory will be freed.
- Note
- In order to make the removal permanent save() still needs to be called.
◆ tag()
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: