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
43QT_BEGIN_NAMESPACE
44
45/*!
46 \class QCustomAudioRoleControl
47 \inmodule QtMultimedia
48 \ingroup multimedia_control
49 \since 5.11
50
51 \brief The QCustomAudioRoleControl class provides control over the audio role of a media object.
52
53 If a QMediaService supports audio roles it may implement QCustomAudioRoleControl in order to
54 provide access to roles unknown to Qt.
55
56 The functionality provided by this control is exposed to application code through the
57 QMediaPlayer class.
58
59 The interface name of QCustomAudioRoleControl is \c org.qt-project.qt.customaudiorolecontrol/5.11 as
60 defined in QCustomAudioRoleControl_iid.
61
62 \sa QMediaService::requestControl(), QMediaPlayer
63*/
64
65/*!
66 \macro QCustomAudioRoleControl_iid
67
68 \c org.qt-project.qt.customaudiorolecontrol/5.11
69
70 Defines the interface name of the QCustomAudioRoleControl class.
71
72 \relates QCustomAudioRoleControl
73*/
74
75/*!
76 Construct a QCustomAudioRoleControl with the given \a parent.
77*/
78QCustomAudioRoleControl::QCustomAudioRoleControl(QObject *parent)
79 : QMediaControl(*new QMediaControlPrivate, parent)
80{
81}
82
83/*!
84 Destroys the audio role control.
85*/
86QCustomAudioRoleControl::~QCustomAudioRoleControl()
87{
88}
89
90/*!
91 \fn QAudio::Role QCustomAudioRoleControl::customAudioRole() const
92
93 Returns the audio role of the media played by the media service.
94*/
95
96/*!
97 \fn void QCustomAudioRoleControl::setCustomAudioRole(const QString &role)
98
99 Sets the audio \a role of the media played by the media service.
100*/
101
102/*!
103 \fn QStringList QCustomAudioRoleControl::supportedCustomAudioRoles() const
104
105 Returns a list of custom audio roles that the media service supports. An
106 empty list may indicate that the supported custom audio roles aren't known.
107 The list may not be complete.
108*/
109
110/*!
111 \fn void QCustomAudioRoleControl::customAudioRoleChanged(const QString &role)
112
113 Signal emitted when the audio \a role has changed.
114 */
115
116#include "moc_qcustomaudiorolecontrol.cpp"
117QT_END_NAMESPACE
118