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 }

enum	StripTags { StripNone , StripOthers }

enum	DuplicateTags { Duplicate , DoNotDuplicate }

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)

	~File () override

	File (const File &)=delete

File &	operator= (const File &)=delete

TagLib::Tag *	tag () const override

PropertyMap	properties () const override

void	removeUnsupportedProperties (const StringList &properties) override

PropertyMap	setProperties (const PropertyMap &) override

Properties *	audioProperties () const override

bool	save () override

ID3v1::Tag *	ID3v1Tag (bool create=false)

APE::Tag *	APETag (bool create=false)

void	strip (int tags=AllTags)

bool	hasAPETag () const

bool	hasID3v1Tag () const

Public Member Functions inherited from TagLib::File
virtual	~File ()

	File (const File &)=delete

File &	operator= (const File &)=delete

FileName	name () const

virtual Tag *	tag () const =0

virtual PropertyMap	properties () const

virtual void	removeUnsupportedProperties (const StringList &properties)

virtual PropertyMap	setProperties (const PropertyMap &properties)

virtual StringList	complexPropertyKeys () const

virtual List< VariantMap >	complexProperties (const String &key) const

virtual bool	setComplexProperties (const String &key, const List< VariantMap > &value)

virtual AudioProperties *	audioProperties () const =0

virtual bool	save ()=0

ByteVector	readBlock (size_t length)

void	writeBlock (const ByteVector &data)

offset_t	find (const ByteVector &pattern, offset_t fromOffset=0, const ByteVector &before=ByteVector())

offset_t	rfind (const ByteVector &pattern, offset_t fromOffset=0, const ByteVector &before=ByteVector())

void	insert (const ByteVector &data, offset_t start=0, size_t replace=0)

void	removeBlock (offset_t start=0, size_t length=0)

bool	readOnly () const

bool	isOpen () const

bool	isValid () const

void	seek (offset_t offset, Position p=Beginning)

void	clear ()

offset_t	tell () const

offset_t	length ()

Static Public Member Functions
static bool	isSupported (IOStream *stream)

Additional Inherited Members
Protected Member Functions inherited from TagLib::File
	File (FileName fileName)

	File (IOStream *stream)

void	setValid (bool valid)

void	truncate (offset_t length)

Static Protected Member Functions inherited from TagLib::File
static unsigned int	bufferSize ()

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

◆ TagTypes

enum TagLib::APE::File::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.
APE	Matches APE tags.
AllTags	Matches all tag types.

Constructor & Destructor Documentation

◆ File() [1/3]

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.

◆ File() [2/3]

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.

◆ ~File()

TagLib::APE::File::~File ( )

overridevirtual

Destroys this instance of the File.

Reimplemented from TagLib::File.

◆ File() [3/3]

TagLib::APE::File::File ( const File & )

delete

Member Function Documentation

◆ APETag()

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 APE::File and should not be deleted by the user. It will be deleted when the file (object) is destroyed.

See also: hasAPETag()

◆ audioProperties()

Properties * TagLib::APE::File::audioProperties ( ) const

overridevirtual

Returns the APE::Properties for this file. If no audio properties were read then this will return a null pointer.

Implements TagLib::File.

◆ hasAPETag()

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

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

See also: APETag()

◆ hasID3v1Tag()

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

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

See also: ID3v1Tag()

◆ 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 APE::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::APE::File::isSupported ( IOStream * stream )

static

Returns whether or not the given stream can be opened as an APE file.

Note: This method is designed to do a quick check. The result may not necessarily be correct.

◆ operator=()

File & TagLib::APE::File::operator= ( const File & )

delete

◆ properties()

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

overridevirtual

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.

◆ removeUnsupportedProperties()

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

overridevirtual

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

Reimplemented from TagLib::File.

◆ save()

bool TagLib::APE::File::save ( )

overridevirtual

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.

◆ setProperties()

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

overridevirtual

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.

◆ strip()

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

◆ tag()

TagLib::Tag * TagLib::APE::File::tag ( ) const

overridevirtual

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:

apefile.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TagTypes

Constructor & Destructor Documentation

◆ File() [1/3]

◆ File() [2/3]

◆ ~File()

◆ File() [3/3]

Member Function Documentation

◆ APETag()

◆ audioProperties()

◆ hasAPETag()

◆ hasID3v1Tag()

◆ ID3v1Tag()

◆ isSupported()

◆ operator=()

◆ properties()

◆ removeUnsupportedProperties()

◆ save()

◆ setProperties()

◆ strip()

◆ tag()