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

#include <oggflacfile.h>

Inheritance diagram for TagLib::Ogg::FLAC::File:

Public Member Functions
	File (FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
	Constructs an Ogg/FLAC file from file. More...

	File (IOStream *stream, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
	Constructs an Ogg/FLAC file from stream. More...

virtual	~File ()
	Destroys this instance of the File. More...

virtual XiphComment *	tag () const
	Returns the Tag for this file. More...

virtual Properties *	audioProperties () const
	Returns the FLAC::Properties for this file. More...

PropertyMap	properties () const
	Implements the unified property interface – export function. More...

PropertyMap	setProperties (const PropertyMap &)
	Implements the unified tag dictionary interface – import function. More...

virtual bool	save ()
	Save the file. More...

long	streamLength ()
	Returns the length of the audio-stream, used by FLAC::Properties for calculating the bitrate. More...

bool	hasXiphComment () const
	Returns whether or not the file on disk actually has a XiphComment. More...

Public Member Functions inherited from TagLib::Ogg::File
ByteVector	packet (unsigned int i)
	Returns the packet contents for the i-th packet (starting from zero) in the Ogg bitstream. More...

void	setPacket (unsigned int i, const ByteVector &p)
	Sets the packet with index i to the value p. More...

const PageHeader *	firstPageHeader ()
	Returns a pointer to the PageHeader for the first page in the stream or null if the page could not be found. More...

const PageHeader *	lastPageHeader ()
	Returns a pointer to the PageHeader for the last page in the stream or null if the page could not be found. More...

Public Member Functions inherited from TagLib::File
FileName	name () const
	Returns the file name in the local file system encoding. More...

PropertyMap	properties () const
	Exports the tags of the file as dictionary mapping (human readable) tag names (uppercase Strings) to StringLists of tag values. More...

void	removeUnsupportedProperties (const StringList &properties)
	Removes unsupported properties, or a subset of them, from the file's metadata. More...

PropertyMap	setProperties (const PropertyMap &properties)
	Sets the tags of this File to those specified in properties. More...

ByteVector	readBlock (unsigned long length)
	Reads a block of size length at the current get pointer. More...

void	writeBlock (const ByteVector &data)
	Attempts to write the block data at the current get pointer. More...

long	find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
	Returns the offset in the file that pattern occurs at or -1 if it can not be found. More...

long	rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
	Returns the offset in the file that pattern occurs at or -1 if it can not be found. More...

void	insert (const ByteVector &data, unsigned long start=0, unsigned long replace=0)
	Insert data at position start in the file overwriting replace bytes of the original content. More...

void	removeBlock (unsigned long start=0, unsigned long length=0)
	Removes a block of the file starting a start and continuing for length bytes. More...

bool	readOnly () const
	Returns true if the file is read only (or if the file can not be opened). More...

bool	isOpen () const
	Since the file can currently only be opened as an argument to the constructor (sort-of by design), this returns if that open succeeded. More...

bool	isValid () const
	Returns true if the file is open and readable. More...

void	seek (long offset, Position p=Beginning)
	Move the I/O pointer to offset in the file from position p. More...

void	clear ()
	Reset the end-of-file and error flags on the file. More...

long	tell () const
	Returns the current offset within the file. More...

long	length ()
	Returns the length of the file. More...

Additional Inherited Members
Public Types inherited from TagLib::File
enum	Position { Beginning, Current, End }
	Position in the file used for seeking. More...

Static Public Member Functions inherited from TagLib::File
static bool	isReadable (const char *file)
	Returns true if file can be opened for reading. More...

static bool	isWritable (const char *name)
	Returns true if file can be opened for writing. More...

Protected Member Functions inherited from TagLib::Ogg::File
	File (FileName file)
	Constructs an Ogg file from file. More...

	File (IOStream *stream)
	Constructs an Ogg file from stream. More...

Protected Member Functions inherited from TagLib::File
	File (FileName file)
	Construct a File object and opens the file. More...

	File (IOStream *stream)
	Construct a File object and use the stream instance. More...

void	setValid (bool valid)
	Marks the file as valid or invalid. More...

void	truncate (long length)
	Truncates the file to a length. More...

Static Protected Member Functions inherited from TagLib::File
static unsigned int	bufferSize ()
	Returns the buffer size that is used for internal buffering. More...

Detailed Description

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

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

Constructor & Destructor Documentation

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

Constructs an Ogg/FLAC 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::Ogg::FLAC::File::File	(	IOStream *	stream,
		bool	readProperties = `true`,
		Properties::ReadStyle	propertiesStyle = `Properties::Average`
	)

Constructs an Ogg/FLAC 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::Ogg::FLAC::File::~File ( )

virtual

Destroys this instance of the File.

Reimplemented from TagLib::Ogg::File.

Member Function Documentation

virtual Properties* TagLib::Ogg::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.

bool TagLib::Ogg::FLAC::File::hasXiphComment ( ) const

Returns whether or not the file on disk actually has a XiphComment.

See also: tag()

PropertyMap TagLib::Ogg::FLAC::File::properties ( ) const

Implements the unified property interface – export function.

This forwards directly to XiphComment::properties().

virtual bool TagLib::Ogg::FLAC::File::save ( )

virtual

Save the file.

This will primarily save and update the XiphComment. Returns true if the save is successful.

Warning: In the current implementation, it's dangerous to call save() repeatedly. It leads to a segfault.

Reimplemented from TagLib::Ogg::File.

PropertyMap TagLib::Ogg::FLAC::File::setProperties ( const PropertyMap & )

Implements the unified tag dictionary interface – import function.

Like properties(), this is a forwarder to the file's XiphComment.

long TagLib::Ogg::FLAC::File::streamLength ( )

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

virtual XiphComment* TagLib::Ogg::FLAC::File::tag ( ) const

virtual

Returns the Tag for this file.

This will always be a XiphComment.

Note: This always returns a valid pointer regardless of whether or not the file on disk has a XiphComment. Use hasXiphComment() to check if the file on disk actually has a XiphComment.; 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.

See also: hasXiphComment()

Implements TagLib::File.

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

src/core/3rdparty/taglib/oggflacfile.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation