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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part 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 <private/qtmultimediaglobal_p.h>
#include "qaudiosystem_p.h"
QT_BEGIN_NAMESPACE
/*!
\class QPlatformAudioSink
\brief The QPlatformAudioSink class is a base class for audio backends.
\ingroup multimedia
\inmodule QtMultimedia
QPlatformAudioSink implements audio functionality for
QAudioSink, i.e., QAudioSink routes function calls to
QPlatformAudioSink. For a description of the functionality that
is implemented, see the QAudioSink class and function
descriptions.
\sa QAudioSink
*/
/*!
\fn virtual void QPlatformAudioSink::start(QIODevice* device)
Uses the \a device as the QIODevice to transfer data.
*/
/*!
\fn virtual QIODevice* QPlatformAudioSink::start()
Returns a pointer to the QIODevice being used to handle
the data transfer. This QIODevice can be used to write() audio data directly.
*/
/*!
\fn virtual void QPlatformAudioSink::stop()
Stops the audio output.
*/
/*!
\fn virtual void QPlatformAudioSink::reset()
Drops all audio data in the buffers, resets buffers to zero.
*/
/*!
\fn virtual void QPlatformAudioSink::suspend()
Stops processing audio data, preserving buffered audio data.
*/
/*!
\fn virtual void QPlatformAudioSink::resume()
Resumes processing audio data after a suspend()
*/
/*!
\fn virtual qsizetype QPlatformAudioSink::bytesFree() const
Returns the free space available in bytes in the audio buffer.
*/
/*!
\fn virtual void QPlatformAudioSink::setBufferSize(qsizetype value)
Sets the audio buffer size to \a value in bytes.
*/
/*!
\fn virtual qsizetype QPlatformAudioSink::bufferSize() const
Returns the audio buffer size in bytes.
*/
/*!
\fn virtual qint64 QPlatformAudioSink::processedUSecs() const
Returns the amount of audio data processed since start() was called in milliseconds.
*/
/*!
\fn virtual QAudio::Error QPlatformAudioSink::error() const
Returns the error state.
*/
/*!
\fn virtual QAudio::State QPlatformAudioSink::state() const
Returns the state of audio processing.
*/
/*!
\fn virtual void QPlatformAudioSink::setFormat(const QAudioFormat& fmt)
Set the QAudioFormat to use to \a fmt.
Setting the format is only allowable while in QAudio::StoppedState.
*/
/*!
\fn virtual QAudioFormat QPlatformAudioSink::format() const
Returns the QAudioFormat being used.
*/
/*!
\fn virtual void QPlatformAudioSink::setVolume(qreal volume)
Sets the volume.
Where \a volume is between 0.0 and 1.0.
*/
/*!
\fn virtual qreal QPlatformAudioSink::volume() const
Returns the volume in the range 0.0 and 1.0.
*/
void QPlatformAudioSink::setRole(QAudio::Role role)
{
m_role = role;
}
/*!
\fn QPlatformAudioSink::errorChanged(QAudio::Error error)
This signal is emitted when the \a error state has changed.
*/
/*!
\fn QPlatformAudioSink::stateChanged(QAudio::State state)
This signal is emitted when the device \a state has changed.
*/
/*!
\class QPlatformAudioSource
\brief The QPlatformAudioSource class provides access for QAudioSource to access the audio
device provided by the plugin.
\ingroup multimedia
\inmodule QtMultimedia
QAudioDeviceInput keeps an instance of QPlatformAudioSource and
routes calls to functions of the same name to QPlatformAudioSource.
This means that it is QPlatformAudioSource that implements the
audio functionality. For a description of the functionality, see
the QAudioSource class description.
\sa QAudioSource
*/
/*!
\fn virtual void QPlatformAudioSource::start(QIODevice* device)
Uses the \a device as the QIODevice to transfer data.
*/
/*!
\fn virtual QIODevice* QPlatformAudioSource::start()
Returns a pointer to the QIODevice being used to handle
the data transfer. This QIODevice can be used to read() audio data directly.
*/
/*!
\fn virtual void QPlatformAudioSource::stop()
Stops the audio input.
*/
/*!
\fn virtual void QPlatformAudioSource::reset()
Drops all audio data in the buffers, resets buffers to zero.
*/
/*!
\fn virtual void QPlatformAudioSource::suspend()
Stops processing audio data, preserving buffered audio data.
*/
/*!
\fn virtual void QPlatformAudioSource::resume()
Resumes processing audio data after a suspend().
*/
/*!
\fn virtual qsizetype QPlatformAudioSource::bytesReady() const
Returns the amount of audio data available to read in bytes.
*/
/*!
\fn virtual void QPlatformAudioSource::setBufferSize(qsizetype value)
Sets the audio buffer size to \a value in milliseconds.
*/
/*!
\fn virtual qsizetype QPlatformAudioSource::bufferSize() const
Returns the audio buffer size in milliseconds.
*/
/*!
\fn virtual qint64 QPlatformAudioSource::processedUSecs() const
Returns the amount of audio data processed since start() was called in milliseconds.
*/
/*!
\fn virtual QAudio::Error QPlatformAudioSource::error() const
Returns the error state.
*/
/*!
\fn virtual QAudio::State QPlatformAudioSource::state() const
Returns the state of audio processing.
*/
/*!
\fn virtual void QPlatformAudioSource::setFormat(const QAudioFormat& fmt)
Set the QAudioFormat to use to \a fmt.
Setting the format is only allowable while in QAudio::StoppedState.
*/
/*!
\fn virtual QAudioFormat QPlatformAudioSource::format() const
Returns the QAudioFormat being used
*/
/*!
\fn QPlatformAudioSource::errorChanged(QAudio::Error error)
This signal is emitted when the \a error state has changed.
*/
/*!
\fn QPlatformAudioSource::stateChanged(QAudio::State state)
This signal is emitted when the device \a state has changed.
*/
QT_END_NAMESPACE
#include "moc_qaudiosystem_p.cpp"
|
