TagLib 1.11 (TagLib: TagLib::Ogg::Speex::Properties Class Reference)

TagLib::Ogg::Speex::Properties Class Reference

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

#include <speexproperties.h>

Inheritance diagram for TagLib::Ogg::Speex::Properties:
Collaboration diagram for TagLib::Ogg::Speex::Properties:

List of all members.

Public Member Functions

 Properties (File *file, ReadStyle style=Average)
virtual ~Properties ()
virtual int length () const
int lengthInSeconds () const
int lengthInMilliseconds () const
virtual int bitrate () const
int bitrateNominal () const
virtual int sampleRate () const
virtual int channels () const
int speexVersion () const


Detailed Description

An implementation of audio property reading for Ogg Speex.

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


Constructor & Destructor Documentation

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

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

virtual TagLib::Ogg::Speex::Properties::~Properties (  )  [virtual]

Destroys this Speex::Properties instance.


Member Function Documentation

virtual int TagLib::Ogg::Speex::Properties::length (  )  const [virtual]

Returns the length of the file in seconds. The length is rounded down to the nearest whole second.

Note:
This method is just an alias of lengthInSeconds().

Implements TagLib::AudioProperties.

int TagLib::Ogg::Speex::Properties::lengthInSeconds (  )  const

Returns the length of the file in seconds. The length is rounded down to the nearest whole second.

See also:
lengthInMilliseconds()

Reimplemented from TagLib::AudioProperties.

int TagLib::Ogg::Speex::Properties::lengthInMilliseconds (  )  const

Returns the length of the file in milliseconds.

See also:
lengthInSeconds()

Reimplemented from TagLib::AudioProperties.

virtual int TagLib::Ogg::Speex::Properties::bitrate (  )  const [virtual]

Returns the average bit rate of the file in kb/s.

Implements TagLib::AudioProperties.

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

Returns the nominal bit rate as read from the Speex header in kb/s.

virtual int TagLib::Ogg::Speex::Properties::sampleRate (  )  const [virtual]

Returns the sample rate in Hz.

Implements TagLib::AudioProperties.

virtual int TagLib::Ogg::Speex::Properties::channels (  )  const [virtual]

Returns the number of audio channels.

Implements TagLib::AudioProperties.

int TagLib::Ogg::Speex::Properties::speexVersion (  )  const

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


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