TagLib::FLAC::File Class Reference

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

#include <flacfile.h>

Inheritance diagram for TagLib::FLAC::File:

[legend]

Collaboration diagram for TagLib::FLAC::File:

[legend]

List of all members.

Public Member Functions
	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)
virtual	~File ()
virtual TagLib::Tag *	tag () const
virtual Properties *	audioProperties () const
virtual bool	save ()
ID3v2::Tag *	ID3v2Tag (bool create=false)
ID3v1::Tag *	ID3v1Tag (bool create=false)
Ogg::XiphComment *	xiphComment (bool create=false)
void	setID3v2FrameFactory (const ID3v2::FrameFactory *factory)
ByteVector	streamInfoData ()
long	streamLength ()

---

Detailed Description

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

This implements and provides an interface for FLAC 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 FLAC files.

---

Constructor & Destructor Documentation

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

Contructs a FLAC file from file. If readProperties is true the file's audio properties will also be read using propertiesStyle. If false, propertiesStyle is ignored.

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

Contructs a FLAC file from file. If readProperties is true the file's audio properties will also be read using propertiesStyle. If false, propertiesStyle is ignored.

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

virtual TagLib::FLAC::File::~File

(

)

[virtual]

Destroys this instance of the File.

Reimplemented from TagLib::File.

---

Member Function Documentation

virtual Properties* TagLib::FLAC::File::audioProperties

(

)

const [virtual]

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

Implements TagLib::File.

ID3v1::Tag* TagLib::FLAC::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.

Note:

The Tag is still owned by the FLAC::File and should not be deleted by the user. It will be deleted when the file (object) is destroyed.

ID3v2::Tag* TagLib::FLAC::File::ID3v2Tag

(

bool

create = false

)

Returns a pointer to the ID3v2 tag of the file.

If create is false (the default) this will 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.

Note:

The Tag is still owned by the FLAC::File and should not be deleted by the user. It will be deleted when the file (object) is destroyed.

virtual bool TagLib::FLAC::File::save

(

)

[virtual]

Save the file. This will primarily save the XiphComment, but will also keep any old ID3-tags up to date. If the file has no XiphComment, one will be constructed from the ID3-tags.

This returns true if the save was successful.

Implements TagLib::File.

void TagLib::FLAC::File::setID3v2FrameFactory

(

const ID3v2::FrameFactory *

factory

)

Set the ID3v2::FrameFactory to something other than the default. This can be used to specify the way that ID3v2 frames will be interpreted when

See also:

ID3v2FrameFactory

ByteVector TagLib::FLAC::File::streamInfoData

(

)

Returns the block of data used by FLAC::Properties for parsing the stream properties.

long TagLib::FLAC::File::streamLength

(

)

Returns the length of the audio-stream, used by FLAC::Properties for calculating the bitrate.

virtual TagLib::Tag* TagLib::FLAC::File::tag

(

)

const [virtual]

Returns the Tag for this file. This will be a union of XiphComment, ID3v1 and ID3v2 tags.

See also:

ID3v2Tag()

ID3v1Tag()

XiphComment()

Implements TagLib::File.

Ogg::XiphComment* TagLib::FLAC::File::xiphComment

(

bool

create = false

)

Returns a pointer to the XiphComment for the file.

If create is false (the default) this will return a null pointer if there is no valid XiphComment. If create is true it will create a XiphComment if one does not exist.

Note:

The Tag is still owned by the FLAC::File and should not be deleted by the user. It will be deleted when the file (object) is destroyed.

---

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

• flacfile.h