TagLib 1.9.1 (TagLib::RIFF::AIFF::File Class Reference)

TagLib::RIFF::AIFF::File Class Reference

An implementation of TagLib::File with AIFF specific methods. More...

#include <aifffile.h>

Inheritance diagram for TagLib::RIFF::AIFF::File:
Collaboration diagram for TagLib::RIFF::AIFF::File:

List of all members.

Public Member Functions

 File (FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
 File (IOStream *stream, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
virtual ~File ()
virtual ID3v2::Tagtag () const
PropertyMap properties () const
void removeUnsupportedProperties (const StringList &properties)
PropertyMap setProperties (const PropertyMap &)
virtual PropertiesaudioProperties () const
virtual bool save ()
bool hasID3v2Tag () const

Additional Inherited Members

- Protected Types inherited from TagLib::RIFF::File
enum  Endianness { BigEndian, LittleEndian }
- Protected Member Functions inherited from TagLib::RIFF::File
 File (FileName file, Endianness endianness)
 File (IOStream *stream, Endianness endianness)
uint riffSize () const
uint chunkCount () const
uint chunkOffset (uint i) const
uint chunkDataSize (uint i) const
uint chunkPadding (uint i) const
ByteVector chunkName (uint i) const
ByteVector chunkData (uint i)
void setChunkData (uint i, const ByteVector &data)
void setChunkData (const ByteVector &name, const ByteVector &data)
void setChunkData (const ByteVector &name, const ByteVector &data, bool alwaysCreate)
void removeChunk (uint i)
void removeChunk (const ByteVector &name)
- Protected Member Functions inherited from TagLib::File
 File (FileName file)
 File (IOStream *stream)
void setValid (bool valid)
void truncate (long length)

Detailed Description

An implementation of TagLib::File with AIFF specific methods.

This implements and provides an interface for AIFF 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 AIFF files.


Constructor & Destructor Documentation

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

Constructs an AIFF file from file. If readProperties is true the file's audio properties will also be read.

Note:
In the current implementation, propertiesStyle is ignored.
TagLib::RIFF::AIFF::File::File ( IOStream stream,
bool  readProperties = true,
Properties::ReadStyle  propertiesStyle = Properties::Average 
)

Constructs an AIFF file from stream. If readProperties is true the file's audio properties will also be read.

Note:
TagLib will not take ownership of the stream, the caller is responsible for deleting it after the File object.
In the current implementation, propertiesStyle is ignored.
virtual TagLib::RIFF::AIFF::File::~File ( )
virtual

Destroys this instance of the File.

Reimplemented from TagLib::RIFF::File.


Member Function Documentation

virtual Properties* TagLib::RIFF::AIFF::File::audioProperties ( ) const
virtual

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

Implements TagLib::File.

bool TagLib::RIFF::AIFF::File::hasID3v2Tag ( ) const

Returns whether or not the file on disk actually has an ID3v2 tag.

See also:
ID3v2Tag()
PropertyMap TagLib::RIFF::AIFF::File::properties ( ) const

Implements the unified property interface – export function. This method forwards to ID3v2::Tag::properties().

Reimplemented from TagLib::File.

void TagLib::RIFF::AIFF::File::removeUnsupportedProperties ( const StringList properties)

Removes unsupported properties, or a subset of them, from the file's metadata. The parameter properties must contain only entries from properties().unsupportedData(). BIC: Will be mad virtual in future releases.

Reimplemented from TagLib::File.

virtual bool TagLib::RIFF::AIFF::File::save ( )
virtual

Saves the file.

Implements TagLib::File.

PropertyMap TagLib::RIFF::AIFF::File::setProperties ( const PropertyMap )

Implements the unified property interface – import function. This method forwards to ID3v2::Tag::setProperties().

Reimplemented from TagLib::File.

virtual ID3v2::Tag* TagLib::RIFF::AIFF::File::tag ( ) const
virtual

Returns the Tag for this file.

Note:
This always returns a valid pointer regardless of whether or not the file on disk has an ID3v2 tag. Use hasID3v2Tag() to check if the file on disk actually has an ID3v2 tag.
See also:
hasID3v2Tag()

Implements TagLib::File.


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