TagLib 1.11 (TagLib: TagLib::MP4::File Class Reference)

TagLib::MP4::File Class Reference

#include <mp4file.h>

Inheritance diagram for TagLib::MP4::File:
Collaboration diagram for TagLib::MP4::File:

List of all members.

Public Member Functions

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

Detailed Description

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


Constructor & Destructor Documentation

TagLib::MP4::File::File ( FileName  file,
bool  readProperties = true,
Properties::ReadStyle  audioPropertiesStyle = Properties::Average 
)

Constructs an MP4 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::MP4::File::File ( IOStream stream,
bool  readProperties = true,
Properties::ReadStyle  audioPropertiesStyle = Properties::Average 
)

Constructs an MP4 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::MP4::File::~File ( ) [virtual]

Destroys this instance of the File.

Reimplemented from TagLib::File.


Member Function Documentation

Properties* TagLib::MP4::File::audioProperties ( ) const [virtual]

Returns the MP4 audio properties for this file.

Implements TagLib::File.

bool TagLib::MP4::File::hasMP4Tag ( ) const

Returns whether or not the file on disk actually has an MP4 tag, or the file has a Metadata Item List (ilst) atom.

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

Implements the unified property interface -- export function.

Reimplemented from TagLib::File.

void TagLib::MP4::File::removeUnsupportedProperties ( const StringList properties)

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

Reimplemented from TagLib::File.

bool TagLib::MP4::File::save ( ) [virtual]

Save the file.

This returns true if the save was successful.

Implements TagLib::File.

PropertyMap TagLib::MP4::File::setProperties ( const PropertyMap )

Implements the unified property interface -- import function.

Reimplemented from TagLib::File.

Tag* TagLib::MP4::File::tag ( ) const [virtual]

Returns a pointer to the MP4 tag of the file.

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

Note:
The Tag is still owned by the MP4::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: