TagLib  2.1
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:
[legend]
Collaboration diagram for TagLib::Ogg::Opus::Properties:
[legend]

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

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

◆ Properties() [1/2]

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.

References TagLib::AudioProperties::Average.

Referenced by operator=(), and Properties().

◆ ~Properties()

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

Destroys this Opus::Properties instance.

◆ Properties() [2/2]

TagLib::Ogg::Opus::Properties::Properties ( const Properties & )
delete

References Properties().

Member Function Documentation

◆ bitrate()

int TagLib::Ogg::Opus::Properties::bitrate ( ) const
overridevirtual

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

Reimplemented from TagLib::AudioProperties.

◆ channels()

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

Returns the number of audio channels.

Implements TagLib::AudioProperties.

◆ inputSampleRate()

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.

◆ lengthInMilliseconds()

int TagLib::Ogg::Opus::Properties::lengthInMilliseconds ( ) const
overridevirtual

Returns the length of the file in milliseconds.

See also
lengthInSeconds()

Reimplemented from TagLib::AudioProperties.

◆ operator=()

Properties & TagLib::Ogg::Opus::Properties::operator= ( const Properties & )
delete

References Properties().

◆ opusVersion()

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

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

References TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE.

◆ sampleRate()

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

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,

Reimplemented from TagLib::AudioProperties.


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