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

#include <mpegaudioframe.h>

Public Member Functions

 MpegAudioFrame ()
 Constructs a new frame. More...
 
void parseHeader (IoUtilities::BinaryReader &reader)
 Parses the header read using the specified reader. More...
 
bool isValid () const
 Returns an indication whether the frame is valid. More...
 
double mpegVersion () const
 Returns the MPEG version if known (1.0, 2.0 or 2.5); otherwise returns 0. More...
 
int layer () const
 Returns the MPEG layer if known (1, 2, or 3); otherwise returns 0. More...
 
bool isProtectedByCrc () const
 Returns an indication whether the frame is protected by CRC. More...
 
uint32 bitrate () const
 Returns the bitrate of the frame if known; otherwise returns 0. More...
 
uint32 samplingFrequency () const
 Returns the sampeling frequency of the frame if known; otherwise returns 0. More...
 
uint32 paddingSize () const
 Returns the padding size if known; otherwise returns 0. More...
 
MpegChannelMode channelMode () const
 Returns the channel mode if known; otherwise returns MpegChannelMode::Unspecifed. More...
 
bool hasCopyright () const
 Returns an indication whether the frame is copyrighted. More...
 
bool isOriginal () const
 Returns an indication whether the frame labeled as original. More...
 
uint32 sampleCount () const
 Returns the sample count if known; otherwise returns 0. More...
 
uint32 size () const
 Returns the size if known; otherwise retruns 0. More...
 
bool isXingHeaderAvailable () const
 Returns an indication whether a Xing header is present. More...
 
XingHeaderFlags xingHeaderFlags () const
 Returns the Xing header flags. More...
 
bool isXingFramefieldPresent () const
 Returns an indication whether the Xing frame field is present. More...
 
bool isXingBytesfieldPresent () const
 Returns an indication whether the Xing bytes field is present. More...
 
bool isXingTocFieldPresent () const
 Returns an indication whether the Xing TOC is present. More...
 
bool isXingQualityIndicatorFieldPresent () const
 Returns an indication whether the Xing quality indicator field is present. More...
 
uint32 xingFrameCount () const
 Returns an indication whether the Xing frame count is present. More...
 
uint32 xingBytesfield () const
 Returns the Xing bytes field if known; otherwise returns 0. More...
 
uint32 xingQualityIndicator () const
 Returns the Xing quality indicator if known; otherwise returns 0. More...
 

Detailed Description

Definition at line 37 of file mpegaudioframe.h.

Constructor & Destructor Documentation

◆ MpegAudioFrame()

TagParser::MpegAudioFrame::MpegAudioFrame ( )
inline

Constructs a new frame.

Definition at line 80 of file mpegaudioframe.h.

Member Function Documentation

◆ bitrate()

uint32 TagParser::MpegAudioFrame::bitrate ( ) const
inline

Returns the bitrate of the frame if known; otherwise returns 0.

Definition at line 109 of file mpegaudioframe.h.

◆ channelMode()

MpegChannelMode TagParser::MpegAudioFrame::channelMode ( ) const

Returns the channel mode if known; otherwise returns MpegChannelMode::Unspecifed.

Definition at line 155 of file mpegaudioframe.cpp.

◆ hasCopyright()

bool TagParser::MpegAudioFrame::hasCopyright ( ) const
inline

Returns an indication whether the frame is copyrighted.

Definition at line 132 of file mpegaudioframe.h.

◆ isOriginal()

bool TagParser::MpegAudioFrame::isOriginal ( ) const
inline

Returns an indication whether the frame labeled as original.

Definition at line 140 of file mpegaudioframe.h.

◆ isProtectedByCrc()

bool TagParser::MpegAudioFrame::isProtectedByCrc ( ) const
inline

Returns an indication whether the frame is protected by CRC.

Definition at line 101 of file mpegaudioframe.h.

◆ isValid()

bool TagParser::MpegAudioFrame::isValid ( ) const
inline

Returns an indication whether the frame is valid.

Definition at line 93 of file mpegaudioframe.h.

◆ isXingBytesfieldPresent()

bool TagParser::MpegAudioFrame::isXingBytesfieldPresent ( ) const
inline

Returns an indication whether the Xing bytes field is present.

Definition at line 182 of file mpegaudioframe.h.

◆ isXingFramefieldPresent()

bool TagParser::MpegAudioFrame::isXingFramefieldPresent ( ) const
inline

Returns an indication whether the Xing frame field is present.

Definition at line 174 of file mpegaudioframe.h.

◆ isXingHeaderAvailable()

bool TagParser::MpegAudioFrame::isXingHeaderAvailable ( ) const
inline

Returns an indication whether a Xing header is present.

Definition at line 158 of file mpegaudioframe.h.

◆ isXingQualityIndicatorFieldPresent()

bool TagParser::MpegAudioFrame::isXingQualityIndicatorFieldPresent ( ) const
inline

Returns an indication whether the Xing quality indicator field is present.

Definition at line 198 of file mpegaudioframe.h.

◆ isXingTocFieldPresent()

bool TagParser::MpegAudioFrame::isXingTocFieldPresent ( ) const
inline

Returns an indication whether the Xing TOC is present.

Definition at line 190 of file mpegaudioframe.h.

◆ layer()

int TagParser::MpegAudioFrame::layer ( ) const

Returns the MPEG layer if known (1, 2, or 3); otherwise returns 0.

Definition at line 96 of file mpegaudioframe.cpp.

◆ mpegVersion()

double TagParser::MpegAudioFrame::mpegVersion ( ) const

Returns the MPEG version if known (1.0, 2.0 or 2.5); otherwise returns 0.

Definition at line 79 of file mpegaudioframe.cpp.

◆ paddingSize()

uint32 TagParser::MpegAudioFrame::paddingSize ( ) const
inline

Returns the padding size if known; otherwise returns 0.

Definition at line 120 of file mpegaudioframe.h.

◆ parseHeader()

void TagParser::MpegAudioFrame::parseHeader ( IoUtilities::BinaryReader &  reader)

Parses the header read using the specified reader.

Exceptions
ThrowsInvalidDataException if the data read from the stream is no valid frame header.

Definition at line 51 of file mpegaudioframe.cpp.

◆ sampleCount()

uint32 TagParser::MpegAudioFrame::sampleCount ( ) const

Returns the sample count if known; otherwise returns 0.

Definition at line 176 of file mpegaudioframe.cpp.

◆ samplingFrequency()

uint32 TagParser::MpegAudioFrame::samplingFrequency ( ) const

Returns the sampeling frequency of the frame if known; otherwise returns 0.

Definition at line 113 of file mpegaudioframe.cpp.

◆ size()

uint32 TagParser::MpegAudioFrame::size ( ) const

Returns the size if known; otherwise retruns 0.

Definition at line 199 of file mpegaudioframe.cpp.

◆ xingBytesfield()

uint32 TagParser::MpegAudioFrame::xingBytesfield ( ) const
inline

Returns the Xing bytes field if known; otherwise returns 0.

Definition at line 214 of file mpegaudioframe.h.

◆ xingFrameCount()

uint32 TagParser::MpegAudioFrame::xingFrameCount ( ) const
inline

Returns an indication whether the Xing frame count is present.

Definition at line 206 of file mpegaudioframe.h.

◆ xingHeaderFlags()

XingHeaderFlags TagParser::MpegAudioFrame::xingHeaderFlags ( ) const
inline

Returns the Xing header flags.

Definition at line 166 of file mpegaudioframe.h.

◆ xingQualityIndicator()

uint32 TagParser::MpegAudioFrame::xingQualityIndicator ( ) const
inline

Returns the Xing quality indicator if known; otherwise returns 0.

Definition at line 222 of file mpegaudioframe.h.


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