TagLib API Documentation

TagLib::MPEG::File Class Reference

An MPEG file class with some useful methods specific to MPEG. More...

#include <mpegfile.h>

Inheritance diagram for TagLib::MPEG::File:

TagLib::File List of all members.

Public Types

enum  TagTypes { NoTags = 0x0000, ID3v1 = 0x0001, ID3v2 = 0x0002, AllTags = 0xffff }

Public Member Functions

 File (const char *file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
virtual ~File ()
virtual Tagtag () const
virtual PropertiesaudioProperties () const
virtual void save ()
void save (int tags)
ID3v2::TagID3v2Tag (bool create=false)
ID3v1::TagID3v1Tag (bool create=false)
void strip (int tags=AllTags)
void setID3v2FrameFactory (const ID3v2::FrameFactory *factory)
long firstFrameOffset ()
long nextFrameOffset (long position)
long previousFrameOffset (long position)
long lastFrameOffset ()

Detailed Description

An MPEG file class with some useful methods specific to MPEG.

This implements the generic TagLib::File API and additionally provides access to properties that are distinct to MPEG files, notably access to the different ID3 tags.

Definition at line 46 of file mpegfile.h.


Member Enumeration Documentation

enum TagLib::MPEG::File::TagTypes
 

This set of flags is used for various operations and is suitable for being OR-ed together.

Enumeration values:
NoTags  Empty set. Matches no tag types.
ID3v1  Matches ID3v1 tags.
ID3v2  Matches ID3v2 tags.
AllTags  Matches all tag types.

Definition at line 53 of file mpegfile.h.


Constructor & Destructor Documentation

TagLib::MPEG::File::File const char *  file,
bool  readProperties = true,
Properties::ReadStyle  propertiesStyle = Properties::Average
 

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

virtual TagLib::MPEG::File::~File  )  [virtual]
 

Destroys this instance of the File.

Reimplemented from TagLib::File.


Member Function Documentation

virtual Tag* TagLib::MPEG::File::tag  )  const [virtual]
 

Returns a pointer to a tag that is the union of the ID3v2 and ID3v1 tags. The ID3v2 tag is given priority in reading the information -- if requested information exists in both the ID3v2 tag and the ID3v1 tag, the information from the ID3v2 tag will be returned.

If you would like more granular control over the content of the tags, with the concession of generality, use the tag-type specific calls.

Note:
As this tag is not implemented as an ID3v2 tag or an ID3v1 tag, but a union of the two this pointer may not be cast to the specific tag types.
See also:
ID3v1Tag()

ID3v2Tag()

Implements TagLib::File.

virtual Properties* TagLib::MPEG::File::audioProperties  )  const [virtual]
 

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

Implements TagLib::File.

virtual void TagLib::MPEG::File::save  )  [virtual]
 

Save the file. If at least one tag -- ID3v1 or ID3v2 -- exists this will duplicate its content into the other tag.

If neither exists or if both tags are empty, this will strip the tags from the file.

This is the same as calling save(AllTags);

If you would like more granular control over the content of the tags, with the concession of generality, use paramaterized save call below.

See also:
save(int tags)

Implements TagLib::File.

void TagLib::MPEG::File::save int  tags  ) 
 

Save the file. This will attempt to save all of the tag types that are specified by OR-ing together TagTypes values. The save() method above uses AllTags.

This strips all tags not included in the mask, but does not modify them in memory, so later calls to save() which make use of these tags will remain valid. This also strips empty tags.

ID3v2::Tag* TagLib::MPEG::File::ID3v2Tag bool  create = false  ) 
 

Returns a pointer to the ID3v2 tag of the file.

This method will return a null pointer if either the file can not be read from.

If create is false (the default) it will also return a null pointer if there is no valid ID3v2 tag. If create is true it will create an ID3v2 tag if one does not exist.

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

ID3v1::Tag* TagLib::MPEG::File::ID3v1Tag bool  create = false  ) 
 

Returns a pointer to the ID3v1 tag of the file.

This method will return a null pointer if either the file can not be read from.

If create is false (the default) it will also return a null pointer if there is no valid ID3v1 tag. If create is true it will create an ID3v1 tag if one does not exist.

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

void TagLib::MPEG::File::strip int  tags = AllTags  ) 
 

This will strip the tags that match the OR-ed together TagTypes from the file. By default it strips all tags.

void TagLib::MPEG::File::setID3v2FrameFactory const ID3v2::FrameFactory factory  ) 
 

Set the ID3v2::FrameFactory to something other than the default.

See also:
ID3v2FrameFactory

long TagLib::MPEG::File::firstFrameOffset  ) 
 

Returns the position in the file of the first MPEG frame.

long TagLib::MPEG::File::nextFrameOffset long  position  ) 
 

Returns the position in the file of the next MPEG frame, using the current position as start

long TagLib::MPEG::File::previousFrameOffset long  position  ) 
 

Returns the position in the file of the previous MPEG frame, using the current position as start

long TagLib::MPEG::File::lastFrameOffset  ) 
 

Returns the position in the file of the last MPEG frame.


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for TagLib Version 1.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Jan 22 05:44:22 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2003