TagLib 1.11 (TagLib: TagLib::ASF::File Class Reference)

TagLib::ASF::File Class Reference

#include <asffile.h>

Inheritance diagram for TagLib::ASF::File:
Collaboration diagram for TagLib::ASF::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 Tagtag () const
PropertyMap properties () const
void removeUnsupportedProperties (const StringList &properties)
PropertyMap setProperties (const PropertyMap &)
virtual PropertiesaudioProperties () const
virtual bool save ()


Detailed Description

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

Constructor & Destructor Documentation

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

Constructs an ASF file from file.

Note:
In the current implementation, both readProperties and propertiesStyle are ignored. The audio properties are always read.

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

Constructs an ASF file from stream.

Note:
In the current implementation, both readProperties and propertiesStyle are ignored. The audio properties are always read.

TagLib will *not* take ownership of the stream, the caller is responsible for deleting it after the File object.

virtual TagLib::ASF::File::~File (  )  [virtual]

Destroys this instance of the File.

Reimplemented from TagLib::File.


Member Function Documentation

virtual Tag* TagLib::ASF::File::tag (  )  const [virtual]

Returns a pointer to the ASF tag of the file.

ASF::Tag implements the tag interface, so this serves as the reimplementation of TagLib::File::tag().

Note:
The Tag is still owned by the ASF::File and should not be deleted by the user. It will be deleted when the file (object) is destroyed.

Implements TagLib::File.

PropertyMap TagLib::ASF::File::properties (  )  const

Implements the unified property interface -- export function.

Reimplemented from TagLib::File.

void TagLib::ASF::File::removeUnsupportedProperties ( const StringList properties  ) 

Removes unsupported properties. Forwards to the actual Tag's removeUnsupportedProperties() function.

Reimplemented from TagLib::File.

PropertyMap TagLib::ASF::File::setProperties ( const PropertyMap  ) 

Implements the unified property interface -- import function.

Reimplemented from TagLib::File.

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

Returns the ASF audio properties for this file.

Implements TagLib::File.

virtual bool TagLib::ASF::File::save (  )  [virtual]

Save the file.

This returns true if the save was successful.

Implements TagLib::File.


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