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
261
262
263
264
265
266
267
|
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:COMM$
**
** 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.
**
** $QT_END_LICENSE$
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
****************************************************************************/
#include "qmediacontrol_p.h"
#include "qaudiodecodercontrol.h"
QT_BEGIN_NAMESPACE
/*!
\class QAudioDecoderControl
\obsolete
\inmodule QtMultimedia
\ingroup multimedia_control
\brief The QAudioDecoderControl class provides access to the audio decoding
functionality of a QMediaService.
\preliminary
The functionality provided by this control is exposed to application
code through the QAudioDecoder class.
The interface name of QAudioDecoderControl is \c org.qt-project.qt.audiodecodercontrol/5.0 as
defined in QAudioDecoderControl_iid.
\sa QMediaService::requestControl(), QAudioDecoder
*/
/*!
\macro QAudioDecoderControl_iid
\c org.qt-project.qt.audiodecodercontrol/5.0
Defines the interface name of the QAudioDecoderControl class.
\relates QAudioDecoderControl
*/
/*!
Destroys an audio decoder control.
*/
QAudioDecoderControl::~QAudioDecoderControl()
{
}
/*!
Constructs a new audio decoder control with the given \a parent.
*/
QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
QMediaControl(*new QMediaControlPrivate, parent)
{
}
/*!
\fn QAudioDecoderControl::state() const
Returns the state of a player control.
*/
/*!
\fn QAudioDecoderControl::stateChanged(QAudioDecoder::State newState)
Signals that the state of a player control has changed to \a newState.
\sa state()
*/
/*!
\fn QAudioDecoderControl::sourceFilename() const
Returns the current media source filename, or a null QString if none (or a device)
*/
/*!
\fn QAudioDecoderControl::setSourceFilename(const QString &fileName)
Sets the current source to \a fileName. Changing the source will
stop any current decoding and discard any buffers.
Sources are exclusive, so only one can be set.
*/
/*!
\fn QAudioDecoderControl::sourceDevice() const
Returns the current media source QIODevice, or 0 if none (or a file).
*/
/*!
\fn QAudioDecoderControl::setSourceDevice(QIODevice *device)
Sets the current source to \a device. Changing the source will
stop any current decoding and discard any buffers.
Sources are exclusive, so only one can be set.
*/
/*!
\fn QAudioDecoderControl::start()
Starts decoding the current media.
If successful the player control will immediately enter the \l {QAudioDecoder::DecodingState}
{decoding} state.
\sa state(), read()
*/
/*!
\fn QAudioDecoderControl::stop()
Stops playback of the current media and discards any buffers.
If successful the player control will immediately enter the \l {QAudioDecoder::StoppedState}
{stopped} state.
*/
/*!
\fn QAudioDecoderControl::error(int error, const QString &errorString)
Signals that an \a error has occurred. The \a errorString provides a more detailed explanation.
*/
/*!
\fn QAudioDecoderControl::bufferAvailableChanged(bool available)
Signals that the bufferAvailable property has changed to \a available.
*/
/*!
\fn QAudioDecoderControl::bufferReady()
Signals that a new buffer is ready for reading.
*/
/*!
\fn QAudioDecoderControl::bufferAvailable() const
Returns true if a buffer is available to be read,
and false otherwise.
*/
/*!
\fn QAudioDecoderControl::sourceChanged()
Signals that the current source of the decoder has changed.
\sa sourceFilename(), sourceDevice()
*/
/*!
\fn QAudioDecoderControl::formatChanged(const QAudioFormat &format)
Signals that the current audio format of the decoder has changed to \a format.
\sa audioFormat(), setAudioFormat()
*/
/*!
\fn void QAudioDecoderControl::finished()
Signals that the decoding has finished successfully.
If decoding fails, error signal is emitted instead.
\sa start(), stop(), error()
*/
/*!
\fn void QAudioDecoderControl::positionChanged(qint64 position)
Signals that the current \a position of the decoder has changed.
\sa durationChanged()
*/
/*!
\fn void QAudioDecoderControl::durationChanged(qint64 duration)
Signals that the estimated \a duration of the decoded data has changed.
\sa positionChanged()
*/
/*!
\fn QAudioDecoderControl::audioFormat() const
Returns the current audio format of the decoded stream.
Any buffers returned should have this format.
\sa setAudioFormat(), formatChanged()
*/
/*!
\fn QAudioDecoderControl::setAudioFormat(const QAudioFormat &format)
Set the desired audio format for decoded samples to \a format.
If the decoder does not support this format, \l error() will
be set to \c FormatError.
If you do not specify a format, the format of the decoded
audio itself will be used. Otherwise, some format conversion
will be applied.
If you wish to reset the decoded format to that of the original
audio file, you can specify an invalid \a format.
*/
/*!
\fn QAudioDecoderControl::read()
Attempts to read a buffer from the decoder, without blocking. Returns invalid buffer if there are
no decoded buffers available, or on error.
*/
/*!
\fn QAudioDecoderControl::position() const
Returns position (in milliseconds) of the last buffer read from
the decoder or -1 if no buffers have been read.
*/
/*!
\fn QAudioDecoderControl::duration() const
Returns total duration (in milliseconds) of the audio stream
or -1 if not available.
*/
QT_END_NAMESPACE
#include "moc_qaudiodecodercontrol.cpp"
|
