TagLib::S3M::File Class Reference

#include <s3mfile.h>

Inheritance diagram for TagLib::S3M::File:

Collaboration diagram for TagLib::S3M::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::Tag *	tag () const
PropertyMap	properties () const
PropertyMap	setProperties (const PropertyMap &)
S3M::Properties *	audioProperties () 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 (unsigned long length)
void	writeBlock (const ByteVector &data)
long	find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
long	rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
void	insert (const ByteVector &data, unsigned long start=0, unsigned long replace=0)
void	removeBlock (unsigned long start=0, unsigned long 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, unsigned long size, char padding=0)
void	writeByte (unsigned char byte)
void	writeU16L (unsigned short number)
void	writeU32L (unsigned long number)
void	writeU16B (unsigned short number)
void	writeU32B (unsigned long number)
bool	readString (String &s, unsigned long size)
bool	readByte (unsigned char &byte)
bool	readU16L (unsigned short &number)
bool	readU32L (unsigned long &number)
bool	readU16B (unsigned short &number)
bool	readU32B (unsigned long &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 unsigned int	bufferSize ()

Constructor & Destructor Documentation

File() [1/2]

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

Constructs a ScreamTracker III from file.

Note

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

File() [2/2]

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

Constructs a ScreamTracker III 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.

~File()

virtual TagLib::S3M::File::~File ( )

virtual

Destroys this instance of the File.

Reimplemented from TagLib::File.

Member Function Documentation

audioProperties()

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

virtual

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

Implements TagLib::File.

properties()

PropertyMap TagLib::S3M::File::properties

(

)

const

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

save()

bool TagLib::S3M::File::save ( )

virtual

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

Note

Saving ScreamTracker III tags is not supported.

Implements TagLib::File.

setProperties()

PropertyMap TagLib::S3M::File::setProperties

(

const PropertyMap &

)

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

tag()

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

• s3mfile.h