TagLib::MPEG::Properties Class Reference

An implementation of audio property reading for MP3. More...

#include <mpegproperties.h>

Inheritance diagram for TagLib::MPEG::Properties:
Collaboration diagram for TagLib::MPEG::Properties:

Public Member Functions

 Properties (File *file, ReadStyle style=Average)
virtual ~Properties ()
virtual int length () const
virtual int bitrate () const
virtual int sampleRate () const
virtual int channels () const
const XingHeaderxingHeader () const
Header::Version version () const
int layer () const
bool protectionEnabled () const
Header::ChannelMode channelMode () const
bool isCopyrighted () const
bool isOriginal () const
- Public Member Functions inherited from TagLib::AudioProperties
virtual ~AudioProperties ()

Additional Inherited Members

- Public Types inherited from TagLib::AudioProperties
enum  ReadStyle { Fast, Average, Accurate }
- Protected Member Functions inherited from TagLib::AudioProperties
 AudioProperties (ReadStyle style)

Detailed Description

An implementation of audio property reading for MP3.

This reads the data from an MPEG Layer III stream found in the AudioProperties API.

Constructor & Destructor Documentation

TagLib::MPEG::Properties::Properties ( File file,
ReadStyle  style = Average 
)

Create an instance of MPEG::Properties with the data read from the MPEG::File file.

virtual TagLib::MPEG::Properties::~Properties ( )
virtual

Destroys this MPEG Properties instance.

Member Function Documentation

virtual int TagLib::MPEG::Properties::bitrate ( ) const
virtual

Returns the most appropriate bit rate for the file in kb/s. For constant bitrate formats this is simply the bitrate of the file. For variable bitrate formats this is either the average or nominal bitrate.

Implements TagLib::AudioProperties.

Header::ChannelMode TagLib::MPEG::Properties::channelMode ( ) const

Returns the channel mode for this frame.

virtual int TagLib::MPEG::Properties::channels ( ) const
virtual

Returns the number of audio channels.

Implements TagLib::AudioProperties.

bool TagLib::MPEG::Properties::isCopyrighted ( ) const

Returns true if the copyrighted bit is set.

bool TagLib::MPEG::Properties::isOriginal ( ) const

Returns true if the "original" bit is set.

int TagLib::MPEG::Properties::layer ( ) const

Returns the layer version. This will be between the values 1-3.

virtual int TagLib::MPEG::Properties::length ( ) const
virtual

Returns the length of the file in seconds.

Implements TagLib::AudioProperties.

bool TagLib::MPEG::Properties::protectionEnabled ( ) const

Returns true if the MPEG protection bit is enabled.

virtual int TagLib::MPEG::Properties::sampleRate ( ) const
virtual

Returns the sample rate in Hz.

Implements TagLib::AudioProperties.

Header::Version TagLib::MPEG::Properties::version ( ) const

Returns the MPEG Version of the file.

const XingHeader* TagLib::MPEG::Properties::xingHeader ( ) const

Returns a pointer to the XingHeader if one exists or null if no XingHeader was found.


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