blob: cd83b76c3b5a0ede7a51ebc8b938e9ce688f7119 (
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtIvi module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qiviamfmtunerbackendinterface.h"
QT_BEGIN_NAMESPACE
/*!
\class QIviAmFmTunerBackendInterface
\inmodule QtIviMedia
\ingroup backends
\inherits QObject
\keyword org.qt-project.qtivi.AmFmTuner/1.0
\brief The QIviAmFmTunerBackendInterface defines the interface for backends to the
QIviAmFmTuner feature class.
The QIviAmFmTunerBackendInterface is the interface used by \l QIviAmFmTuner
The interface is discovered by a \l QIviAmFmTuner object, which connects to it and sets it up.
<example of a fully featured backend>
*/
/*!
Constructs a backend interface.
The \a parent is sent to the QObject constructor.
*/
QIviAmFmTunerBackendInterface::QIviAmFmTunerBackendInterface(QObject *parent)
: QIviFeatureInterface(parent)
{
}
/*!
\fn QIviAmFmTunerBackendInterface::setFrequency(int frequency)
Changes the frequency to the new value passed as \a frequency.
This method is expected to emit a \l frequencyChanged() signal when the internal state changes due to this function call
*/
/*!
\fn QIviAmFmTunerBackendInterface::setBand(QIviAmFmTuner::Band band)
Changes the band to the new value passed as \a band.
This method is expected to emit a \l bandChanged() signal when the internal state changes due to this function call
*/
/*!
\fn QIviAmFmTunerBackendInterface::stepUp()
Increases the frequency by the current bands step size.
\sa frequencyChanged stationChanged
*/
/*!
\fn QIviAmFmTunerBackendInterface::stepDown()
Decreases the frequency by the current bands step size.
\sa frequencyChanged stationChanged
*/
/*!
\fn QIviAmFmTunerBackendInterface::seekUp()
Seeks the next available Station in upwards direction and tunes it.
If the end of the band where hit without finding a station, the search will be continued from the beginning of the band.
\sa frequencyChanged stationChanged
*/
/*!
\fn QIviAmFmTunerBackendInterface::seekDown()
Seeks the next available Station in downwards direction and tunes it.
If the beginning of the band where hit without finding a station, the search will be continued from the end of the band.
\sa frequencyChanged stationChanged
*/
/*!
\fn QIviAmFmTunerBackendInterface::startScan()
Starts a scan through all available stations.
The scan will seek to the next available station and will stay there for some seconds until it seeks to the next station.
It is expected that this function will inform about the current state of the backend by emitting the scanStatusChanged() signal.
\sa stopScan() scanStatusChanged()
*/
/*!
\fn QIviAmFmTunerBackendInterface::stopScan()
Stops the currently active scan. If no scan is active, this method does nothing.
It is expected that this function will inform about the current state of the backend by emitting the scanStatusChanged() signal.
\sa startScan() scanStatusChanged()
*/
/*!
\fn QIviAmFmTunerBackendInterface::frequencyChanged(int frequency)
Emitted when the current frequency changed. The new value is passed as \a frequency.
*/
/*!
\fn QIviAmFmTunerBackendInterface::minimumFrequencyChanged(int minimumFrequency)
Emitted when the minimum frequency of the current band changed. The new value is passed as \a minimumFrequency.
This is usually caused by a switching the band.
\sa bandChanged() maximumFrequencyChanged() stepSizeChanged()
*/
/*!
\fn QIviAmFmTunerBackendInterface::maximumFrequencyChanged(int maximumFrequency)
Emitted when the maximum frequency of the current band changed. The new value is passed as \a maximumFrequency.
This is usually caused by a switching the band.
\sa bandChanged() minimumFrequencyChanged() stepSizeChanged()
*/
/*!
\fn QIviAmFmTunerBackendInterface::stepSizeChanged(int stepSize)
Emitted when the frequency step size of the current band changed. The new value is passed as \a stepSize.
This is usually caused by a switching the band.
\sa bandChanged() minimumFrequencyChanged() maximumFrequencyChanged()
*/
/*!
\fn QIviAmFmTunerBackendInterface::bandChanged(QIviAmFmTuner::Band band)
Emitted when the current band changed. The new value is passed as \a band.
\sa minimumFrequencyChanged() maximumFrequencyChanged() stepSizeChanged()
*/
/*!
\fn QIviAmFmTunerBackendInterface::stationChanged(const QIviAmFmTunerStation &station)
Emitted when the current station changed. The new station is passed as \a station.
*/
/*!
\fn QIviAmFmTunerBackendInterface::scanStatusChanged(bool scanRunning)
Emitted when the status of the station scan has changed. This signal should be emitted
as a result of a call to startScan() or stopScan() and informs about the current status using the \a scanRunning argument.
\sa startScan() stopScan()
*/
QT_END_NAMESPACE
|
