TagLib 1.10 (TagLib: TagLib::APE::File Class Reference)

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:

List of all members.

Public Types

enum  TagTypes { NoTags = 0x0000, ID3v1 = 0x0001, APE = 0x0002, AllTags = 0xffff }

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)
bool hasAPETag () const
bool hasID3v1Tag () const

Detailed Description

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

This implements and provides an interface for APE 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 
)

Constructs an APE file from file. If readProperties is true the file's audio properties will also be read.

Note:
In the current implementation, propertiesStyle is ignored.
TagLib::APE::File::File ( IOStream stream,
bool  readProperties = true,
Properties::ReadStyle  propertiesStyle = Properties::Average 
)

Constructs an APE 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.
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 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.

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()
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.

bool TagLib::APE::File::hasAPETag ( ) const

Returns whether or not the file on disk actually has an APE tag.

See also:
APETag()
bool TagLib::APE::File::hasID3v1Tag ( ) const

Returns whether or not the file on disk actually has an ID3v1 tag.

See also:
ID3v1Tag()
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 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()
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.

Reimplemented from TagLib::File.

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

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

Reimplemented from TagLib::File.

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.
Warning:
In the current implementation, it's dangerous to call save() repeatedly. At worst it will corrupt the file.

Implements TagLib::File.

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

Implements the unified property interface -- import function. Creates an APEv2 tag if necessary. A potentially existing ID3v1 tag will be updated as well.

Reimplemented from 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
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: