|
|
              
QAudioFormat ClassThe QAudioFormat class stores audio stream parameter information. More... #include <QAudioFormat>
Public Types
Public Functions
Detailed DescriptionThe QAudioFormat class stores audio stream 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 sample 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.
This class is typically used in conjunction with QAudioInput or QAudioOutput to allow you to specify the parameters of the audio stream being read or written. 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 or record. Member Type Documentation
|
| Constant | Value | Description |
|---|---|---|
| QAudioFormat::BigEndian | QSysInfo::BigEndian | Samples are big endian byte order |
| QAudioFormat::LittleEndian | QSysInfo::LittleEndian | Samples are little endian byte order |
enum 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 |
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::Unknown codec() = ""
QAudioFormat::QAudioFormat(const QAudioFormat & other)
Construct a new audio format using other.
QAudioFormat::~QAudioFormat()
Destroy this audio format.
QAudioFormat::Endian QAudioFormat::byteOrder() const
Returns the current byteOrder value.
See also setByteOrder().
int QAudioFormat::channelCount() const
Returns the current channel count value.
See also setChannelCount().
QString QAudioFormat::codec() const
Returns the current codec identifier.
See also setCodec() and QAudioDeviceInfo::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.
See also setSampleRate().
int QAudioFormat::sampleSize() const
Returns the current sample size value, in bits.
See also setSampleSize().
QAudioFormat::SampleType QAudioFormat::sampleType() const
Returns the current SampleType value.
See also setSampleType().
void QAudioFormat::setByteOrder(QAudioFormat::Endian byteOrder)
Sets the byteOrder to byteOrder.
See also byteOrder().
void QAudioFormat::setChannelCount(int channels)
Sets the channel count to channels.
See also channelCount().
void QAudioFormat::setCodec(const QString & codec)
Sets the codec to codec.
The parameter to this function should be one of the types reported by the QAudioDeviceInfo::supportedCodecs() function for the audio device you are working with.
See also codec() and QAudioDeviceInfo::supportedCodecs().
void QAudioFormat::setSampleRate(int samplerate)
Sets the sample rate to samplerate Hertz.
See also sampleRate().
void QAudioFormat::setSampleSize(int sampleSize)
Sets the sample size to the sampleSize specified, in bits.
This is typically 8 or 16, but some systems may support higher sample sizes.
See also sampleSize().
void QAudioFormat::setSampleType(QAudioFormat::SampleType sampleType)
Sets the sampleType to sampleType.
See also sampleType().
bool QAudioFormat::operator!=(const QAudioFormat & other) const
Returns true if this QAudioFormat is not equal to the other QAudioFormat; otherwise returns false.
All elements of QAudioFormat are used for the comparison.
QAudioFormat & QAudioFormat::operator=(const QAudioFormat & other)
Assigns other to this QAudioFormat implementation.
bool QAudioFormat::operator==(const QAudioFormat & other) const
Returns true if this QAudioFormat is equal to the other QAudioFormat; otherwise returns false.
All elements of QAudioFormat are used for the comparison.