Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

QAudioStateConfiguration Class Reference
[QtBluetoothModule, QtMediaModule, QtPimModule, QtTelephonyModule]

The QAudioStateConfiguration class defines a read-only view to the current audio device configuration. More...

    #include <QAudioStateConfiguration>

Inherits QObject.

• List of all members, including inherited members

Public Functions

• QAudioStateConfiguration ( QObject * parent = 0 )
• ~QAudioStateConfiguration ()
• QAudio::AudioCapabilities availableCapabilities ( const QAudioStateInfo & state ) const
• QAudio::AudioCapability currentCapability () const
• QAudioStateInfo currentState () const
• QSet<QByteArray> domains () const
• bool isInitialized () const
• bool isStateAvailable ( const QAudioStateInfo & state ) const
• QSet<QAudioStateInfo> states () const
• QSet<QAudioStateInfo> states ( const QByteArray & domain ) const

• 29 public functions inherited from QObject

Signals

• void availabilityChanged ()
• void configurationInitialized ()
• void currentStateChanged ( const QAudioStateInfo & state, QAudio::AudioCapability capability )

• 1 signal inherited from QObject

Additional Inherited Members

• 1 property inherited from QObject
• 1 public slot inherited from QObject
• 1 public type inherited from QObject
• 4 static public members inherited from QObject
• 7 protected functions inherited from QObject
• 2 protected variables inherited from QObject

Detailed Description

The QAudioStateConfiguration class defines a read-only view to the current audio device configuration.

The QAudioStateConfiguration class provides a read-only view of the audio state configuration of the device. The user of this class can query all possible audio hardware paths that the current device supports, (e.g. audio routed to the Headset, Speaker, Bluetooth Headset) as well as the capabilities of each audio state.

See also QAudioStateInfo.

Member Function Documentation

QAudioStateConfiguration::QAudioStateConfiguration ( QObject * parent = 0 )

Constructs a new Audio Device Configuration object with parent. The configuration object is only a read-only view to the different set of audio states that the system supports. It is possible that the configuration has not been initialized yet, in this case the isInitialized() method will return false.

Once the configuration has been initialized, the configurationInitialized() signal will be emitted.

See also configurationInitialized() and isInitialized().

QAudioStateConfiguration::~QAudioStateConfiguration ()

Destroys an Audio Device Configuration object.

void QAudioStateConfiguration::availabilityChanged ()   [signal]

This signal is emitted whenever changes have been made to the device configuration. This occurs ifthe available status of a state(s) has changed.

See also configurationInitialized().

QAudio::AudioCapabilities QAudioStateConfiguration::availableCapabilities ( const QAudioStateInfo & state ) const

Returns all available capabilities for a particular state. Some devices support multiple multiple states (e.g. half-duplex, full-duplex). For various reasons (e.g. hardware capability, power consumption) it might be better to enable the state with only the capabilities that are required.

Returns the audio capabilities supported by the state. Returns an empty set if the state is not found.

See also isStateAvailable().

void QAudioStateConfiguration::configurationInitialized ()   [signal]

This signal is emitted when the audio device configuration enters the initialized state. Once this signal is emitted the user can assume that the current object will return useful information about the current audio device configuration.

See also availabilityChanged().

QAudio::AudioCapability QAudioStateConfiguration::currentCapability () const

Returns the current capability enabled for the audio device.

See also currentState() and currentStateChanged().

QAudioStateInfo QAudioStateConfiguration::currentState () const

Returns the current state of the audio device.

See also currentStateChanged() and currentCapability().

void QAudioStateConfiguration::currentStateChanged ( const QAudioStateInfo & state, QAudio::AudioCapability capability )   [signal]

This signal is emitted whenever the current audio state has changed. The state contains the current audio state and capability contains the current capability.

See also currentState() and currentCapability().

QSet<QByteArray> QAudioStateConfiguration::domains () const

Returns a set of domains supported by the audio device. All devices should provide RingTone, Media and Phone domains.

See also states() and availabilityChanged().

bool QAudioStateConfiguration::isInitialized () const

Returns whether the audio device configuration has been initialized. The configurationInitialized() signal will be emitted once the configuration has been initialized.

See also configurationInitialized().

bool QAudioStateConfiguration::isStateAvailable ( const QAudioStateInfo & state ) const

Returns true whether the state is available. For instance, if the Headphones are not plugged in, then the state that encapsulates routing audio data to the headphones would not be available.

See also availabilityChanged().

QSet<QAudioStateInfo> QAudioStateConfiguration::states () const

Returns a set of states supported by the audio device.

See also domains() and availabilityChanged().

QSet<QAudioStateInfo> QAudioStateConfiguration::states ( const QByteArray & domain ) const

This is an overloaded member function, provided for convenience.

Returns a set of states supported by the audio device for a particular domain.

See also domains() and availabilityChanged().