TagLib::Ogg::Opus::File Class Reference

An implementation of Ogg::File with Opus specific methods. More...

#include <opusfile.h>

Inheritance diagram for TagLib::Ogg::Opus::File:

Collaboration diagram for TagLib::Ogg::Opus::File:

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 Ogg::XiphComment *	tag () const
PropertyMap	properties () const
PropertyMap	setProperties (const PropertyMap &)
virtual Properties *	audioProperties () const
virtual bool	save ()
Public Member Functions inherited from TagLib::Ogg::File
ByteVector	packet (unsigned int i)
void	setPacket (unsigned int i, const ByteVector &p)
const PageHeader *	firstPageHeader ()
const PageHeader *	lastPageHeader ()
Public Member Functions inherited from TagLib::File
FileName	name () const
PropertyMap	properties () const
void	removeUnsupportedProperties (const StringList &properties)
PropertyMap	setProperties (const PropertyMap &properties)
ByteVector	readBlock (unsigned long length)
void	writeBlock (const ByteVector &data)
long	find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
long	rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
void	insert (const ByteVector &data, unsigned long start=0, unsigned long replace=0)
void	removeBlock (unsigned long start=0, unsigned long length=0)
bool	readOnly () const
bool	isOpen () const
bool	isValid () const
void	seek (long offset, Position p=Beginning)
void	clear ()
long	tell () const
long	length ()

Additional Inherited Members
Public Types inherited from TagLib::File
enum	Position { Beginning, Current, End }
Static Public Member Functions inherited from TagLib::File
static bool	isReadable (const char *file)
static bool	isWritable (const char *name)
Protected Member Functions inherited from TagLib::Ogg::File
	File (FileName file)
	File (IOStream *stream)
Protected Member Functions inherited from TagLib::File
	File (FileName file)
	File (IOStream *stream)
void	setValid (bool valid)
void	truncate (long length)
Static Protected Member Functions inherited from TagLib::File
static unsigned int	bufferSize ()

Detailed Description

An implementation of Ogg::File with Opus specific methods.

This is the central class in the Ogg Opus metadata processing collection of classes. It's built upon Ogg::File which handles processing of the Ogg logical bitstream and breaking it down into pages which are handled by the codec implementations, in this case Opus specifically.

Constructor & Destructor Documentation

File() [1/2]

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

Constructs an Opus 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/2]

TagLib::Ogg::Opus::File::File	(	IOStream *	stream,
		bool	readProperties = true,
		Properties::ReadStyle	propertiesStyle = Properties::Average
	)

Constructs an Opus 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()

virtual TagLib::Ogg::Opus::File::~File ( )

virtual

Destroys this instance of the File.

Reimplemented from TagLib::Ogg::File.

Member Function Documentation

audioProperties()

virtual Properties* TagLib::Ogg::Opus::File::audioProperties ( ) const

virtual

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

Implements TagLib::File.

properties()

PropertyMap TagLib::Ogg::Opus::File::properties

(

)

const

Implements the unified property interface – export function. This forwards directly to XiphComment::properties().

save()

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

virtual

Save the file.

This returns true if the save was successful.

Warning

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

Reimplemented from TagLib::Ogg::File.

setProperties()

PropertyMap TagLib::Ogg::Opus::File::setProperties

(

const PropertyMap &

)

Implements the unified tag dictionary interface – import function. Like properties(), this is a forwarder to the file's XiphComment.

tag()

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

virtual

Returns the XiphComment for this file. XiphComment implements the tag interface, so this serves as the reimplementation of TagLib::File::tag().

Implements TagLib::File.

---

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

• opusfile.h