The QAudioDeviceInfo class provides an interface to query audio devices and their functionality. More...
#include <QAudioDeviceInfo>
This class was introduced in QtMobility 1.0.
| QAudioDeviceInfo () | |
| QAudioDeviceInfo ( const QAudioDeviceInfo & other ) | |
| ~QAudioDeviceInfo () | |
| QString | deviceName () const |
| bool | isFormatSupported ( const QAudioFormat & settings ) const |
| bool | isNull () const |
| QAudioFormat | nearestFormat ( const QAudioFormat & settings ) const |
| QAudioFormat | preferredFormat () const |
| QList<QAudioFormat::Endian> | supportedByteOrders () const |
| QList<int> | supportedChannelCounts () const |
| QStringList | supportedCodecs () const |
| QList<int> | supportedSampleRates () const |
| QList<int> | supportedSampleSizes () const |
| QList<QAudioFormat::SampleType> | supportedSampleTypes () const |
| QAudioDeviceInfo & | operator= ( const QAudioDeviceInfo & other ) |
| QList<QAudioDeviceInfo> | availableDevices ( QAudio::Mode mode ) |
| QAudioDeviceInfo | defaultInputDevice () |
| QAudioDeviceInfo | defaultOutputDevice () |
The QAudioDeviceInfo class provides an interface to query audio devices and their functionality.
QAudioDeviceInfo lets you query for audio devices--such as sound cards and USB headsets--that are currently available on the system. The audio devices available are dependent on the platform or audio plugins installed.
You can also query each device for the formats it supports. A format in this context is a set consisting of a specific byte order, channel, codec, frequency, sample rate, and sample type. A format is represented by the QAudioFormat class.
The values supported by the the device for each of these parameters can be fetched with supportedByteOrders(), supportedChannelCounts(), supportedCodecs(), supportedSampleRates(), supportedSampleSizes(), and supportedSampleTypes(). The combinations supported are dependent on the platform, audio plugins installed and the audio device capabilities. If you need a specific format, you can check if the device supports it with isFormatSupported(), or fetch a supported format that is as close as possible to the format with nearestFormat(). For instance:
QAudioFormat format; format.setFrequency(44100); // ... other format parameters format.setSampleType(QAudioFormat::SignedInt); QAudioDeviceInfo info(QAudioDeviceInfo::defaultOutputDevice()); if (!info.isFormatSupported(format)) format = info.nearestFormat(format);
A QAudioDeviceInfo is used by Qt to construct classes that communicate with the device--such as QAudioInput, and QAudioOutput. The static functions defaultInputDevice(), defaultOutputDevice(), and availableDevices() let you get a list of all available devices. Devices are fetch according to the value of mode this is specified by the QAudio::Mode enum. The QAudioDeviceInfo returned are only valid for the QAudio::Mode.
For instance:
foreach (const QAudioDeviceInfo &deviceInfo, QAudioDeviceInfo::availableDevices(QAudio::AudioOutput)) qDebug() << "Device name: " << deviceInfo.deviceName();
In this code sample, we loop through all devices that are able to output sound, i.e., play an audio stream in a supported format. For each device we find, we simply print the deviceName().
See also QAudioOutput and QAudioInput.
Constructs an empty QAudioDeviceInfo object.
Constructs a copy of other.
This function was introduced in Qt Mobility 1.0.
Destroy this audio device info.
Returns a list of audio devices that support mode.
This function was introduced in Qt Mobility 1.0.
Returns the name of the default input audio device. All platform and audio plugin implementations provide a default audio device to use.
This function was introduced in Qt Mobility 1.0.
Returns the name of the default output audio device. All platform and audio plugin implementations provide a default audio device to use.
This function was introduced in Qt Mobility 1.0.
Returns human readable name of audio device.
Device names vary depending on platform/audio plugin being used.
They are a unique string identifiers for the audio device.
eg. default, Intel, U0x46d0x9a4
This function was introduced in Qt Mobility 1.0.
Returns true if settings are supported by the audio device of this QAudioDeviceInfo.
This function was introduced in Qt Mobility 1.0.
Returns whether this QAudioDeviceInfo object holds a device definition.
This function was introduced in Qt Mobility 1.0.
Returns closest QAudioFormat to settings that system audio supports.
These settings are provided by the platform/audio plugin being used.
They also are dependent on the QAudio::Mode being used.
This function was introduced in Qt Mobility 1.0.
Returns QAudioFormat of default settings.
These settings are provided by the platform/audio plugin being used.
They also are dependent on the QAudio::Mode being used.
A typical audio system would provide something like:
This function was introduced in Qt Mobility 1.0.
Returns a list of supported byte orders.
This function was introduced in Qt Mobility 1.0.
Returns a list of supported channel counts.
This function was introduced in Qt Mobility 1.0.
Returns a list of supported codecs.
All platform and plugin implementations should provide support for:
"audio/pcm" - Linear PCM
For writing plugins to support additional codecs refer to:
http://www.iana.org/assignments/media-types/audio/
This function was introduced in Qt Mobility 1.0.
Returns a list of supported sample rates.
This function was introduced in Qt Mobility 1.0.
Returns a list of supported sample sizes.
This function was introduced in Qt Mobility 1.0.
Returns a list of supported sample types.
This function was introduced in Qt Mobility 1.0.
Sets the QAudioDeviceInfo object to be equal to other.
This function was introduced in Qt Mobility 1.0.
© 2008-2011 Nokia Corporation and/or its subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation in Finland and/or other countries worldwide.
All other trademarks are property of their respective owners. Privacy Policy
Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.
Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.