TagLib::Ogg::Opus::Properties Class Reference

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

#include <opusproperties.h>

Inheritance diagram for TagLib::Ogg::Opus::Properties:
Collaboration diagram for TagLib::Ogg::Opus::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 inputSampleRate () const
int opusVersion () 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 Opus.

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

Constructor & Destructor Documentation

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

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

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

Destroys this Opus::Properties instance.

Member Function Documentation

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

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

Returns the number of audio channels.

Implements TagLib::AudioProperties.

int TagLib::Ogg::Opus::Properties::inputSampleRate ( ) const

The Opus codec supports decoding at multiple sample rates, there is no single sample rate of the encoded stream. This returns the sample rate of the original audio stream.

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

Returns the length of the file in seconds.

Implements TagLib::AudioProperties.

int TagLib::Ogg::Opus::Properties::opusVersion ( ) const

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

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

Returns the sample rate in Hz.

Implements TagLib::AudioProperties.


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