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

Detailed Description

The QAudioState class encapsulates an audio device state.

The QAudioState class can be used to implement a particular state for a hardware audio device. For instance, a state where the output of the phone modem is routed to the earphones.

Member Function Documentation

QAudioState::QAudioState ( QObject * parent = 0 )

Creates a new Audio State object with QObject parent set to parent.

QAudioState::~QAudioState ()   [virtual]

Destroys an Audio State object.

void QAudioState::availabilityChanged ( bool available )   [signal]

This signal is emitted by the audio state whenever the availability state has changed. The new availability is given by available. For instance, the headset might have been plugged in and is now available for use.

See also isAvailable().

QAudio::AudioCapabilities QAudioState::capabilities () const   [pure virtual]

Returns the capabilities that this audio state supports.

See also info().

void QAudioState::doNotUseHint ()   [signal]

This signal is emitted by the audio state whenever it has received a hint that it should no longer be used. For instance, this could be a user-initiated action from the hardware device (e.g. Bluetooth multi-function button pressed).

See also useHint().

bool QAudioState::enter ( QAudio::AudioCapability capability )   [pure virtual]

Asks the audio state object to enter its supported audio state with capability.

The function returns true if the state transition could be performed.

See also leave() and capabilities().

QAudioStateInfo QAudioState::info () const   [pure virtual]

Returns the information about the audio state.

See also capabilities() and QAudioStateInfo.

bool QAudioState::isAvailable () const   [pure virtual]

Returns true whether the state is available. E.g. Bluetooth state is only available if the Bluetooth headset is plugged in.

See also availabilityChanged().

bool QAudioState::leave ()   [pure virtual]

Asks the audio state object to leave its supported audio state.

The function returns true if the state transition could be performed.

See also enter().

void QAudioState::useHint ()   [signal]

This signa is emitted by the audio state whenever it has received a hint that it should be the state being used.

See also doNotUseHint().