TagLib::XM::File Class Reference

#include <xmfile.h>

Inheritance diagram for TagLib::XM::File:
Collaboration diagram for TagLib::XM::File:

List of all members.

Public Member Functions

 File (FileName file, bool readProperties=true, AudioProperties::ReadStyle propertiesStyle=AudioProperties::Average)
 File (IOStream *stream, bool readProperties=true, AudioProperties::ReadStyle propertiesStyle=AudioProperties::Average)
virtual ~File ()
Mod::Tagtag () const
PropertyMap properties () const
PropertyMap setProperties (const PropertyMap &)
XM::PropertiesaudioProperties () const
bool save ()

Additional Inherited Members

- Protected Member Functions inherited from TagLib::Mod::FileBase
 FileBase (FileName file)
 FileBase (IOStream *stream)
void writeString (const String &s, ulong size, char padding=0)
void writeByte (uchar byte)
void writeU16L (ushort number)
void writeU32L (ulong number)
void writeU16B (ushort number)
void writeU32B (ulong number)
bool readString (String &s, ulong size)
bool readByte (uchar &byte)
bool readU16L (ushort &number)
bool readU32L (ulong &number)
bool readU16B (ushort &number)
bool readU32B (ulong &number)
- Protected Member Functions inherited from TagLib::File
 File (FileName file)
 File (IOStream *stream)
void setValid (bool valid)
void truncate (long length)

Constructor & Destructor Documentation

TagLib::XM::File::File ( FileName  file,
bool  readProperties = true,
AudioProperties::ReadStyle  propertiesStyle = AudioProperties::Average 
)

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

TagLib::XM::File::File ( IOStream stream,
bool  readProperties = true,
AudioProperties::ReadStyle  propertiesStyle = AudioProperties::Average 
)

Contructs a Extended Module file from stream. 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::XM::File::~File ( )
virtual

Destroys this instance of the File.

Reimplemented from TagLib::File.


Member Function Documentation

XM::Properties* TagLib::XM::File::audioProperties ( ) const
virtual

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

Implements TagLib::File.

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

Implements the unified property interface – export function. Forwards to Mod::Tag::properties().

Reimplemented from TagLib::File.

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

Save the file. This is the same as calling save(AllTags);

Note:
Saving Extended Module tags is not supported.

Implements TagLib::File.

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

Implements the unified property interface – import function. Forwards to Mod::Tag::setProperties().

Reimplemented from TagLib::File.

Mod::Tag* TagLib::XM::File::tag ( ) const
virtual

Returns a pointer to this file's tag. This should be reimplemented in the concrete subclasses.

Implements TagLib::File.


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