Home · All Classes · Modules

QAudioFormat Class Reference
^{^{[QtMultimedia module]}}

The QAudioFormat class stores audio parameter information. More...

Types

enum Endian { BigEndian, LittleEndian }
enum SampleType { Unknown, SignedInt, UnSignedInt, Float }

Methods

__init__ (self)
__init__ (self, QAudioFormat other)
Endian byteOrder (self)
int channelCount (self)
int channels (self)
QString codec (self)
int frequency (self)
bool isValid (self)
int sampleRate (self)
int sampleSize (self)
SampleType sampleType (self)
setByteOrder (self, Endian byteOrder)
setChannelCount (self, int channelCount)
setChannels (self, int channels)
setCodec (self, QString codec)
setFrequency (self, int frequency)
setSampleRate (self, int sampleRate)
setSampleSize (self, int sampleSize)
setSampleType (self, SampleType sampleType)

Special Methods

bool __eq__ (self, QAudioFormat other)
bool __ne__ (self, QAudioFormat other)

Detailed Description

The QAudioFormat class stores audio parameter information.

An audio format specifies how data in an audio stream is arranged, i.e, how the stream is to be interpreted. The encoding itself is specified by the codec() used for the stream.

In addition to the encoding, QAudioFormat contains other parameters that further specify how the audio data is arranged. These are the frequency, the number of channels, the sample size, the sample type, and the byte order. The following table describes these in more detail.

Parameter	Description
Sample Rate	Samples per second of audio data in Hertz.
Number of channels	The number of audio channels (typically one for mono or two for stereo)
Sample size	How much data is stored in each sample (typically 8 or 16 bits)
Sample type	Numerical representation of sample (typically signed integer, unsigned integer or float)
Byte order	Byte ordering of sample (typically little endian, big endian)

You can obtain audio formats compatible with the audio device used through functions in QAudioDeviceInfo. This class also lets you query available parameter values for a device, so that you can set the parameters yourself. See the QAudioDeviceInfo class description for details. You need to know the format of the audio streams you wish to play. Qt does not set up formats for you.

Type Documentation

QAudioFormat.Endian

Constant	Value	Description
`QAudioFormat.BigEndian`	`QSysInfo.BigEndian`	samples are big endian byte order
`QAudioFormat.LittleEndian`	`QSysInfo.LittleEndian`	samples are little endian byte order

QAudioFormat.SampleType

Constant	Value	Description
`QAudioFormat.Unknown`	`0`	Not Set
`QAudioFormat.SignedInt`	`1`	samples are signed integers
`QAudioFormat.UnSignedInt`	`2`	samples are unsigned intergers
`QAudioFormat.Float`	`3`	samples are floats