TagLib  1.13.1
TagLib::WavPack::Properties Class Reference

An implementation of audio property reading for WavPack. More...

#include <wavpackproperties.h>

Inheritance diagram for TagLib::WavPack::Properties:
[legend]
Collaboration diagram for TagLib::WavPack::Properties:
[legend]

Public Member Functions

TAGLIB_DEPRECATED Properties (const ByteVector &data, long streamLength, ReadStyle style=Average)
 
 Properties (File *file, long streamLength, ReadStyle style=Average)
 
virtual ~Properties ()
 
virtual TAGLIB_DEPRECATED int length () const
 
int lengthInSeconds () const
 
int lengthInMilliseconds () const
 
virtual int bitrate () const
 
virtual int sampleRate () const
 
virtual int channels () const
 
int bitsPerSample () const
 
bool isLossless () const
 
unsigned int sampleFrames () const
 
int version () const
 
- Public Member Functions inherited from TagLib::AudioProperties
virtual ~AudioProperties ()
 
int lengthInSeconds () const
 
int lengthInMilliseconds () 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 WavPack.

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

Constructor & Destructor Documentation

◆ Properties() [1/2]

TAGLIB_DEPRECATED TagLib::WavPack::Properties::Properties ( const ByteVector & data,
long streamLength,
ReadStyle style = Average )

Create an instance of WavPack::Properties with the data read from the ByteVector data.

Deprecated
This constructor will be dropped in favor of the one below in a future version.

References TagLib::AudioProperties::Average, and TAGLIB_DEPRECATED.

Referenced by version().

◆ Properties() [2/2]

TagLib::WavPack::Properties::Properties ( File * file,
long streamLength,
ReadStyle style = Average )

Create an instance of WavPack::Properties.

References TagLib::AudioProperties::Average.

◆ ~Properties()

virtual TagLib::WavPack::Properties::~Properties ( )
virtual

Destroys this WavPack::Properties instance.

Member Function Documentation

◆ bitrate()

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

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

Implements TagLib::AudioProperties.

◆ bitsPerSample()

int TagLib::WavPack::Properties::bitsPerSample ( ) const

Returns the number of bits per audio sample.

◆ channels()

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

Returns the number of audio channels.

Implements TagLib::AudioProperties.

◆ isLossless()

bool TagLib::WavPack::Properties::isLossless ( ) const

Returns whether or not the file is lossless encoded.

◆ length()

virtual TAGLIB_DEPRECATED int TagLib::WavPack::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
Use lengthInSeconds().

Implements TagLib::AudioProperties.

References TAGLIB_DEPRECATED.

◆ lengthInMilliseconds()

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

Returns the length of the file in milliseconds.

See also
lengthInSeconds()

◆ lengthInSeconds()

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

Returns the length of the file in seconds. The length is rounded down to the nearest whole second.

See also
lengthInMilliseconds()

◆ sampleFrames()

unsigned int TagLib::WavPack::Properties::sampleFrames ( ) const

Returns the total number of audio samples in file.

◆ sampleRate()

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

Returns the sample rate in Hz. 0 means unknown or custom.

Implements TagLib::AudioProperties.

◆ version()

int TagLib::WavPack::Properties::version ( ) const

Returns WavPack version.

References Properties().


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