TagLib::Mod::File Class Reference

#include <modfile.h>

Inheritance diagram for TagLib::Mod::File:
Collaboration diagram for TagLib::Mod::File:

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 &)
 
Mod::PropertiesaudioProperties () const
 
bool save ()
 
- Public Member Functions inherited from TagLib::File
FileName name () const
 
PropertyMap properties () const
 
void removeUnsupportedProperties (const StringList &properties)
 
PropertyMap setProperties (const PropertyMap &properties)
 
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 ()
 

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::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)
 
- Static Protected Member Functions inherited from TagLib::File
static uint bufferSize ()
 

Constructor & Destructor Documentation

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

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

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

Contructs a Protracker 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::Mod::File::~File ( )
virtual

Destroys this instance of the File.

Reimplemented from TagLib::File.

Member Function Documentation

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

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

Implements TagLib::File.

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

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

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

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

Note
Saving Protracker tags is not supported.

Implements TagLib::File.

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

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

Mod::Tag* TagLib::Mod::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: