TagLib::APE::File Class Reference

An implementation of TagLib::File with APE specific methods. More...

#include <apefile.h>

Inheritance diagram for TagLib::APE::File:
Collaboration diagram for TagLib::APE::File:

Public Types

enum  TagTypes { NoTags = 0x0000, ID3v1 = 0x0001, APE = 0x0002, AllTags = 0xffff }
 
- Public Types inherited from TagLib::File
enum  Position { Beginning, Current, End }
 

Public Member Functions

 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::Tagtag () const
 
PropertyMap properties () const
 
void removeUnsupportedProperties (const StringList &properties)
 
PropertyMap setProperties (const PropertyMap &)
 
virtual PropertiesaudioProperties () const
 
virtual bool save ()
 
ID3v1::TagID3v1Tag (bool create=false)
 
APE::TagAPETag (bool create=false)
 
void strip (int tags=AllTags)
 
- Public Member Functions inherited from TagLib::File
FileName name () const
 
PropertyMap properties () const
 
void removeUnsupportedProperties (const StringList &properties)
 
PropertyMap setProperties (const PropertyMap &properties)
 
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 ()
 

Additional Inherited Members

- Static Public Member Functions inherited from TagLib::File
static bool isReadable (const char *file)
 
static bool isWritable (const char *name)
 
- Protected Member Functions inherited from TagLib::File
 File (FileName file)
 
 File (IOStream *stream)
 
void setValid (bool valid)
 
void truncate (long length)
 
- Static Protected Member Functions inherited from TagLib::File
static uint bufferSize ()
 

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

TagLib::APE::File::File ( FileName  file,
bool  readProperties = true,
Properties::ReadStyle  propertiesStyle = Properties::Average 
)

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.

TagLib::APE::File::File ( IOStream stream,
bool  readProperties = true,
Properties::ReadStyle  propertiesStyle = Properties::Average 
)

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.

Note
TagLib will not take ownership of the stream, the caller is responsible for deleting it after the File object.
virtual TagLib::APE::File::~File ( )
virtual

Destroys this instance of the File.

Reimplemented from TagLib::File.

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.
PropertyMap TagLib::APE::File::properties ( ) const

Implements the unified property interface – export function. If the file contains both an APE and an ID3v1 tag, only APE will be converted to the PropertyMap.

void TagLib::APE::File::removeUnsupportedProperties ( const StringList properties)

Removes unsupported properties. Forwards to the actual Tag's removeUnsupportedProperties() function.

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.

PropertyMap TagLib::APE::File::setProperties ( const PropertyMap )

Implements the unified property interface – import function. As for the export, only one tag is taken into account. If the file has no tag at all, APE will be created.

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
virtual TagLib::Tag* TagLib::APE::File::tag ( ) const
virtual

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: