TagLib API Documentation
Public Member Functions | List of all members
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)
 ~Properties () override
 Properties (const Properties &)=delete
Propertiesoperator= (const Properties &)=delete
int lengthInMilliseconds () const override
int bitrate () const override
int sampleRate () const override
int channels () const override
int vorbisVersion () const
int bitrateMaximum () const
int bitrateNominal () const
int bitrateMinimum () const
- Public Member Functions inherited from TagLib::AudioProperties
virtual ~AudioProperties ()
 AudioProperties (const AudioProperties &)=delete
AudioPropertiesoperator= (const AudioProperties &)=delete
virtual TAGLIB_DEPRECATED int length () const
virtual int lengthInSeconds () const
virtual int lengthInMilliseconds () const
virtual int bitrate () const
virtual int sampleRate () const
virtual int channels () const =0

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

◆ Properties() [1/2]

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.

◆ ~Properties()

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

Destroys this VorbisProperties instance.

◆ Properties() [2/2]

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

Member Function Documentation

◆ bitrate()

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

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

Reimplemented from TagLib::AudioProperties.

◆ bitrateMaximum()

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

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

◆ bitrateMinimum()

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

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

◆ bitrateNominal()

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

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

◆ channels()

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

Returns the number of audio channels.

Implements TagLib::AudioProperties.

◆ lengthInMilliseconds()

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

Returns the length of the file in milliseconds.

See also

Reimplemented from TagLib::AudioProperties.

◆ operator=()

Properties & TagLib::Ogg::Vorbis::Properties::operator= ( const Properties )

◆ sampleRate()

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

Returns the sample rate in Hz.

Reimplemented from TagLib::AudioProperties.

◆ vorbisVersion()

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: