TagLib 1.11 (TagLib: TagLib::Ogg::Speex::File Class Reference)

TagLib::Ogg::Speex::File Class Reference

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

#include <speexfile.h>

Inheritance diagram for TagLib::Ogg::Speex::File:
Collaboration diagram for TagLib::Ogg::Speex::File:

List of all members.

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


Detailed Description

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

This is the central class in the Ogg Speex 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 Speex specifically.


Constructor & Destructor Documentation

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

Constructs a Speex 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::Speex::File::File ( IOStream stream,
bool  readProperties = true,
Properties::ReadStyle  propertiesStyle = Properties::Average 
)

Constructs a Speex 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::Speex::File::~File (  )  [virtual]

Destroys this instance of the File.

Reimplemented from TagLib::Ogg::File.


Member Function Documentation

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

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

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

Reimplemented from TagLib::File.

PropertyMap TagLib::Ogg::Speex::File::setProperties ( const PropertyMap  ) 

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

Reimplemented from TagLib::File.

virtual Properties* TagLib::Ogg::Speex::File::audioProperties (  )  const [virtual]

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

Implements TagLib::File.

virtual bool TagLib::Ogg::Speex::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.


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