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

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:

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
virtual int sampleRate () const
virtual int channels () const
int inputSampleRate () const
int opusVersion () const

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 average bit rate of the file in kb/s.

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. 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::Opus::Properties::lengthInMilliseconds ( ) const

Returns the length of the file in milliseconds.

See also:
lengthInSeconds()

Reimplemented from TagLib::AudioProperties.

int TagLib::Ogg::Opus::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::Opus::Properties::opusVersion ( ) const

Returns the Opus version, in the range 0...255.

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

Returns the sample rate in Hz.

Note:
Always returns 48000, because Opus can decode any stream at a sample rate of 8, 12, 16, 24, or 48 kHz,

Implements TagLib::AudioProperties.


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