Miam-Player  0.8.0
A nice music player
TagLib::Vorbis::Properties Class Reference

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

#include <vorbisproperties.h>

Inheritance diagram for TagLib::Vorbis::Properties:
TagLib::AudioProperties

Public Member Functions

 Properties (File *file, ReadStyle style=Average)
 Create an instance of Vorbis::Properties with the data read from the Vorbis::File file. More...
 
virtual ~Properties ()
 Destroys this VorbisProperties instance. More...
 
virtual int length () const
 Returns the length of the file in seconds. More...
 
int lengthInSeconds () const
 Returns the length of the file in seconds. More...
 
int lengthInMilliseconds () const
 Returns the length of the file in milliseconds. More...
 
virtual int bitrate () const
 Returns the average bit rate of the file in kb/s. More...
 
virtual int sampleRate () const
 Returns the sample rate in Hz. More...
 
virtual int channels () const
 Returns the number of audio channels. More...
 
int vorbisVersion () const
 Returns the Vorbis version, currently "0" (as specified by the spec). More...
 
int bitrateMaximum () const
 Returns the maximum bitrate as read from the Vorbis identification header. More...
 
int bitrateNominal () const
 Returns the nominal bitrate as read from the Vorbis identification header. More...
 
int bitrateMinimum () const
 Returns the minimum bitrate as read from the Vorbis identification header. More...
 
- Public Member Functions inherited from TagLib::AudioProperties
virtual ~AudioProperties ()
 Destroys this AudioProperties instance. More...
 
int lengthInSeconds () const
 Returns the length of the file in seconds. More...
 
int lengthInMilliseconds () const
 Returns the length of the file in milliseconds. More...
 

Additional Inherited Members

- Public Types inherited from TagLib::AudioProperties
enum  ReadStyle { Fast, Average, Accurate }
 Reading audio properties from a file can sometimes be very time consuming and for the most accurate results can often involve reading the entire file. More...
 
- Protected Member Functions inherited from TagLib::AudioProperties
 AudioProperties (ReadStyle style)
 Construct an audio properties instance. More...
 

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

◆ Properties()

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

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

◆ ~Properties()

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

Destroys this VorbisProperties instance.

Member Function Documentation

◆ bitrate()

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

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

Implements TagLib::AudioProperties.

◆ bitrateMaximum()

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

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

◆ bitrateMinimum()

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

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

◆ bitrateNominal()

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

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

◆ channels()

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

Returns the number of audio channels.

Implements TagLib::AudioProperties.

◆ length()

virtual int TagLib::Vorbis::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().
Deprecated:

Implements TagLib::AudioProperties.

◆ lengthInMilliseconds()

int TagLib::Vorbis::Properties::lengthInMilliseconds ( ) const

Returns the length of the file in milliseconds.

See also
lengthInSeconds()

◆ lengthInSeconds()

int TagLib::Vorbis::Properties::lengthInSeconds ( ) const

Returns the length of the file in seconds.

The length is rounded down to the nearest whole second.

See also
lengthInMilliseconds()

◆ sampleRate()

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

Returns the sample rate in Hz.

Implements TagLib::AudioProperties.

◆ vorbisVersion()

int TagLib::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: