Tag Parser  9.0.0
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
Enumerations | Functions
TagParser::Id3v2FrameIds Namespace Reference

Encapsulates the most common ID3v2 frame IDs and related functions. More...

Enumerations

enum  KnownValue : std::uint32_t {
  lAlbum = 0x54414c42, lArtist = 0x54504531, lComment = 0x434f4d4d, lYear = 0x54594552,
  lRecordDate = 0x54445243, lTitle = 0x54495432, lGenre = 0x54434f4e, lTrackPosition = 0x5452434b,
  lDiskPosition = 0x54504f53, lEncoder = 0x54454e43, lBpm = 0x5442504d, lCover = 0x41504943,
  lWriter = 0x54455854, lLength = 0x544c454e, lLanguage = 0x544c414e, lEncoderSettings = 0x54535345,
  lUnsynchronizedLyrics = 0x55534c54, lSynchronizedLyrics = 0x53594C54, lAlbumArtist = 0x54504532, lContentGroupDescription = 0x54495431,
  lRecordLabel = 0x54505542, lUniqueFileId = 0x55464944, lComposer = 0x54434f4d, lRating = 0x504f504d,
  lUserDefinedText = 0x54585858, sAlbum = 0x54414c, sArtist = 0x545031, sComment = 0x434f4d,
  sYear = 0x545945, sRecordDate = 0x545243, sTitle = 0x545432, sGenre = 0x54434f,
  sTrackPosition = 0x54524b, sDiskPosition = 0x545041, sEncoder = 0x54454e, sBpm = 0x544250,
  sCover = 0x504943, sWriter = 0x545854, sLength = 0x544c45, sLanguage = 0x544c41,
  sEncoderSettings = 0x545353, sUnsynchronizedLyrics = 0x554C54, sSynchronizedLyrics = 0x534C54, sAlbumArtist = 0x545032,
  sContentGroupDescription = 0x545431, sRecordLabel = 0x545042, sUniqueFileId = 0x554649, sComposer = 0x54434d,
  sRating = 0x504f50, sUserDefinedText = 0x545858
}
 

Functions

std::uint32_t convertToShortId (std::uint32_t id)
 Converts the specified long frame ID to the equivalent short frame ID. More...
 
std::uint32_t convertToLongId (std::uint32_t id)
 Converts the specified short frame ID to the equivalent long frame ID. More...
 
constexpr bool isLongId (std::uint32_t id)
 Returns an indication whether the specified id is a long frame id. More...
 
constexpr bool isShortId (std::uint32_t id)
 Returns an indication whether the specified id is a short frame id. More...
 
constexpr bool isTextFrame (std::uint32_t id)
 Returns an indication whether the specified id is a text frame id. More...
 

Detailed Description

Encapsulates the most common ID3v2 frame IDs and related functions.

There are short frame IDs (used by the first version of ID3v2) and long frame IDs (used by newer versions of ID3v2).

The short IDs start with "s" and the long IDs with "l". To convert between these IDs the functions convertToShortId() and convertToLongId() can be used.

Enumeration Type Documentation

◆ KnownValue

Enumerator
lAlbum 
lArtist 
lComment 
lYear 
lRecordDate 
lTitle 
lGenre 
lTrackPosition 
lDiskPosition 
lEncoder 
lBpm 
lCover 
lWriter 
lLength 
lLanguage 
lEncoderSettings 
lUnsynchronizedLyrics 
lSynchronizedLyrics 
lAlbumArtist 
lContentGroupDescription 
lRecordLabel 
lUniqueFileId 
lComposer 
lRating 
lUserDefinedText 
sAlbum 
sArtist 
sComment 
sYear 
sRecordDate 
sTitle 
sGenre 
sTrackPosition 
sDiskPosition 
sEncoder 
sBpm 
sCover 
sWriter 
sLength 
sLanguage 
sEncoderSettings 
sUnsynchronizedLyrics 
sSynchronizedLyrics 
sAlbumArtist 
sContentGroupDescription 
sRecordLabel 
sUniqueFileId 
sComposer 
sRating 
sUserDefinedText 

Definition at line 11 of file id3v2frameids.h.

Function Documentation

◆ convertToLongId()

std::uint32_t TagParser::Id3v2FrameIds::convertToLongId ( std::uint32_t  id)

Converts the specified short frame ID to the equivalent long frame ID.

Returns
Returns the long ID if available; otherwise returns 0.

Definition at line 77 of file id3v2frameids.cpp.

◆ convertToShortId()

std::uint32_t TagParser::Id3v2FrameIds::convertToShortId ( std::uint32_t  id)

Converts the specified long frame ID to the equivalent short frame ID.

Returns
Returns the short ID if available; otherwise returns 0.

Definition at line 23 of file id3v2frameids.cpp.

◆ isLongId()

constexpr bool TagParser::Id3v2FrameIds::isLongId ( std::uint32_t  id)
constexpr

Returns an indication whether the specified id is a long frame id.

Definition at line 71 of file id3v2frameids.h.

◆ isShortId()

constexpr bool TagParser::Id3v2FrameIds::isShortId ( std::uint32_t  id)
constexpr

Returns an indication whether the specified id is a short frame id.

Definition at line 79 of file id3v2frameids.h.

◆ isTextFrame()

constexpr bool TagParser::Id3v2FrameIds::isTextFrame ( std::uint32_t  id)
constexpr

Returns an indication whether the specified id is a text frame id.

Definition at line 87 of file id3v2frameids.h.