qtmultimedia5-doc-html 5.9.5-0ubuntu1 / usr / share / qt5 / doc / qtmultimedia / qaudiodecoder.html

This file is indexed.

/usr/share/qt5/doc/qtmultimedia/qaudiodecoder.html is in qtmultimedia5-doc-html 5.9.5-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qaudiodecoder.cpp -->
  <title>QAudioDecoder Class | Qt Multimedia 5.9</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.9</td><td ><a href="qtmultimedia-index.html">Qt Multimedia</a></td><td ><a href="qtmultimedia-modules.html">C++ Classes</a></td><td >QAudioDecoder</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 Reference Documentation</td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QAudioDecoder Class</h1>
<!-- $$$QAudioDecoder-brief -->
<p>The <a href="qaudiodecoder.html">QAudioDecoder</a> class allows decoding audio. <a href="#details">More...</a></p>
<!-- @@@QAudioDecoder -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QAudioDecoder&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += multimedia</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qmediaobject.html">QMediaObject</a></td></tr></table></div><p><b>This class is under development and is subject to change.</b></p>
<ul>
<li><a href="qaudiodecoder-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#Error-enum">Error</a></b> { NoError, ResourceError, FormatError, AccessDeniedError, ServiceMissingError }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#State-enum">State</a></b> { StoppedState, DecodingState }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qaudiodecoder.html#bufferAvailable-prop">bufferAvailable</a></b> : const bool</li>
<li class="fn"><b><a href="qaudiodecoder.html#error-prop">error</a></b> : const QString</li>
<li class="fn"><b><a href="qaudiodecoder.html#sourceFilename-prop">sourceFilename</a></b> : QString</li>
<li class="fn"><b><a href="qaudiodecoder.html#state-prop">state</a></b> : const State</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="qmediaobject.html#properties">QMediaObject</a></li>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#QAudioDecoder">QAudioDecoder</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#dtor.QAudioDecoder">~QAudioDecoder</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QAudioFormat </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#audioFormat">audioFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#bufferAvailable">bufferAvailable</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qint64 </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#duration">duration</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Error </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#error">error</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#error-prop">errorString</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qint64 </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#position">position</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QAudioBuffer </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#read">read</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#setAudioFormat">setAudioFormat</a></b>(const QAudioFormat &amp;<i>format</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#setSourceDevice">setSourceDevice</a></b>(QIODevice *<i>device</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#setSourceFilename">setSourceFilename</a></b>(const QString &amp;<i>fileName</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QIODevice *</td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#sourceDevice">sourceDevice</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#sourceFilename">sourceFilename</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> State </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#state-prop">state</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">10 public functions inherited from <a href="qmediaobject.html#public-functions">QMediaObject</a></li>
<li class="fn">32 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#start">start</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#stop">stop</a></b>()</td></tr>
</table></div>
<ul>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#bufferAvailableChanged">bufferAvailableChanged</a></b>(bool <i>available</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#bufferReady">bufferReady</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#durationChanged">durationChanged</a></b>(qint64 <i>duration</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#error-1">error</a></b>(QAudioDecoder::Error <i>error</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#finished">finished</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#formatChanged">formatChanged</a></b>(const QAudioFormat &amp;<i>format</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#positionChanged">positionChanged</a></b>(qint64 <i>position</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#sourceChanged">sourceChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#stateChanged">stateChanged</a></b>(QAudioDecoder::State <i>state</i>)</td></tr>
</table></div>
<ul>
<li class="fn">6 signals inherited from <a href="qmediaobject.html#signals">QMediaObject</a></li>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
</ul>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QMultimedia::SupportEstimate </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#hasSupport">hasSupport</a></b>(const QString &amp;<i>mimeType</i>, const QStringList &amp;<i>codecs</i> = QStringList())</td></tr>
</table></div>
<ul>
<li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li>
<li class="fn">2 protected functions inherited from <a href="qmediaobject.html#protected-functions">QMediaObject</a></li>
<li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAudioDecoder-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qaudiodecoder.html">QAudioDecoder</a> class allows decoding audio.</p>
<p>The <a href="qaudiodecoder.html">QAudioDecoder</a> class is a high level class for decoding local audio media files. It is similar to the <a href="qmediaplayer.html">QMediaPlayer</a> class except that audio is provided back through this API rather than routed directly to audio hardware, and playlists and network and streaming based media is not supported.</p>
</div>
<p><b>See also </b><a href="qaudiobuffer.html">QAudioBuffer</a>.</p>
<!-- @@@QAudioDecoder -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Error$$$NoError$$$ResourceError$$$FormatError$$$AccessDeniedError$$$ServiceMissingError -->
<h3 class="fn" id="Error-enum"><a name="Error-enum"></a>enum QAudioDecoder::<span class="name">Error</span></h3>
<p>Defines a media player error condition.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QAudioDecoder::NoError</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">No error has occurred.</td></tr>
<tr><td class="topAlign"><code>QAudioDecoder::ResourceError</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">A media resource couldn't be resolved.</td></tr>
<tr><td class="topAlign"><code>QAudioDecoder::FormatError</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The format of a media resource isn't supported.</td></tr>
<tr><td class="topAlign"><code>QAudioDecoder::AccessDeniedError</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">There are not the appropriate permissions to play a media resource.</td></tr>
<tr><td class="topAlign"><code>QAudioDecoder::ServiceMissingError</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">A valid playback service was not found, playback cannot proceed.</td></tr>
</table></div>
<!-- @@@Error -->
<!-- $$$State$$$StoppedState$$$DecodingState -->
<h3 class="fn" id="State-enum"><a name="State-enum"></a>enum QAudioDecoder::<span class="name">State</span></h3>
<p>Defines the current state of a media player.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QAudioDecoder::StoppedState</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The decoder is not decoding. Decoding will start at the start of the media.</td></tr>
<tr><td class="topAlign"><code>QAudioDecoder::DecodingState</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The audio player is currently decoding media.</td></tr>
</table></div>
<!-- @@@State -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$bufferAvailable-prop$$$bufferAvailable$$$bufferAvailableChangedbool -->
<h3 class="fn" id="bufferAvailable-prop"><a name="bufferAvailable-prop"></a><span class="name">bufferAvailable</span> : const <span class="type">bool</span></h3>
<p>This property holds whether there is a decoded audio buffer available</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qaudiodecoder.html#bufferAvailable">bufferAvailable</a></b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qaudiodecoder.html#bufferAvailableChanged">bufferAvailableChanged</a></b></span>(bool <i>available</i>)</td></tr>
</table></div>
<!-- @@@bufferAvailable -->
<!-- $$$error-prop$$$errorString -->
<h3 class="fn" id="error-prop"><a name="error-prop"></a><span class="name">error</span> : const <span class="type"><a href="../qtcore/qstring.html">QString</a></span></h3>
<p>This property holds a string describing the last error condition.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>errorString</b></span>() const</td></tr>
</table></div>
<p><b>See also </b><a href="qaudiodecoder.html#error">error</a>().</p>
<!-- @@@error -->
<!-- $$$sourceFilename-prop$$$sourceFilename$$$setSourceFilenameconstQString&$$$sourceChanged -->
<h3 class="fn" id="sourceFilename-prop"><a name="sourceFilename-prop"></a><span class="name">sourceFilename</span> : <span class="type"><a href="../qtcore/qstring.html">QString</a></span></h3>
<p>This property holds the active filename being decoded by the decoder object.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qaudiodecoder.html#sourceFilename">sourceFilename</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qaudiodecoder.html#setSourceFilename">setSourceFilename</a></b></span>(const QString &amp;<i>fileName</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qaudiodecoder.html#sourceChanged">sourceChanged</a></b></span>()</td></tr>
</table></div>
<!-- @@@sourceFilename -->
<!-- $$$state-prop$$$state$$$stateChangedQAudioDecoder::State -->
<h3 class="fn" id="state-prop"><a name="state-prop"></a><span class="name">state</span> : const <span class="type"><a href="qaudiodecoder.html#State-enum">State</a></span></h3>
<p>This property holds the audio decoder's playback state.</p>
<p>By default this property is QAudioDecoder::Stopped</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> State </td><td class="memItemRight bottomAlign"><span class="name"><b>state</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qaudiodecoder.html#stateChanged">stateChanged</a></b></span>(QAudioDecoder::State <i>state</i>)</td></tr>
</table></div>
<p><b>See also </b><a href="qaudiodecoder.html#start">start</a>() and <a href="qaudiodecoder.html#stop">stop</a>().</p>
<!-- @@@state -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAudioDecoder[overload1]$$$QAudioDecoderQObject* -->
<h3 class="fn" id="QAudioDecoder"><a name="QAudioDecoder"></a>QAudioDecoder::<span class="name">QAudioDecoder</span>(<span class="type"><a href="../qtcore/qobject.html#QObject">QObject</a></span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Construct an <a href="qaudiodecoder.html">QAudioDecoder</a> instance parented to <i>parent</i>.</p>
<!-- @@@QAudioDecoder -->
<!-- $$$~QAudioDecoder[overload1]$$$~QAudioDecoder -->
<h3 class="fn" id="dtor.QAudioDecoder"><a name="dtor.QAudioDecoder"></a>QAudioDecoder::<span class="name">~QAudioDecoder</span>()</h3>
<p>Destroys the audio decoder object.</p>
<!-- @@@~QAudioDecoder -->
<!-- $$$audioFormat[overload1]$$$audioFormat -->
<h3 class="fn" id="audioFormat"><a name="audioFormat"></a><span class="type"><a href="qaudioformat.html">QAudioFormat</a></span> QAudioDecoder::<span class="name">audioFormat</span>() const</h3>
<p>Returns the current audio format of the decoded stream.</p>
<p>Any buffers returned should have this format.</p>
<p><b>See also </b><a href="qaudiodecoder.html#setAudioFormat">setAudioFormat</a>() and <a href="qaudiodecoder.html#formatChanged">formatChanged</a>().</p>
<!-- @@@audioFormat -->
<!-- $$$bufferAvailable -->
<h3 class="fn" id="bufferAvailable"><a name="bufferAvailable"></a><span class="type">bool</span> QAudioDecoder::<span class="name">bufferAvailable</span>() const</h3>
<p>Returns true if a buffer is available to be read, and false otherwise. If there is no buffer available, calling the <a href="qaudiodecoder.html#read">read</a>() function will return an invalid buffer.</p>
<p><b>Note:</b> Getter function for property <a href="qaudiodecoder.html#bufferAvailable-prop">bufferAvailable</a>. </p><!-- @@@bufferAvailable -->
<!-- $$$bufferAvailableChanged -->
<h3 class="fn" id="bufferAvailableChanged"><a name="bufferAvailableChanged"></a><code>[signal] </code><span class="type">void</span> QAudioDecoder::<span class="name">bufferAvailableChanged</span>(<span class="type">bool</span> <i>available</i>)</h3>
<p>Signals the availability (if <i>available</i> is true) of a new buffer.</p>
<p>If <i>available</i> is false, there are no buffers available.</p>
<p><b>Note:</b> Notifier signal for property <a href="qaudiodecoder.html#bufferAvailable-prop">bufferAvailable</a>. </p><p><b>See also </b><a href="qaudiodecoder.html#bufferAvailable">bufferAvailable</a>() and <a href="qaudiodecoder.html#bufferReady">bufferReady</a>().</p>
<!-- @@@bufferAvailableChanged -->
<!-- $$$bufferReady[overload1]$$$bufferReady -->
<h3 class="fn" id="bufferReady"><a name="bufferReady"></a><code>[signal] </code><span class="type">void</span> QAudioDecoder::<span class="name">bufferReady</span>()</h3>
<p>Signals that a new decoded audio buffer is available to be read.</p>
<p><b>See also </b><a href="qaudiodecoder.html#read">read</a>() and <a href="qaudiodecoder.html#bufferAvailable">bufferAvailable</a>().</p>
<!-- @@@bufferReady -->
<!-- $$$duration[overload1]$$$duration -->
<h3 class="fn" id="duration"><a name="duration"></a><span class="type"><a href="../qtcore/qtglobal.html#qint64-typedef">qint64</a></span> QAudioDecoder::<span class="name">duration</span>() const</h3>
<p>Returns total duration (in milliseconds) of the audio stream or -1 if not available.</p>
<!-- @@@duration -->
<!-- $$$durationChanged[overload1]$$$durationChangedqint64 -->
<h3 class="fn" id="durationChanged"><a name="durationChanged"></a><code>[signal] </code><span class="type">void</span> QAudioDecoder::<span class="name">durationChanged</span>(<span class="type"><a href="../qtcore/qtglobal.html#qint64-typedef">qint64</a></span> <i>duration</i>)</h3>
<p>Signals that the estimated <i>duration</i> of the decoded data has changed.</p>
<p><b>See also </b><a href="qaudiodecoder.html#positionChanged">positionChanged</a>().</p>
<!-- @@@durationChanged -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn" id="error"><a name="error"></a><span class="type"><a href="qaudiodecoder.html#Error-enum">Error</a></span> QAudioDecoder::<span class="name">error</span>() const</h3>
<p>Returns the current error state.</p>
<!-- @@@error -->
<!-- $$$error$$$errorQAudioDecoder::Error -->
<h3 class="fn" id="error-1"><a name="error-1"></a><code>[signal] </code><span class="type">void</span> QAudioDecoder::<span class="name">error</span>(<span class="type"><a href="qaudiodecoder.html#Error-enum">QAudioDecoder::Error</a></span> <i>error</i>)</h3>
<p>Signals that an <i>error</i> condition has occurred.</p>
<p><b>Note:</b> Signal <i>error</i> is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:<pre class="cpp">

  connect(audioDecoder<span class="operator">,</span> <span class="keyword">static_cast</span><span class="operator">&lt;</span><span class="type">void</span>(<span class="type"><a href="qaudiodecoder.html#QAudioDecoder">QAudioDecoder</a></span><span class="operator">::</span><span class="operator">*</span>)(<span class="type"><a href="qaudiodecoder.html#QAudioDecoder">QAudioDecoder</a></span><span class="operator">::</span>Error)<span class="operator">&gt;</span>(<span class="operator">&amp;</span><span class="type"><a href="qaudiodecoder.html#QAudioDecoder">QAudioDecoder</a></span><span class="operator">::</span>error)<span class="operator">,</span>
      <span class="operator">[</span><span class="operator">=</span><span class="operator">]</span>(<span class="type"><a href="qaudiodecoder.html#QAudioDecoder">QAudioDecoder</a></span><span class="operator">::</span>Error error){ <span class="comment">/* ... */</span> });

</pre>
<p><b>See also </b><a href="qaudiodecoder.html#error-prop">errorString</a>().</p>
<!-- @@@error -->
<!-- $$$finished[overload1]$$$finished -->
<h3 class="fn" id="finished"><a name="finished"></a><code>[signal] </code><span class="type">void</span> QAudioDecoder::<span class="name">finished</span>()</h3>
<p>Signals that the decoding has finished successfully. If decoding fails, error signal is emitted instead.</p>
<p><b>See also </b><a href="qaudiodecoder.html#start">start</a>(), <a href="qaudiodecoder.html#stop">stop</a>(), and <a href="qaudiodecoder.html#error">error</a>().</p>
<!-- @@@finished -->
<!-- $$$formatChanged[overload1]$$$formatChangedconstQAudioFormat& -->
<h3 class="fn" id="formatChanged"><a name="formatChanged"></a><code>[signal] </code><span class="type">void</span> QAudioDecoder::<span class="name">formatChanged</span>(const <span class="type"><a href="qaudioformat.html">QAudioFormat</a></span> &amp;<i>format</i>)</h3>
<p>Signals that the current audio format of the decoder has changed to <i>format</i>.</p>
<p><b>See also </b><a href="qaudiodecoder.html#audioFormat">audioFormat</a>() and <a href="qaudiodecoder.html#setAudioFormat">setAudioFormat</a>().</p>
<!-- @@@formatChanged -->
<!-- $$$hasSupport[overload1]$$$hasSupportconstQString&constQStringList& -->
<h3 class="fn" id="hasSupport"><a name="hasSupport"></a><code>[static] </code><span class="type"><a href="qmultimedia.html#SupportEstimate-enum">QMultimedia::SupportEstimate</a></span> QAudioDecoder::<span class="name">hasSupport</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;<i>mimeType</i>, const <span class="type"><a href="../qtcore/qstringlist.html">QStringList</a></span> &amp;<i>codecs</i> = QStringList())</h3>
<p>Returns the level of support an audio decoder has for a <i>mimeType</i> and a set of <i>codecs</i>.</p>
<!-- @@@hasSupport -->
<!-- $$$position[overload1]$$$position -->
<h3 class="fn" id="position"><a name="position"></a><span class="type"><a href="../qtcore/qtglobal.html#qint64-typedef">qint64</a></span> QAudioDecoder::<span class="name">position</span>() const</h3>
<p>Returns position (in milliseconds) of the last buffer read from the decoder or -1 if no buffers have been read.</p>
<!-- @@@position -->
<!-- $$$positionChanged[overload1]$$$positionChangedqint64 -->
<h3 class="fn" id="positionChanged"><a name="positionChanged"></a><code>[signal] </code><span class="type">void</span> QAudioDecoder::<span class="name">positionChanged</span>(<span class="type"><a href="../qtcore/qtglobal.html#qint64-typedef">qint64</a></span> <i>position</i>)</h3>
<p>Signals that the current <i>position</i> of the decoder has changed.</p>
<p><b>See also </b><a href="qaudiodecoder.html#durationChanged">durationChanged</a>().</p>
<!-- @@@positionChanged -->
<!-- $$$read[overload1]$$$read -->
<h3 class="fn" id="read"><a name="read"></a><span class="type"><a href="qaudiobuffer.html">QAudioBuffer</a></span> QAudioDecoder::<span class="name">read</span>() const</h3>
<p>Read a buffer from the decoder, if one is available. Returns an invalid buffer if there are no decoded buffers currently available, or on failure. In both cases this function will not block.</p>
<p>You should either respond to the <a href="qaudiodecoder.html#bufferReady">bufferReady</a>() signal or check the <a href="qaudiodecoder.html#bufferAvailable">bufferAvailable</a>() function before calling read() to make sure you get useful data.</p>
<!-- @@@read -->
<!-- $$$setAudioFormat[overload1]$$$setAudioFormatconstQAudioFormat& -->
<h3 class="fn" id="setAudioFormat"><a name="setAudioFormat"></a><span class="type">void</span> QAudioDecoder::<span class="name">setAudioFormat</span>(const <span class="type"><a href="qaudioformat.html">QAudioFormat</a></span> &amp;<i>format</i>)</h3>
<p>Set the desired audio format for decoded samples to <i>format</i>.</p>
<p>This property can only be set while the decoder is stopped. Setting this property at other times will be ignored.</p>
<p>If the decoder does not support this format, <a href="qaudiodecoder.html#error">error</a>() will be set to <code>FormatError</code>.</p>
<p>If you do not specify a format, the format of the decoded audio itself will be used. Otherwise, some format conversion will be applied.</p>
<p>If you wish to reset the decoded format to that of the original audio file, you can specify an invalid <i>format</i>.</p>
<p><b>See also </b><a href="qaudiodecoder.html#audioFormat">audioFormat</a>().</p>
<!-- @@@setAudioFormat -->
<!-- $$$setSourceDevice[overload1]$$$setSourceDeviceQIODevice* -->
<h3 class="fn" id="setSourceDevice"><a name="setSourceDevice"></a><span class="type">void</span> QAudioDecoder::<span class="name">setSourceDevice</span>(<span class="type"><a href="../qtcore/qiodevice.html">QIODevice</a></span> *<i>device</i>)</h3>
<p>Sets the current audio <a href="../qtcore/qiodevice.html">QIODevice</a> to <i>device</i>.</p>
<p>When this property is set any current decoding is stopped, and any audio buffers are discarded.</p>
<p>You can only specify either a source filename or a source <a href="../qtcore/qiodevice.html">QIODevice</a>. Setting one will unset the other.</p>
<p><b>See also </b><a href="qaudiodecoder.html#sourceDevice">sourceDevice</a>().</p>
<!-- @@@setSourceDevice -->
<!-- $$$setSourceFilename -->
<h3 class="fn" id="setSourceFilename"><a name="setSourceFilename"></a><span class="type">void</span> QAudioDecoder::<span class="name">setSourceFilename</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;<i>fileName</i>)</h3>
<p>Sets the current audio file name to <i>fileName</i>.</p>
<p>When this property is set any current decoding is stopped, and any audio buffers are discarded.</p>
<p>You can only specify either a source filename or a source <a href="../qtcore/qiodevice.html">QIODevice</a>. Setting one will unset the other.</p>
<p><b>Note:</b> Setter function for property <a href="qaudiodecoder.html#sourceFilename-prop">sourceFilename</a>. </p><p><b>See also </b><a href="qaudiodecoder.html#sourceFilename">sourceFilename</a>().</p>
<!-- @@@setSourceFilename -->
<!-- $$$sourceChanged -->
<h3 class="fn" id="sourceChanged"><a name="sourceChanged"></a><code>[signal] </code><span class="type">void</span> QAudioDecoder::<span class="name">sourceChanged</span>()</h3>
<p>Signals that the current source of the decoder has changed.</p>
<p><b>Note:</b> Notifier signal for property <a href="qaudiodecoder.html#sourceFilename-prop">sourceFilename</a>. </p><p><b>See also </b><a href="qaudiodecoder.html#sourceFilename">sourceFilename</a>() and <a href="qaudiodecoder.html#sourceDevice">sourceDevice</a>().</p>
<!-- @@@sourceChanged -->
<!-- $$$sourceDevice[overload1]$$$sourceDevice -->
<h3 class="fn" id="sourceDevice"><a name="sourceDevice"></a><span class="type"><a href="../qtcore/qiodevice.html">QIODevice</a></span> *QAudioDecoder::<span class="name">sourceDevice</span>() const</h3>
<p>Returns the current source <a href="../qtcore/qiodevice.html">QIODevice</a>, if one was set. If <a href="qaudiodecoder.html#setSourceFilename">setSourceFilename</a>() was called, this will be 0.</p>
<p><b>See also </b><a href="qaudiodecoder.html#setSourceDevice">setSourceDevice</a>().</p>
<!-- @@@sourceDevice -->
<!-- $$$sourceFilename -->
<h3 class="fn" id="sourceFilename"><a name="sourceFilename"></a><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QAudioDecoder::<span class="name">sourceFilename</span>() const</h3>
<p>Returns the current file name to decode. If <a href="qaudiodecoder.html#setSourceDevice">setSourceDevice</a> was called, this will be empty.</p>
<p><b>Note:</b> Getter function for property <a href="qaudiodecoder.html#sourceFilename-prop">sourceFilename</a>. </p><p><b>See also </b><a href="qaudiodecoder.html#setSourceFilename">setSourceFilename</a>().</p>
<!-- @@@sourceFilename -->
<!-- $$$start[overload1]$$$start -->
<h3 class="fn" id="start"><a name="start"></a><code>[slot] </code><span class="type">void</span> QAudioDecoder::<span class="name">start</span>()</h3>
<p>Starts decoding the audio resource.</p>
<p>As data gets decoded, the <a href="qaudiodecoder.html#bufferReady">bufferReady</a>() signal will be emitted when enough data has been decoded. Calling <a href="qaudiodecoder.html#read">read</a>() will then return an audio buffer without blocking.</p>
<p>If you call <a href="qaudiodecoder.html#read">read</a>() before a buffer is ready, an invalid buffer will be returned, again without blocking.</p>
<p><b>See also </b><a href="qaudiodecoder.html#read">read</a>().</p>
<!-- @@@start -->
<!-- $$$stateChanged -->
<h3 class="fn" id="stateChanged"><a name="stateChanged"></a><code>[signal] </code><span class="type">void</span> QAudioDecoder::<span class="name">stateChanged</span>(<span class="type"><a href="qaudiodecoder.html#State-enum">QAudioDecoder::State</a></span> <i>state</i>)</h3>
<p>Signal the <i>state</i> of the decoder object has changed.</p>
<p><b>Note:</b> Notifier signal for property <a href="qaudiodecoder.html#state-prop">state</a>. </p><!-- @@@stateChanged -->
<!-- $$$stop[overload1]$$$stop -->
<h3 class="fn" id="stop"><a name="stop"></a><code>[slot] </code><span class="type">void</span> QAudioDecoder::<span class="name">stop</span>()</h3>
<p>Stop decoding audio. Calling <a href="qaudiodecoder.html#start">start</a>() again will resume decoding from the beginning.</p>
<!-- @@@stop -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2017 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.