Miam-Player  0.8.0
A nice music player
TagLib::RIFF::WAV::Properties Class Reference

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

#include <wavproperties.h>

Inheritance diagram for TagLib::RIFF::WAV::Properties:
TagLib::AudioProperties

Public Member Functions

 Properties (const ByteVector &data, ReadStyle style)
 Create an instance of WAV::Properties with the data read from the ByteVector data. More...
 
 Properties (const ByteVector &data, unsigned int streamLength, ReadStyle style)
 Create an instance of WAV::Properties with the data read from the ByteVector data and the length calculated using streamLength. More...
 
 Properties (File *file, ReadStyle style)
 Create an instance of WAV::Properties with the data read from the WAV::File file. More...
 
virtual ~Properties ()
 Destroys this WAV::Properties instance. More...
 
virtual int length () const
 Returns the length of the file in seconds. More...
 
int lengthInSeconds () const
 Returns the length of the file in seconds. More...
 
int lengthInMilliseconds () const
 Returns the length of the file in milliseconds. More...
 
virtual int bitrate () const
 Returns the average bit rate of the file in kb/s. More...
 
virtual int sampleRate () const
 Returns the sample rate in Hz. More...
 
virtual int channels () const
 Returns the number of audio channels. More...
 
int bitsPerSample () const
 Returns the number of bits per audio sample. More...
 
int sampleWidth () const
 Returns the number of bits per audio sample. More...
 
unsigned int sampleFrames () const
 Returns the number of sample frames. More...
 
int format () const
 Returns the format ID of the file. More...
 
- Public Member Functions inherited from TagLib::AudioProperties
virtual ~AudioProperties ()
 Destroys this AudioProperties instance. More...
 
int lengthInSeconds () const
 Returns the length of the file in seconds. More...
 
int lengthInMilliseconds () const
 Returns the length of the file in milliseconds. More...
 

Additional Inherited Members

- Public Types inherited from TagLib::AudioProperties
enum  ReadStyle { Fast, Average, Accurate }
 Reading audio properties from a file can sometimes be very time consuming and for the most accurate results can often involve reading the entire file. More...
 
- Protected Member Functions inherited from TagLib::AudioProperties
 AudioProperties (ReadStyle style)
 Construct an audio properties instance. More...
 

Detailed Description

An implementation of audio property reading for WAV.

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

Constructor & Destructor Documentation

◆ Properties() [1/3]

TagLib::RIFF::WAV::Properties::Properties ( const ByteVector data,
ReadStyle  style 
)

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

Deprecated:

◆ Properties() [2/3]

TagLib::RIFF::WAV::Properties::Properties ( const ByteVector data,
unsigned int  streamLength,
ReadStyle  style 
)

Create an instance of WAV::Properties with the data read from the ByteVector data and the length calculated using streamLength.

Deprecated:

◆ Properties() [3/3]

TagLib::RIFF::WAV::Properties::Properties ( File file,
ReadStyle  style 
)

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

◆ ~Properties()

virtual TagLib::RIFF::WAV::Properties::~Properties ( )
virtual

Destroys this WAV::Properties instance.

Member Function Documentation

◆ bitrate()

virtual int TagLib::RIFF::WAV::Properties::bitrate ( ) const
virtual

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

Implements TagLib::AudioProperties.

◆ bitsPerSample()

int TagLib::RIFF::WAV::Properties::bitsPerSample ( ) const

Returns the number of bits per audio sample.

◆ channels()

virtual int TagLib::RIFF::WAV::Properties::channels ( ) const
virtual

Returns the number of audio channels.

Implements TagLib::AudioProperties.

◆ format()

int TagLib::RIFF::WAV::Properties::format ( ) const

Returns the format ID of the file.

0 for unknown, 1 for PCM, 2 for ADPCM, 3 for 32/64-bit IEEE754, and so forth.

Note
For further information, refer to the WAVE Form Registration Numbers in RFC 2361.

◆ length()

virtual int TagLib::RIFF::WAV::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:

Implements TagLib::AudioProperties.

◆ lengthInMilliseconds()

int TagLib::RIFF::WAV::Properties::lengthInMilliseconds ( ) const

Returns the length of the file in milliseconds.

See also
lengthInSeconds()

◆ lengthInSeconds()

int TagLib::RIFF::WAV::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::RIFF::WAV::Properties::sampleFrames ( ) const

Returns the number of sample frames.

◆ sampleRate()

virtual int TagLib::RIFF::WAV::Properties::sampleRate ( ) const
virtual

Returns the sample rate in Hz.

Implements TagLib::AudioProperties.

◆ sampleWidth()

int TagLib::RIFF::WAV::Properties::sampleWidth ( ) const

Returns the number of bits per audio sample.

Note
This method is just an alias of bitsPerSample().
Deprecated:

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