TagLib::TrueAudio::File Class Reference

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

#include <trueaudiofile.h>

Inheritance diagram for TagLib::TrueAudio::File:

Collaboration diagram for TagLib::TrueAudio::File:

Public Types
enum	TagTypes { NoTags = 0x0000 , ID3v1 = 0x0001 , ID3v2 = 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, ID3v2::FrameFactory *frameFactory=nullptr)
TAGLIB_DEPRECATED	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, ID3v2::FrameFactory *frameFactory=nullptr)
TAGLIB_DEPRECATED	File (IOStream *stream, ID3v2::FrameFactory *frameFactory, 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
PropertyMap	setProperties (const PropertyMap &) override
void	removeUnsupportedProperties (const StringList &unsupported) override
Properties *	audioProperties () const override
bool	save () override
ID3v1::Tag *	ID3v1Tag (bool create=false)
ID3v2::Tag *	ID3v2Tag (bool create=false)
void	strip (int tags=AllTags)
bool	hasID3v1Tag () const
bool	hasID3v2Tag () const
Public Member Functions inherited from TagLib::File
	File (const File &)=delete
File &	operator= (const File &)=delete
FileName	name () const
virtual StringList	complexPropertyKeys () const
virtual List< VariantMap >	complexProperties (const String &key) const
virtual bool	setComplexProperties (const String &key, const List< VariantMap > &value)
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 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.

Member Enumeration Documentation

TagTypes

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

Constructor & Destructor Documentation

File() [1/5]

TagLib::TrueAudio::File::File	(	FileName	file,
		bool	readProperties = true,
		Properties::ReadStyle	propertiesStyle = Properties::Average,
		ID3v2::FrameFactory *	frameFactory = nullptr
	)

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

If this file contains an ID3v2 tag, the frames will be created using frameFactory (default if null).

Note

In the current implementation, propertiesStyle is ignored.

File() [2/5]

TAGLIB_DEPRECATED TagLib::TrueAudio::File::File	(	FileName	file,
		ID3v2::FrameFactory *	frameFactory,
		bool	readProperties = true,
		Properties::ReadStyle	propertiesStyle = Properties::Average
	)

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

If this file contains an ID3v2 tag, the frames will be created using frameFactory.

Note

In the current implementation, propertiesStyle is ignored.

Deprecated:

Use the constructor above.

File() [3/5]

TagLib::TrueAudio::File::File	(	IOStream *	stream,
		bool	readProperties = true,
		Properties::ReadStyle	propertiesStyle = Properties::Average,
		ID3v2::FrameFactory *	frameFactory = nullptr
	)

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 an ID3v2 tag, the frames will be created using frameFactory.

Note

In the current implementation, propertiesStyle is ignored.

File() [4/5]

TAGLIB_DEPRECATED TagLib::TrueAudio::File::File	(	IOStream *	stream,
		ID3v2::FrameFactory *	frameFactory,
		bool	readProperties = true,
		Properties::ReadStyle	propertiesStyle = Properties::Average
	)

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 an ID3v2 tag, the frames will be created using frameFactory.

Note

In the current implementation, propertiesStyle is ignored.

Deprecated:

Use the constructor above.

~File()

TagLib::TrueAudio::File::~File ( )

overridevirtual

Destroys this instance of the File.

Reimplemented from TagLib::File.

File() [5/5]

TagLib::TrueAudio::File::File ( const File &  )

delete

Member Function Documentation

audioProperties()

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

overridevirtual

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

Implements TagLib::File.

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 TrueAudio::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 TrueAudio::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.

operator=()

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

delete

properties()

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

overridevirtual

Implements the unified property interface – export function. If the file contains both ID3v1 and v2 tags, only ID3v2 will be converted to the PropertyMap.

Reimplemented from TagLib::File.

removeUnsupportedProperties()

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

overridevirtual

Removes unsupported properties, or a subset of them, from the file's metadata. The parameter properties must contain only entries from properties().unsupportedData().

Reimplemented from TagLib::File.

save()

bool TagLib::TrueAudio::File::save ( )

overridevirtual

Saves the file.

Implements TagLib::File.

setProperties()

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

overridevirtual

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.

Reimplemented from TagLib::File.

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

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

overridevirtual

Returns the Tag for this file.

Implements TagLib::File.

---

The documentation for this class was generated from the following file:

• trueaudiofile.h