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 ()
- Public Member Functions inherited from TagLib::File
FileName name () const
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 ()

Friends

class Attribute
class Picture

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

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 Properties* TagLib::ASF::File::audioProperties ( ) const
virtual

Returns the ASF audio properties for this file.

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.

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

Save the file.

This returns true if the save was successful.

Implements TagLib::File.

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

Implements the unified property interface – import function.

Reimplemented from TagLib::File.

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.


Friends And Related Function Documentation

friend class Attribute
friend
friend class Picture
friend

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