| 1 | /**************************************************************************** |
|---|
| 2 | ** |
|---|
| 3 | ** Copyright (C) 2017 QNX Software Systems. All rights reserved. |
|---|
| 4 | ** Contact: https://www.qt.io/licensing/ |
|---|
| 5 | ** |
|---|
| 6 | ** This file is part of the Qt Toolkit. |
|---|
| 7 | ** |
|---|
| 8 | ** $QT_BEGIN_LICENSE:LGPL$ |
|---|
| 9 | ** Commercial License Usage |
|---|
| 10 | ** Licensees holding valid commercial Qt licenses may use this file in |
|---|
| 11 | ** accordance with the commercial license agreement provided with the |
|---|
| 12 | ** Software or, alternatively, in accordance with the terms contained in |
|---|
| 13 | ** a written agreement between you and The Qt Company. For licensing terms |
|---|
| 14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
|---|
| 15 | ** information use the contact form at https://www.qt.io/contact-us. |
|---|
| 16 | ** |
|---|
| 17 | ** GNU Lesser General Public License Usage |
|---|
| 18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
|---|
| 19 | ** General Public License version 3 as published by the Free Software |
|---|
| 20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
|---|
| 21 | ** packaging of this file. Please review the following information to |
|---|
| 22 | ** ensure the GNU Lesser General Public License version 3 requirements |
|---|
| 23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
|---|
| 24 | ** |
|---|
| 25 | ** GNU General Public License Usage |
|---|
| 26 | ** Alternatively, this file may be used under the terms of the GNU |
|---|
| 27 | ** General Public License version 2.0 or (at your option) the GNU General |
|---|
| 28 | ** Public license version 3 or any later version approved by the KDE Free |
|---|
| 29 | ** Qt Foundation. The licenses are as published by the Free Software |
|---|
| 30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
|---|
| 31 | ** included in the packaging of this file. Please review the following |
|---|
| 32 | ** information to ensure the GNU General Public License requirements will |
|---|
| 33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
|---|
| 34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
|---|
| 35 | ** |
|---|
| 36 | ** $QT_END_LICENSE$ |
|---|
| 37 | ** |
|---|
| 38 | ****************************************************************************/ |
|---|
| 39 | |
|---|
| 40 | #include "qmediacontrol_p.h" |
|---|
| 41 | #include "qcustomaudiorolecontrol.h" |
|---|
| 42 | |
|---|
| 43 | QT_BEGIN_NAMESPACE |
|---|
| 44 | |
|---|
| 45 | /*! |
|---|
| 46 | \class QCustomAudioRoleControl |
|---|
| 47 | \obsolete |
|---|
| 48 | \inmodule QtMultimedia |
|---|
| 49 | \ingroup multimedia_control |
|---|
| 50 | \since 5.11 |
|---|
| 51 | |
|---|
| 52 | \brief The QCustomAudioRoleControl class provides control over the audio role of a media object. |
|---|
| 53 | |
|---|
| 54 | If a QMediaService supports audio roles it may implement QCustomAudioRoleControl in order to |
|---|
| 55 | provide access to roles unknown to Qt. |
|---|
| 56 | |
|---|
| 57 | The functionality provided by this control is exposed to application code through the |
|---|
| 58 | QMediaPlayer class. |
|---|
| 59 | |
|---|
| 60 | The interface name of QCustomAudioRoleControl is \c org.qt-project.qt.customaudiorolecontrol/5.11 as |
|---|
| 61 | defined in QCustomAudioRoleControl_iid. |
|---|
| 62 | |
|---|
| 63 | \sa QMediaService::requestControl(), QMediaPlayer |
|---|
| 64 | */ |
|---|
| 65 | |
|---|
| 66 | /*! |
|---|
| 67 | \macro QCustomAudioRoleControl_iid |
|---|
| 68 | |
|---|
| 69 | \c org.qt-project.qt.customaudiorolecontrol/5.11 |
|---|
| 70 | |
|---|
| 71 | Defines the interface name of the QCustomAudioRoleControl class. |
|---|
| 72 | |
|---|
| 73 | \relates QCustomAudioRoleControl |
|---|
| 74 | */ |
|---|
| 75 | |
|---|
| 76 | /*! |
|---|
| 77 | Construct a QCustomAudioRoleControl with the given \a parent. |
|---|
| 78 | */ |
|---|
| 79 | QCustomAudioRoleControl::QCustomAudioRoleControl(QObject *parent) |
|---|
| 80 | : QMediaControl(*new QMediaControlPrivate, parent) |
|---|
| 81 | { |
|---|
| 82 | } |
|---|
| 83 | |
|---|
| 84 | /*! |
|---|
| 85 | Destroys the audio role control. |
|---|
| 86 | */ |
|---|
| 87 | QCustomAudioRoleControl::~QCustomAudioRoleControl() |
|---|
| 88 | { |
|---|
| 89 | } |
|---|
| 90 | |
|---|
| 91 | /*! |
|---|
| 92 | \fn QAudio::Role QCustomAudioRoleControl::customAudioRole() const |
|---|
| 93 | |
|---|
| 94 | Returns the audio role of the media played by the media service. |
|---|
| 95 | */ |
|---|
| 96 | |
|---|
| 97 | /*! |
|---|
| 98 | \fn void QCustomAudioRoleControl::setCustomAudioRole(const QString &role) |
|---|
| 99 | |
|---|
| 100 | Sets the audio \a role of the media played by the media service. |
|---|
| 101 | */ |
|---|
| 102 | |
|---|
| 103 | /*! |
|---|
| 104 | \fn QStringList QCustomAudioRoleControl::supportedCustomAudioRoles() const |
|---|
| 105 | |
|---|
| 106 | Returns a list of custom audio roles that the media service supports. An |
|---|
| 107 | empty list may indicate that the supported custom audio roles aren't known. |
|---|
| 108 | The list may not be complete. |
|---|
| 109 | */ |
|---|
| 110 | |
|---|
| 111 | /*! |
|---|
| 112 | \fn void QCustomAudioRoleControl::customAudioRoleChanged(const QString &role) |
|---|
| 113 | |
|---|
| 114 | Signal emitted when the audio \a role has changed. |
|---|
| 115 | */ |
|---|
| 116 | |
|---|
| 117 | QT_END_NAMESPACE |
|---|
| 118 | |
|---|
| 119 | #include "moc_qcustomaudiorolecontrol.cpp" |
|---|
| 120 | |
|---|
