TagLib::Ogg::Vorbis::Properties Class Reference

An implementation of audio property reading for Ogg Vorbis. More...

#include <vorbisproperties.h>

Inheritance diagram for TagLib::Ogg::Vorbis::Properties:
Collaboration diagram for TagLib::Ogg::Vorbis::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
int vorbisVersion () const
int bitrateMaximum () const
int bitrateNominal () const
int bitrateMinimum () 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 Ogg Vorbis.

This reads the data from an Ogg Vorbis stream found in the AudioProperties API.

Constructor & Destructor Documentation

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

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

virtual TagLib::Ogg::Vorbis::Properties::~Properties ( )
virtual

Destroys this VorbisProperties instance.

Member Function Documentation

virtual int TagLib::Ogg::Vorbis::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.

int TagLib::Ogg::Vorbis::Properties::bitrateMaximum ( ) const

Returns the maximum bitrate as read from the Vorbis identification header.

int TagLib::Ogg::Vorbis::Properties::bitrateMinimum ( ) const

Returns the minimum bitrate as read from the Vorbis identification header.

int TagLib::Ogg::Vorbis::Properties::bitrateNominal ( ) const

Returns the nominal bitrate as read from the Vorbis identification header.

virtual int TagLib::Ogg::Vorbis::Properties::channels ( ) const
virtual

Returns the number of audio channels.

Implements TagLib::AudioProperties.

virtual int TagLib::Ogg::Vorbis::Properties::length ( ) const
virtual

Returns the length of the file in seconds.

Implements TagLib::AudioProperties.

virtual int TagLib::Ogg::Vorbis::Properties::sampleRate ( ) const
virtual

Returns the sample rate in Hz.

Implements TagLib::AudioProperties.

int TagLib::Ogg::Vorbis::Properties::vorbisVersion ( ) const

Returns the Vorbis version, currently "0" (as specified by the spec).


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