TagLib::IT::File Class Reference

#include <itfile.h>

Inheritance diagram for TagLib::IT::File:

Collaboration diagram for TagLib::IT::File:

Public Member Functions
	File (FileName file, bool readProperties=true, AudioProperties::ReadStyle propertiesStyle=AudioProperties::Average)
	File (IOStream *stram, bool readProperties=true, AudioProperties::ReadStyle propertiesStyle=AudioProperties::Average)
virtual	~File ()
Mod::Tag *	tag () const
PropertyMap	properties () const
PropertyMap	setProperties (const PropertyMap &)
IT::Properties *	audioProperties () const
bool	save ()

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

Constructor & Destructor Documentation

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

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

TagLib::IT::File::File	(	IOStream *	stram,
		bool	readProperties = true,
		AudioProperties::ReadStyle	propertiesStyle = AudioProperties::Average
	)

Contructs a Impulse Tracker 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::IT::File::~File ( )

virtual

Destroys this instance of the File.

Reimplemented from TagLib::File.

Member Function Documentation

IT::Properties* TagLib::IT::File::audioProperties ( ) const

virtual

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

Implements TagLib::File.

PropertyMap TagLib::IT::File::properties

(

)

const

Forwards to Mod::Tag::properties(). BIC: will be removed once File::toDict() is made virtual

Reimplemented from TagLib::File.

bool TagLib::IT::File::save ( )

virtual

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

Note

Saving Impulse Tracker tags is not supported.

Implements TagLib::File.

PropertyMap TagLib::IT::File::setProperties

(

const PropertyMap &

)

Forwards to Mod::Tag::setProperties(). BIC: will be removed once File::setProperties() is made virtual

Reimplemented from TagLib::File.

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

• itfile.h