Tag Parser
9.1.2
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
|
The TagTarget class specifies the target of a tag. More...
#include <tagtarget.h>
Public Types | |
using | IdType = std::uint64_t |
using | IdContainerType = std::vector< IdType > |
Public Member Functions | |
TagTarget (std::uint64_t level=0, IdContainerType tracks=IdContainerType(), IdContainerType chapters=IdContainerType(), IdContainerType editions=IdContainerType(), IdContainerType attachments=IdContainerType()) | |
Constructs a new TagTarget with the specified level, track, chapter, edition and attachment. More... | |
std::uint64_t | level () const |
Returns the level. More... | |
void | setLevel (std::uint64_t level) |
Sets the level. More... | |
const std::string & | levelName () const |
Returns the level name. More... | |
void | setLevelName (const std::string &levelName) |
Sets the level name. More... | |
const IdContainerType & | tracks () const |
Returns the tracks. More... | |
IdContainerType & | tracks () |
const IdContainerType & | chapters () const |
Returns the chapters. More... | |
IdContainerType & | chapters () |
const IdContainerType & | editions () const |
Returns the editions. More... | |
IdContainerType & | editions () |
const IdContainerType & | attachments () const |
Returns the attachments. More... | |
IdContainerType & | attachments () |
bool | isEmpty () const |
Returns an indication whether the target is empty. More... | |
void | clear () |
Clears the TagTarget. More... | |
std::string | toString (const std::function< TagTargetLevel(std::uint64_t)> &tagTargetMapping) const |
Returns the string representation of the current instance. More... | |
std::string | toString (TagTargetLevel tagTargetLevel) const |
Returns the string representation of the current instance. More... | |
bool | operator== (const TagTarget &other) const |
Returns whether the tag targets are equal. More... | |
The TagTarget class specifies the target of a tag.
Tags might only target a specific track, chapter, ...
Specifying a target is currently only fully supported by Matroska.
Since Ogg saves tags at stream level, the stream can be specified by passing a TagTarget instance to OggContainer::createTag(). However, only the first track in the tracks() array is considered and any other values are just ignored.
In any other tag formats, the specified target is (currently) completely ignored.
Definition at line 20 of file tagtarget.h.
using TagParser::TagTarget::IdContainerType = std::vector<IdType> |
Definition at line 23 of file tagtarget.h.
using TagParser::TagTarget::IdType = std::uint64_t |
Definition at line 22 of file tagtarget.h.
|
inline |
Constructs a new TagTarget with the specified level, track, chapter, edition and attachment.
Definition at line 59 of file tagtarget.h.
IdContainerType& TagParser::TagTarget::attachments | ( | ) |
|
inline |
Returns the attachments.
Definition at line 152 of file tagtarget.h.
IdContainerType& TagParser::TagTarget::chapters | ( | ) |
|
inline |
Returns the chapters.
Definition at line 120 of file tagtarget.h.
|
inline |
Clears the TagTarget.
Definition at line 176 of file tagtarget.h.
IdContainerType& TagParser::TagTarget::editions | ( | ) |
|
inline |
Returns the editions.
Definition at line 136 of file tagtarget.h.
|
inline |
Returns an indication whether the target is empty.
Definition at line 168 of file tagtarget.h.
|
inline |
Returns the level.
Definition at line 72 of file tagtarget.h.
|
inline |
Returns the level name.
Definition at line 88 of file tagtarget.h.
|
inline |
Returns whether the tag targets are equal.
Definition at line 190 of file tagtarget.h.
|
inline |
Sets the level.
Definition at line 80 of file tagtarget.h.
|
inline |
Sets the level name.
Definition at line 96 of file tagtarget.h.
|
inline |
Returns the string representation of the current instance.
Definition at line 201 of file tagtarget.h.
string TagParser::TagTarget::toString | ( | TagTargetLevel | tagTargetLevel | ) | const |
Returns the string representation of the current instance.
Definition at line 60 of file tagtarget.cpp.
IdContainerType& TagParser::TagTarget::tracks | ( | ) |
|
inline |
Returns the tracks.
Definition at line 104 of file tagtarget.h.