An implementation of TagLib::File with TrueAudio specific methods.
More...
#include <trueaudiofile.h>
|
| 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, 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 TagLib::Tag * | tag () const |
|
PropertyMap | properties () const |
|
PropertyMap | setProperties (const PropertyMap &) |
|
void | removeUnsupportedProperties (const StringList &properties) |
|
virtual Properties * | audioProperties () const |
|
TAGLIB_DEPRECATED void | setID3v2FrameFactory (const ID3v2::FrameFactory *factory) |
|
virtual bool | save () |
|
ID3v1::Tag * | ID3v1Tag (bool create=false) |
|
ID3v2::Tag * | ID3v2Tag (bool create=false) |
|
void | strip (int tags=AllTags) |
|
bool | hasID3v1Tag () const |
|
bool | hasID3v2Tag () const |
|
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 () |
|
An implementation of TagLib::File with TrueAudio specific methods.
This implements and provides an interface for TrueAudio 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 TrueAudio files.
◆ 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.
|
AllTags | Matches all tag types.
|
◆ File() [1/4]
Constructs a TrueAudio 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/4]
Constructs a TrueAudio 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/4]
Constructs a TrueAudio 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() [4/4]
Constructs a TrueAudio 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::TrueAudio::File::~File |
( |
| ) |
|
|
virtual |
◆ audioProperties()
virtual Properties * TagLib::TrueAudio::File::audioProperties |
( |
| ) |
const |
|
virtual |
◆ hasID3v1Tag()
bool TagLib::TrueAudio::File::hasID3v1Tag |
( |
| ) |
const |
Returns whether or not the file on disk actually has an ID3v1 tag.
- See also
- ID3v1Tag()
◆ hasID3v2Tag()
bool TagLib::TrueAudio::File::hasID3v2Tag |
( |
| ) |
const |
Returns whether or not the file on disk actually has an ID3v2 tag.
- See also
- ID3v2Tag()
◆ ID3v1Tag()
ID3v1::Tag * TagLib::TrueAudio::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::TrueAudio::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::TrueAudio::File::isSupported |
( |
IOStream * |
stream | ) |
|
|
static |
Returns whether or not the given stream can be opened as a TrueAudio file.
- Note
- This method is designed to do a quick check. The result may not necessarily be correct.
◆ properties()
PropertyMap TagLib::TrueAudio::File::properties |
( |
| ) |
const |
Implements the unified property interface – export function. If the file contains both ID3v1 and v2 tags, only ID3v2 will be converted to the PropertyMap.
◆ removeUnsupportedProperties()
void TagLib::TrueAudio::File::removeUnsupportedProperties |
( |
const StringList & |
properties | ) |
|
◆ save()
virtual bool TagLib::TrueAudio::File::save |
( |
| ) |
|
|
virtual |
◆ setID3v2FrameFactory()
Set the ID3v2::FrameFactory to something other than the default.
- See also
- ID3v2FrameFactory
- Deprecated:
- This value should be passed in via the constructor.
◆ setProperties()
Implements the unified property interface – import function. Creates in ID3v2 tag if necessary. If an ID3v1 tag exists, it will be updated as well, within the limitations of ID3v1.
◆ strip()
void TagLib::TrueAudio::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
◆ tag()
virtual TagLib::Tag * TagLib::TrueAudio::File::tag |
( |
| ) |
const |
|
virtual |
The documentation for this class was generated from the following file: