Contents

• Public Types
• Public Functions
• Detailed Description

Detailed Description

TheQAudioFormat 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 thecodec() 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.

You can obtain audio formats compatible with the audio device used through functions inQAudioDeviceInfo. This class also lets you query available parameter values for a device, so that you can set the parameters yourself. See theQAudioDeviceInfo 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.

Member Type Documentation

enum QAudioFormat::Endian

enum QAudioFormat::SampleType

Member Function Documentation

QAudioFormat::QAudioFormat()

Construct a new audio format.

Values are initialized as follows:

• sampleRate() = -1
• channelCount() = -1
• sampleSize() = -1
• byteOrder() =QAudioFormat::Endian(QSysInfo::ByteOrder)
• sampleType() =QAudioFormat::Unknowncodec() = ""

QAudioFormat::QAudioFormat(constQAudioFormat & other)

Construct a new audio format usingother.

QAudioFormat::~QAudioFormat()

Destroy this audio format.

QAudioFormat::Endian QAudioFormat::byteOrder() const

Returns the current byteOrder value.

See alsosetByteOrder().

int QAudioFormat::channelCount() const

Returns the current channel count value.

This function was introduced in Qt 4.7.

See alsosetChannelCount().

QString QAudioFormat::codec() const

Returns the current codec value.

See alsosetCodec() andQAudioDeviceInfo::supportedCodecs().

bool QAudioFormat::isValid() const

Returns true if all of the parameters are valid.

int QAudioFormat::sampleRate() const

Returns the current sample rate in Hertz.

This function was introduced in Qt 4.7.

See alsosetSampleRate().

int QAudioFormat::sampleSize() const

Returns the current sample size value.

See alsosetSampleSize().

QAudioFormat::SampleType QAudioFormat::sampleType() const

Returns the currentSampleType value.

See alsosetSampleType().

void QAudioFormat::setByteOrder(QAudioFormat::Endian byteOrder)

Sets thebyteOrder tobyteOrder.

See alsobyteOrder().

void QAudioFormat::setChannelCount(int channels)

Sets the channel count tochannels.

This function was introduced in Qt 4.7.

See alsochannelCount().

void QAudioFormat::setCodec(constQString & codec)

Sets the codec tocodec.

See alsocodec() andQAudioDeviceInfo::supportedCodecs().

void QAudioFormat::setSampleRate(int samplerate)

Sets the sample rate tosamplerate Hertz.

This function was introduced in Qt 4.7.

See alsosampleRate().

void QAudioFormat::setSampleSize(int sampleSize)

Sets the sample size to thesampleSize specified.

See alsosampleSize().

void QAudioFormat::setSampleType(QAudioFormat::SampleType sampleType)

Sets thesampleType tosampleType.

See alsosampleType().

bool QAudioFormat::operator!=(constQAudioFormat & other) const

Returns true if thisQAudioFormat is not equal to theotherQAudioFormat; otherwise returns false.

All elements ofQAudioFormat are used for the comparison.

QAudioFormat & QAudioFormat::operator=(constQAudioFormat & other)

Assignsother to thisQAudioFormat implementation.

bool QAudioFormat::operator==(constQAudioFormat & other) const

Returns true if thisQAudioFormat is equal to theotherQAudioFormat; otherwise returns false.

All elements ofQAudioFormat are used for the comparison.