summaryrefslogtreecommitdiffstats
path: root/src/multimedia/controls/qaudiorolecontrol.cpp
blob: 62696f0139690e5f1ee42a02e5a297c71bb00f7b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL21$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qmediacontrol_p.h"
#include "qaudiorolecontrol.h"

QT_BEGIN_NAMESPACE

/*!
    \class QAudioRoleControl
    \inmodule QtMultimedia
    \ingroup multimedia_control
    \since 5.6

    \brief The QAudioRoleControl class provides control over the audio role of a media object.

    If a QMediaService supports audio roles it will implement QAudioRoleControl.

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

    The interface name of QAudioRoleControl is \c org.qt-project.qt.audiorolecontrol/5.6 as
    defined in QAudioRoleControl_iid.

    \sa QMediaService::requestControl(), QMediaPlayer
*/

/*!
    \macro QAudioRoleControl_iid

    \c org.qt-project.qt.audiorolecontrol/5.6

    Defines the interface name of the QAudioRoleControl class.

    \relates QAudioRoleControl
*/

/*!
    Construct a QAudioRoleControl with the given \a parent.
*/
QAudioRoleControl::QAudioRoleControl(QObject *parent)
    : QMediaControl(*new QMediaControlPrivate, parent)
{

}

/*!
    Destroys the audio role control.
*/
QAudioRoleControl::~QAudioRoleControl()
{

}

/*!
    \fn QAudio::Role QAudioRoleControl::audioRole() const

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

/*!
    \fn void QAudioRoleControl::setAudioRole(QAudio::Role role)

    Sets the audio \a role of the media played by the media service.
*/

/*!
    \fn QList<QAudio::Role> QAudioRoleControl::supportedAudioRoles() const

    Returns a list of audio roles that the media service supports.
*/

/*!
    \fn void QAudioRoleControl::audioRoleChanged(QAudio::Role role)

    Signal emitted when the audio \a role has changed.
 */


#include "moc_qaudiorolecontrol.cpp"
QT_END_NAMESPACE