TagLib::ID3v2::Header Class Reference
An implementation of
ID3v2 headers.
More...
#include <id3v2header.h>
Inheritance diagram for TagLib::ID3v2::Header:
[legend]List of all members.
Detailed Description
An implementation of
ID3v2 headers.
This class implements ID3v2 headers. It attempts to follow, both semantically and programatically, the structure specified in the ID3v2 standard. The API is based on the properties of ID3v2 headers specified there. If any of the terms used in this documentation are unclear please check the specification in the linked section. (Structure, 3.1)
Constructor & Destructor Documentation
TagLib::ID3v2::Header::Header |
( |
|
) |
|
|
|
Constructs an empty ID3v2 header. |
TagLib::ID3v2::Header::Header |
( |
const ByteVector & |
data |
) |
|
|
|
Constructs an ID3v2 header based on data. parse() is called immediately. |
virtual TagLib::ID3v2::Header::~Header |
( |
|
) |
[virtual] |
|
Member Function Documentation
uint TagLib::ID3v2::Header::completeTagSize |
( |
|
) |
const |
|
|
Returns the tag size, including the header and, if present, the footer size.
- See also:
- tagSize()
|
bool TagLib::ID3v2::Header::experimentalIndicator |
( |
|
) |
const |
|
|
Returns true if the experimental indicator flag is set. |
bool TagLib::ID3v2::Header::extendedHeader |
( |
|
) |
const |
|
|
Returns true if an extended header is present in the tag. |
ByteVector TagLib::ID3v2::Header::fileIdentifier |
( |
|
) |
[static] |
|
|
Returns the string used to identify and ID3v2 tag inside of a file. Presently this is always "ID3". |
bool TagLib::ID3v2::Header::footerPresent |
( |
|
) |
const |
|
|
Returns true if a footer is present in the tag. |
uint TagLib::ID3v2::Header::majorVersion |
( |
|
) |
const |
|
|
Returns the major version number. (Note: This is the 4, not the 2 in ID3v2.4.0. The 2 is implied.) |
void TagLib::ID3v2::Header::parse |
( |
const ByteVector & |
data |
) |
[protected] |
|
ByteVector TagLib::ID3v2::Header::render |
( |
|
) |
const |
|
uint TagLib::ID3v2::Header::revisionNumber |
( |
|
) |
const |
|
|
Returns the revision number. (Note: This is the 0, not the 4 in ID3v2.4.0. The 2 is implied.) |
void TagLib::ID3v2::Header::setData |
( |
const ByteVector & |
data |
) |
|
|
void TagLib::ID3v2::Header::setMajorVersion |
( |
uint |
version |
) |
|
|
|
Set the the major version number to version. (Note: This is the 4, not the 2 in ID3v2.4.0. The 2 is implied.) - See also:
- majorVersion()
- Note:
- This is used by the internal parser; this will not change the version which is written and in general should not be called by API users.
|
void TagLib::ID3v2::Header::setTagSize |
( |
uint |
s |
) |
|
|
uint TagLib::ID3v2::Header::size |
( |
|
) |
[static] |
|
|
Returns the size of the header. Presently this is always 10 bytes.
Reimplemented in TagLib::ID3v2::Frame. |
uint TagLib::ID3v2::Header::tagSize |
( |
|
) |
const |
|
|
Returns the tag size in bytes. This is the size of the frame content. The size of the entire tag will be this plus the header size (10 bytes) and, if present, the footer size (potentially another 10 bytes).
- Note:
- This is the value as read from the header to which TagLib attempts to provide an API to; it was not a design decision on the part of TagLib to not include the mentioned portions of the tag in the size.
- See also:
- completeTagSize()
|
bool TagLib::ID3v2::Header::unsynchronisation |
( |
|
) |
const |
|
|
Returns true if unsynchronisation has been applied to all frames.
Reimplemented in TagLib::ID3v2::Frame. |
The documentation for this class was generated from the following file: