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

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

The QAudioStateInfo class provides a point of access to information about an audio state. More...

    #include <QAudioStateInfo>

• List of all members, including inherited members

Public Functions

• QAudioStateInfo ( const QByteArray & domain, const QByteArray & profile, const QString & displayName, int priority )
• QAudioStateInfo ()
• QAudioStateInfo ( const QAudioStateInfo & other )
• ~QAudioStateInfo ()
• QString displayName () const
• QByteArray domain () const
• bool isValid () const
• int priority () const
• QByteArray profile () const
• void setDisplayName ( const QString & displayName )
• void setDomain ( const QByteArray & domain )
• void setPriority ( int priority )
• void setProfile ( const QByteArray & profile )
• bool operator!= ( const QAudioStateInfo & other ) const
• QAudioStateInfo & operator= ( const QAudioStateInfo & other )
• bool operator== ( const QAudioStateInfo & other ) const

Detailed Description

The QAudioStateInfo class provides a point of access to information about an audio state.

Hardware audio devices support a discrete set of audio device configurations. For instance, using the Bluetooth Headset and routing all phone call information to and from the headset can be considered an audio state.

The QAudioStateInfo is used to enumerate the attributes and of of a particular audio state. The Audio Domain that this state belongs to can be found by calling domain(). The profile name can be discovered by calling profile(). Finally a translated name suitable for display can be found by using the displayName() function. The priority for this state can be found using priority().

See also QAudioStateConfiguration.

Member Function Documentation

QAudioStateInfo::QAudioStateInfo ( const QByteArray & domain, const QByteArray & profile, const QString & displayName, int priority )

Constructs a new valid Audio State Info. The Audio Domain is set to domain. The profile name is given by profile. The display name is set to displayName. The priority is given by priority.

See also isValid().

QAudioStateInfo::QAudioStateInfo ()

Constructs a new invalid Audio State Info object.

See also isValid().

QAudioStateInfo::QAudioStateInfo ( const QAudioStateInfo & other )

Constructs a new Audio State Info from the contents of other.

See also isValid().

QAudioStateInfo::~QAudioStateInfo ()

Destroys an Audio State Info.

QString QAudioStateInfo::displayName () const

Returns a translated string that describes this audio state suitable for display. E.g. for instance "Bluetooth Headset" or "Headphones".

See also setDisplayName().

QByteArray QAudioStateInfo::domain () const

Returns the Audio Domain Info for this state.

See also setDomain().

bool QAudioStateInfo::isValid () const

Returns true whether this Audio State is valid. If the object is not valid, information returned should not be relied upon.

int QAudioStateInfo::priority () const

Returns the priority for this Audio State. The value of 0 has the highest priority, while the value of MAX_INT has the lowest priority.

If the object is not valid, returns -1.

See also setPriority() and isValid().

QByteArray QAudioStateInfo::profile () const

Returns the profile name for this state.

See also setProfile().

void QAudioStateInfo::setDisplayName ( const QString & displayName )

Sets the translated display name for this state to displayName.

If you call this function for an invalid audio state, this function turns it into a valid one.

See also displayName() and isValid().

void QAudioStateInfo::setDomain ( const QByteArray & domain )

Sets the Audio Domain for this state to domain.

If you call this function for an invalid audio state, this function turns it into a valid one.

See also domain() and isValid().

void QAudioStateInfo::setPriority ( int priority )

Sets the priority of the audio state to priority.

If you call this function for an invalid audio state, this function turns it into a valid one.

See also priority().

void QAudioStateInfo::setProfile ( const QByteArray & profile )

Sets the profile name for this state to profile.

If you call this function for an invalid audio state, this function turns it into a valid one.

See also profile() and isValid().

bool QAudioStateInfo::operator!= ( const QAudioStateInfo & other ) const

Returns true if the contents of other are not equal to the contents of the current object.

See also operator==().

QAudioStateInfo & QAudioStateInfo::operator= ( const QAudioStateInfo & other )

Assign the contents of other to the current audio state.

See also isValid().

bool QAudioStateInfo::operator== ( const QAudioStateInfo & other ) const

Returns true if the contents of other are equal to the contents of the current object.

See also operator!=().