TagLib 1.8.0 (TagLib::Ogg::Opus::File Class Reference)

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::XiphCommenttag () const
 
PropertyMap properties () const
 
PropertyMap setProperties (const PropertyMap &)
 
virtual PropertiesaudioProperties () const
 
virtual bool save ()
 
- Public Member Functions inherited from TagLib::Ogg::File
ByteVector packet (uint i)
 
void setPacket (uint i, const ByteVector &p)
 
const PageHeaderfirstPageHeader ()
 
const PageHeaderlastPageHeader ()
 
- 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 (ulong length)
 
void writeBlock (const ByteVector &data)
 
long find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector::null)
 
long rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector::null)
 
void insert (const ByteVector &data, ulong start=0, ulong replace=0)
 
void removeBlock (ulong start=0, ulong 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 uint 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

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

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

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

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

Note
TagLib will not take ownership of the stream, the caller is responsible for deleting it after the File object.
virtual TagLib::Ogg::Opus::File::~File ( )
virtual

Destroys this instance of the File.

Reimplemented from TagLib::Ogg::File.

Member Function Documentation

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.

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

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

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

Save the file and its associated tags. This should be reimplemented in the concrete subclasses. Returns true if the save succeeds.

Warning
On UNIX multiple processes are able to write to the same file at the same time. This can result in serious file corruption. If you are developing a program that makes use of TagLib from multiple processes you must insure that you are only doing writes to a particular file from one of them.

Reimplemented from TagLib::Ogg::File.

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.

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: