QCustomAudioRoleControl Class

The QCustomAudioRoleControl class provides control over the audio role of a media object. More...

Header:	#include <QCustomAudioRoleControl>
qmake:	QT += multimedia
Since:	Qt 5.11
Inherits:	QMediaControl

• List of all members, including inherited members
• Obsolete members

Public Functions

virtual	~QCustomAudioRoleControl()
virtual QString	customAudioRole() const = 0
virtual void	setCustomAudioRole(const QString &role) = 0
virtual QStringList	supportedCustomAudioRoles() const = 0

• 31 public functions inherited from QObject

Signals

void	customAudioRoleChanged(const QString &role)

• 2 signals inherited from QObject

Static Public Members

const QMetaObject

staticMetaObject

• 9 static public members inherited from QObject

Protected Functions

QCustomAudioRoleControl(QObject *parent = nullptr)

• 9 protected functions inherited from QObject

Macros

QCustomAudioRoleControl_iid

Additional Inherited Members

• 1 property inherited from QObject
• 1 public slot inherited from QObject

Detailed Description

The QCustomAudioRoleControl class provides control over the audio role of a media object.

If a QMediaService supports audio roles it may implement QCustomAudioRoleControl in order to provide access to roles unknown to Qt.

The functionality provided by this control is exposed to application code through the QMediaPlayer class.

The interface name of QCustomAudioRoleControl is org.qt-project.qt.customaudiorolecontrol/5.11 as defined in QCustomAudioRoleControl_iid.

See also QMediaService::requestControl() and QMediaPlayer.

Member Function Documentation

[protected] QCustomAudioRoleControl::QCustomAudioRoleControl(QObject *parent = nullptr)

Construct a QCustomAudioRoleControl with the given parent.

[virtual] QCustomAudioRoleControl::~QCustomAudioRoleControl()

Destroys the audio role control.

[pure virtual] QString QCustomAudioRoleControl::customAudioRole() const

Returns the audio role of the media played by the media service.

See also setCustomAudioRole().

[signal] void QCustomAudioRoleControl::customAudioRoleChanged(const QString &role)

Signal emitted when the audio role has changed.

[pure virtual] void QCustomAudioRoleControl::setCustomAudioRole(const QString &role)

Sets the audio role of the media played by the media service.

See also customAudioRole().

[pure virtual] QStringList QCustomAudioRoleControl::supportedCustomAudioRoles() const

Returns a list of custom audio roles that the media service supports. An empty list may indicate that the supported custom audio roles aren't known. The list may not be complete.