This implements and provides an interface for ASF files to the TagLib::Tag and TagLib::AudioProperties interfaces by way of implementing the abstract TagLib::File API as well as providing some additional information specific to ASF files. More...

#include <asffile.h>

Inheritance diagram for TagLib::ASF::File:

Public Member Functions
	File (FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
	Constructs an ASF file from file. More...

	File (IOStream *stream, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
	Constructs an ASF file from stream. More...

virtual	~File ()
	Destroys this instance of the File. More...

virtual Tag *	tag () const
	Returns a pointer to the ASF tag of the file. More...

PropertyMap	properties () const
	Implements the unified property interface – export function. More...

void	removeUnsupportedProperties (const StringList &properties)
	Removes unsupported properties. More...

PropertyMap	setProperties (const PropertyMap &)
	Implements the unified property interface – import function. More...

virtual Properties *	audioProperties () const
	Returns the ASF audio properties for this file. More...

virtual bool	save ()
	Save the file. More...

Public Member Functions inherited from TagLib::File
FileName	name () const
	Returns the file name in the local file system encoding. More...

PropertyMap	properties () const
	Exports the tags of the file as dictionary mapping (human readable) tag names (uppercase Strings) to StringLists of tag values. More...

void	removeUnsupportedProperties (const StringList &properties)
	Removes unsupported properties, or a subset of them, from the file's metadata. More...

PropertyMap	setProperties (const PropertyMap &properties)
	Sets the tags of this File to those specified in properties. More...

ByteVector	readBlock (unsigned long length)
	Reads a block of size length at the current get pointer. More...

void	writeBlock (const ByteVector &data)
	Attempts to write the block data at the current get pointer. More...

long	find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
	Returns the offset in the file that pattern occurs at or -1 if it can not be found. More...

long	rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
	Returns the offset in the file that pattern occurs at or -1 if it can not be found. More...

void	insert (const ByteVector &data, unsigned long start=0, unsigned long replace=0)
	Insert data at position start in the file overwriting replace bytes of the original content. More...

void	removeBlock (unsigned long start=0, unsigned long length=0)
	Removes a block of the file starting a start and continuing for length bytes. More...

bool	readOnly () const
	Returns true if the file is read only (or if the file can not be opened). More...

bool	isOpen () const
	Since the file can currently only be opened as an argument to the constructor (sort-of by design), this returns if that open succeeded. More...

bool	isValid () const
	Returns true if the file is open and readable. More...

void	seek (long offset, Position p=Beginning)
	Move the I/O pointer to offset in the file from position p. More...

void	clear ()
	Reset the end-of-file and error flags on the file. More...

long	tell () const
	Returns the current offset within the file. More...

long	length ()
	Returns the length of the file. More...

Additional Inherited Members
Public Types inherited from TagLib::File
enum	Position { Beginning, Current, End }
	Position in the file used for seeking. More...

Static Public Member Functions inherited from TagLib::File
static bool	isReadable (const char *file)
	Returns true if file can be opened for reading. More...

static bool	isWritable (const char *name)
	Returns true if file can be opened for writing. More...

Protected Member Functions inherited from TagLib::File
	File (FileName file)
	Construct a File object and opens the file. More...

	File (IOStream *stream)
	Construct a File object and use the stream instance. More...

void	setValid (bool valid)
	Marks the file as valid or invalid. More...

void	truncate (long length)
	Truncates the file to a length. More...

Static Protected Member Functions inherited from TagLib::File
static unsigned int	bufferSize ()
	Returns the buffer size that is used for internal buffering. More...

Detailed Description

This implements and provides an interface for ASF files to the TagLib::Tag and TagLib::AudioProperties interfaces by way of implementing the abstract TagLib::File API as well as providing some additional information specific to ASF files.

Constructor & Destructor Documentation

TagLib::ASF::File::File	(	FileName	file,
		bool	readProperties = `true`,
		Properties::ReadStyle	propertiesStyle = `Properties::Average`
	)

Constructs an ASF file from file.

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

TagLib::ASF::File::File	(	IOStream *	stream,
		bool	readProperties = `true`,
		Properties::ReadStyle	propertiesStyle = `Properties::Average`
	)

Constructs an ASF 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.

virtual TagLib::ASF::File::~File ( )

virtual

Destroys this instance of the File.

Reimplemented from TagLib::File.

Member Function Documentation

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

virtual

Returns the ASF audio properties for this file.

Implements TagLib::File.

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

Implements the unified property interface – export function.

void TagLib::ASF::File::removeUnsupportedProperties ( const StringList & properties )

Removes unsupported properties.

Forwards to the actual Tag's removeUnsupportedProperties() function.

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

virtual

Save the file.

This returns true if the save was successful.

Implements TagLib::File.

PropertyMap TagLib::ASF::File::setProperties ( const PropertyMap & )

Implements the unified property interface – import function.

virtual Tag* TagLib::ASF::File::tag ( ) const

virtual

Returns a pointer to the ASF tag of the file.

ASF::Tag implements the tag interface, so this serves as the reimplementation of TagLib::File::tag().

Note: The Tag is still owned by the ASF::File and should not be deleted by the user. It will be deleted when the file (object) is destroyed.

Implements TagLib::File.

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

src/core/3rdparty/taglib/asffile.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation