Tag Parser  6.5.0
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
Public Member Functions | List of all members
Media::MatroskaEditionEntry Class Reference

The MatroskaEditionEntry class provides a parser for edition entries in Matroska files. More...

#include <matroskaeditionentry.h>

Inheritance diagram for Media::MatroskaEditionEntry:
[legend]
Collaboration diagram for Media::MatroskaEditionEntry:
[legend]

Public Member Functions

 MatroskaEditionEntry (EbmlElement *editionEntryElement)
 Constructs a new MatroskaEditionEntry for the specified editionEntryElement. More...
 
 ~MatroskaEditionEntry ()
 Destroys the MatroskaEditionEntry. More...
 
EbmlElementeditionEntryElement () const
 Returns the "EditionEntry"-element specified when constructing the object. More...
 
uint64 id () const
 Returns the edition ID. More...
 
bool isHidden () const
 Returns whether the edition is hidden. More...
 
bool isDefault () const
 Returns whether the edition is flagged as default edition. More...
 
bool isOrdered () const
 Returns whether the edition is ordered. More...
 
std::string label () const
 Returns a label for the entry. More...
 
const std::vector< std::unique_ptr< MatroskaChapter > > & chapters () const
 Returns the chapters the edition contains. More...
 
void parse ()
 Parses the "EditionEntry"-element specified when constructing the object. More...
 
void parseNested ()
 Parses the "EditionEntry"-element specified when constructing the object. More...
 
void clear ()
 Resets the object to its initial state. More...
 
- Public Member Functions inherited from Media::StatusProvider
const NotificationListnotifications () const
 Returns notifications for the current object. More...
 
bool hasNotifications () const
 Returns an indication whether there are notifications for the current object. More...
 
bool hasCriticalNotifications () const
 Returns an indication whether there are critical notifications for the current object. More...
 
NotificationType worstNotificationType () const
 Returns the worst notification type. More...
 
const std::string & currentStatus () const
 Returns a status information for the current object. More...
 
double currentPercentage () const
 Returns the progress percentage of the current object. More...
 
size_t registerCallback (CallbackFunction callback)
 Registers a callback function. More...
 
void unregisterCallback (size_t id)
 Unregisters a previously registered callback function whith the specified id. More...
 
void unregisterAllCallbacks ()
 Unregisters all callback functions. More...
 
void forwardStatusUpdateCalls (StatusProvider *other=nullptr)
 Forwards all status updates calls to the specified statusProvider. More...
 
StatusProviderusedProvider ()
 Returns the provider which callback functions will be called when the status or the percentage is updated. More...
 
void tryToAbort ()
 Commands the object to abort the current operation. More...
 
bool isAborted () const
 Returns an indication whether the current operation should be aborted. More...
 
void invalidateStatus ()
 Invalidates the current status. More...
 
void invalidateNotifications ()
 Invalidates the object's notifications. More...
 
void updateStatus (const std::string &status)
 This method is meant to be called by the derived class to report updated status information. More...
 
void updateStatus (const std::string &status, double percentage)
 This method is meant to be called by the derived class to report updated status information. More...
 
void updatePercentage (double percentage)
 This method is meant to be called by the derived class to report updated progress percentage only. More...
 
void addNotification (const Notification &notification)
 This method is meant to be called by the derived class to add a notification. More...
 
void addNotification (NotificationType type, const std::string &message, const std::string &context)
 This method is meant to be called by the derived class to add a notification of the specified type, message and context. More...
 
void addNotifications (const StatusProvider &from)
 This method is meant to be called by the derived class to add all notifications from another StatusProvider instance. More...
 
void addNotifications (const std::string &higherContext, const StatusProvider &from)
 This method is meant to be called by the derived class to add all notifications from another StatusProvider instance. More...
 
void addNotifications (const NotificationList &notifications)
 This method is meant to be called by the derived class to add the specified notifications. More...
 

Additional Inherited Members

- Public Types inherited from Media::StatusProvider
typedef std::function< void(StatusProvider &sender)> CallbackFunction
 
typedef std::vector< CallbackFunctionCallbackVector
 
typedef std::pair< int, CallbackFunctionCallbackPair
 
- Protected Member Functions inherited from Media::StatusProvider
 StatusProvider ()
 Constructs a new StatusProvider. More...
 

Detailed Description

The MatroskaEditionEntry class provides a parser for edition entries in Matroska files.

Definition at line 10 of file matroskaeditionentry.h.

Constructor & Destructor Documentation

◆ MatroskaEditionEntry()

Media::MatroskaEditionEntry::MatroskaEditionEntry ( EbmlElement editionEntryElement)

Constructs a new MatroskaEditionEntry for the specified editionEntryElement.

Definition at line 24 of file matroskaeditionentry.cpp.

◆ ~MatroskaEditionEntry()

Media::MatroskaEditionEntry::~MatroskaEditionEntry ( )

Destroys the MatroskaEditionEntry.

Definition at line 35 of file matroskaeditionentry.cpp.

Member Function Documentation

◆ chapters()

const std::vector< std::unique_ptr< MatroskaChapter > > & Media::MatroskaEditionEntry::chapters ( ) const
inline

Returns the chapters the edition contains.

Definition at line 80 of file matroskaeditionentry.h.

◆ clear()

void Media::MatroskaEditionEntry::clear ( )

Resets the object to its initial state.

Definition at line 103 of file matroskaeditionentry.cpp.

◆ editionEntryElement()

EbmlElement * Media::MatroskaEditionEntry::editionEntryElement ( ) const
inline

Returns the "EditionEntry"-element specified when constructing the object.

Definition at line 40 of file matroskaeditionentry.h.

◆ id()

uint64 Media::MatroskaEditionEntry::id ( ) const
inline

Returns the edition ID.

Definition at line 48 of file matroskaeditionentry.h.

◆ isDefault()

bool Media::MatroskaEditionEntry::isDefault ( ) const
inline

Returns whether the edition is flagged as default edition.

Definition at line 64 of file matroskaeditionentry.h.

◆ isHidden()

bool Media::MatroskaEditionEntry::isHidden ( ) const
inline

Returns whether the edition is hidden.

Definition at line 56 of file matroskaeditionentry.h.

◆ isOrdered()

bool Media::MatroskaEditionEntry::isOrdered ( ) const
inline

Returns whether the edition is ordered.

Definition at line 72 of file matroskaeditionentry.h.

◆ label()

string Media::MatroskaEditionEntry::label ( ) const

Returns a label for the entry.

Definition at line 41 of file matroskaeditionentry.cpp.

◆ parse()

void Media::MatroskaEditionEntry::parse ( )

Parses the "EditionEntry"-element specified when constructing the object.

Fetches the chapters() but does not parse them.

Clears all previous parsing results.

Definition at line 53 of file matroskaeditionentry.cpp.

◆ parseNested()

void Media::MatroskaEditionEntry::parseNested ( )

Parses the "EditionEntry"-element specified when constructing the object.

Remarks
  • Parses also fetched chapters and nested chapters.
  • Clears all previous parsing results.

Definition at line 92 of file matroskaeditionentry.cpp.


The documentation for this class was generated from the following files: