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

The MediaFormat class specifies the format of media data. More...

#include <mediaformat.h>

Public Member Functions

 MediaFormat (GeneralMediaFormat general=GeneralMediaFormat::Unknown, unsigned char sub=0, unsigned char extension=0)
 Constructs a new media format. More...
 
const char * name () const
 Returns the name of the media format as C-style string. More...
 
const char * abbreviation () const
 Returns the abbreviation of the media format as C-style string. More...
 
const char * extensionName () const
 Returns the abbreviation of the media format as C-style string. More...
 
 operator bool () const
 Returns whether the media format is known. More...
 
MediaFormatoperator+= (const MediaFormat &other)
 "Adds" information from another instance to the object. More...
 
bool operator== (GeneralMediaFormat general) const
 Returns whether the media format is the specified general media format. More...
 
bool operator!= (GeneralMediaFormat general) const
 Returns whether the media format is not the specified general media format. More...
 

Public Attributes

GeneralMediaFormat general
 
unsigned char sub
 
unsigned char extension
 

Detailed Description

The MediaFormat class specifies the format of media data.

Definition at line 257 of file mediaformat.h.

Constructor & Destructor Documentation

◆ MediaFormat()

Media::MediaFormat::MediaFormat ( GeneralMediaFormat  general = GeneralMediaFormat::Unknown,
unsigned char  sub = 0,
unsigned char  extension = 0 
)
inline

Constructs a new media format.

Definition at line 278 of file mediaformat.h.

Member Function Documentation

◆ abbreviation()

const char * Media::MediaFormat::abbreviation ( ) const

Returns the abbreviation of the media format as C-style string.

Returns an empty string if no abbreviation is available.

Definition at line 254 of file mediaformat.cpp.

◆ extensionName()

const char * Media::MediaFormat::extensionName ( ) const

Returns the abbreviation of the media format as C-style string.

Returns an empty string if no abbreviation is available.

Definition at line 424 of file mediaformat.cpp.

◆ name()

const char * Media::MediaFormat::name ( ) const

Returns the name of the media format as C-style string.

Returns an empty string if no name is available.

Definition at line 17 of file mediaformat.cpp.

◆ operator bool()

Media::MediaFormat::operator bool ( ) const
inline

Returns whether the media format is known.

Definition at line 320 of file mediaformat.h.

◆ operator!=()

bool Media::MediaFormat::operator!= ( GeneralMediaFormat  general) const
inline

Returns whether the media format is not the specified general media format.

Definition at line 312 of file mediaformat.h.

◆ operator+=()

MediaFormat & Media::MediaFormat::operator+= ( const MediaFormat other)
inline

"Adds" information from another instance to the object.

Definition at line 287 of file mediaformat.h.

◆ operator==()

bool Media::MediaFormat::operator== ( GeneralMediaFormat  general) const
inline

Returns whether the media format is the specified general media format.

Definition at line 304 of file mediaformat.h.

Member Data Documentation

◆ extension

unsigned char Media::MediaFormat::extension

Definition at line 272 of file mediaformat.h.

◆ general

GeneralMediaFormat Media::MediaFormat::general

Definition at line 270 of file mediaformat.h.

◆ sub

unsigned char Media::MediaFormat::sub

Definition at line 271 of file mediaformat.h.


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