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

TagLib::Ogg::FLAC::File Class Reference

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

#include <oggflacfile.h>

Inheritance diagram for TagLib::Ogg::FLAC::File:
Collaboration diagram for TagLib::Ogg::FLAC::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 XiphCommenttag () const
virtual PropertiesaudioProperties () const
PropertyMap properties () const
PropertyMap setProperties (const PropertyMap &)
virtual bool save ()
long streamLength ()
bool hasXiphComment () const


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 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.

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.

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

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

Reimplemented from TagLib::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.

Reimplemented from TagLib::File.

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.

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

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

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

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

See also:
tag()


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