TagLib::S3M::File Class Reference

#include <s3mfile.h>

Inheritance diagram for TagLib::S3M::File:
Collaboration diagram for TagLib::S3M::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 &)
S3M::PropertiesaudioProperties () const
bool save ()

Constructor & Destructor Documentation

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

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

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

Contructs a ScreamTracker III 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::S3M::File::~File ( ) [virtual]

Destroys this instance of the File.

Reimplemented from TagLib::File.


Member Function Documentation

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

Implements TagLib::File.

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

Reimplemented from TagLib::File.

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.

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

Reimplemented from TagLib::File.

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: