TagLib::MP4::File Class Reference

#include <mp4file.h>

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

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 ()
- Public Member Functions inherited from TagLib::File
FileName name () const
ByteVector readBlock (ulong length)
void writeBlock (const ByteVector &data)
long find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector::null)
long rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector::null)
void insert (const ByteVector &data, ulong start=0, ulong replace=0)
void removeBlock (ulong start=0, ulong 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::File
 File (FileName file)
 File (IOStream *stream)
void setValid (bool valid)
void truncate (long length)
- Static Protected Member Functions inherited from TagLib::File
static uint bufferSize ()

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.

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: