1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
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 <qtmultimediaglobal.h>
41#include "qradiodatacontrol.h"
42#include "qmediacontrol_p.h"
43
44QT_BEGIN_NAMESPACE
45
46
47/*!
48 \class QRadioDataControl
49 \inmodule QtMultimedia
50
51
52 \ingroup multimedia_control
53
54
55 \brief The QRadioDataControl class provides access to the RDS functionality of the
56 radio in the QMediaService.
57
58 The functionality provided by this control is exposed to application code
59 through the QRadioData class.
60
61 The interface name of QRadioDataControl is \c org.qt-project.qt.radiodatacontrol/5.0 as
62 defined in QRadioDataControl_iid.
63
64 \sa QMediaService::requestControl(), QRadioData
65*/
66
67/*!
68 \macro QRadioDataControl_iid
69
70 \c org.qt-project.qt.radiodatacontrol/5.0
71
72 Defines the interface name of the QRadioDataControl class.
73
74 \relates QRadioDataControl
75*/
76
77/*!
78 Constructs a radio data control with the given \a parent.
79*/
80
81QRadioDataControl::QRadioDataControl(QObject *parent):
82 QMediaControl(*new QMediaControlPrivate, parent)
83{
84}
85
86/*!
87 Destroys a radio data control.
88*/
89
90QRadioDataControl::~QRadioDataControl()
91{
92}
93
94/*!
95 \fn QRadioData::Error QRadioDataControl::error() const
96
97 Returns the error state of a radio data.
98*/
99
100/*!
101 \fn QString QRadioDataControl::errorString() const
102
103 Returns a string describing a radio data's error state.
104*/
105
106/*!
107 \fn void QRadioDataControl::error(QRadioData::Error error)
108
109 Signals that an \a error has occurred.
110*/
111
112/*!
113 \fn QString QRadioDataControl::stationId() const
114
115 Returns the current Program Identification
116*/
117
118/*!
119 \fn QRadioData::ProgramType QRadioDataControl::programType() const
120
121 Returns the current Program Type
122*/
123
124/*!
125 \fn QString QRadioDataControl::programTypeName() const
126
127 Returns the current Program Type Name
128*/
129
130/*!
131 \fn QString QRadioDataControl::stationName() const
132
133 Returns the current Program Service
134*/
135
136/*!
137 \fn QString QRadioDataControl::radioText() const
138
139 Returns the current Radio Text
140*/
141
142/*!
143 \fn void QRadioDataControl::setAlternativeFrequenciesEnabled(bool enabled)
144
145 Sets the Alternative Frequency to \a enabled
146*/
147
148/*!
149 \fn bool QRadioDataControl::isAlternativeFrequenciesEnabled() const
150
151 Returns true if Alternative Frequency is currently enabled
152*/
153
154/*!
155 \fn QRadioDataControl::alternativeFrequenciesEnabledChanged(bool enabled)
156
157 Signals that the alternative frequencies setting has changed to the value of \a enabled.
158*/
159
160/*!
161 \fn void QRadioDataControl::stationIdChanged(QString stationId)
162
163 Signals that the Program Identification \a stationId has changed
164*/
165
166/*!
167 \fn void QRadioDataControl::programTypeChanged(QRadioData::ProgramType programType)
168
169 Signals that the Program Type \a programType has changed
170*/
171
172/*!
173 \fn void QRadioDataControl::programTypeNameChanged(QString programTypeName)
174
175 Signals that the Program Type Name \a programTypeName has changed
176*/
177
178/*!
179 \fn void QRadioDataControl::stationNameChanged(QString stationName)
180
181 Signals that the Program Service \a stationName has changed
182*/
183
184/*!
185 \fn void QRadioDataControl::radioTextChanged(QString radioText)
186
187 Signals that the Radio Text \a radioText has changed
188*/
189
190#include "moc_qradiodatacontrol.cpp"
191QT_END_NAMESPACE
192
193