/usr/share/qt5/doc/qtmultimedia/qaudiodecoder.html is in qtmultimedia5-doc-html 5.2.1-0ubuntu5.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qaudiodecoder.cpp -->
<title>QAudioDecoder Class | QtMultimedia 5.2</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtmultimedia-index.html">Qt Multimedia</a></li>
<li><a href="qtmultimedia-module.html">C++ Classes</a></li>
<li>QAudioDecoder</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<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>
<h1 class="title">QAudioDecoder Class</h1>
<!-- $$$QAudioDecoder-brief -->
<p>The QAudioDecoder class allows decoding audio. <a href="#details">More...</a></p>
<!-- @@@QAudioDecoder -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QAudioDecoder></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += multimedia</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qmediaobject.html">QMediaObject</a>.</td></tr></table><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>Public Types</h2>
<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>
<a name="properties"></a>
<h2>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>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<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> = 0)</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-prop">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 &<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#sourceFilename-prop">setSourceFilename</a></b>(const QString &<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-prop">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>
<ul>
<li class="fn">10 public functions inherited from <a href="qmediaobject.html#public-functions">QMediaObject</a></li>
</ul>
<a name="public-slots"></a>
<h2>Public Slots</h2>
<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>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#bufferAvailable-prop">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-2">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 &<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#sourceFilename-prop">sourceChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiodecoder.html#state-prop">stateChanged</a></b>(QAudioDecoder::State<i> state</i>)</td></tr>
</table>
<ul>
<li class="fn">6 signals inherited from <a href="qmediaobject.html#signals">QMediaObject</a></li>
</ul>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<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 &<i> mimeType</i>, const QStringList &<i> codecs</i> = QStringList())</td></tr>
</table>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">2 protected functions inherited from <a href="qmediaobject.html#protected-functions">QMediaObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAudioDecoder-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QAudioDecoder class allows decoding audio.</p>
<p>The QAudioDecoder 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"><a name="Error-enum"></a>enum QAudioDecoder::<span class="name">Error</span></h3>
<p>Defines a media player error condition.</p>
<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"><tt>QAudioDecoder::NoError</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">No error has occurred.</td></tr>
<tr><td class="topAlign"><tt>QAudioDecoder::ResourceError</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">A media resource couldn't be resolved.</td></tr>
<tr><td class="topAlign"><tt>QAudioDecoder::FormatError</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The format of a media resource isn't supported.</td></tr>
<tr><td class="topAlign"><tt>QAudioDecoder::AccessDeniedError</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">There are not the appropriate permissions to play a media resource.</td></tr>
<tr><td class="topAlign"><tt>QAudioDecoder::ServiceMissingError</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">A valid playback service was not found, playback cannot proceed.</td></tr>
</table>
<!-- @@@Error -->
<!-- $$$State$$$StoppedState$$$DecodingState -->
<h3 class="fn"><a name="State-enum"></a>enum QAudioDecoder::<span class="name">State</span></h3>
<p>Defines the current state of a media player.</p>
<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"><tt>QAudioDecoder::StoppedState</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The decoder is not decoding. Decoding will start at the start of the media.</td></tr>
<tr><td class="topAlign"><tt>QAudioDecoder::DecodingState</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The audio player is currently decoding media.</td></tr>
</table>
<!-- @@@State -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$bufferAvailable-prop$$$bufferAvailable$$$bufferAvailableChangedbool -->
<h3 class="fn"><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>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>bufferAvailable</b></span>() const</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>bufferAvailableChanged</b></span>(bool<i> available</i>)</td></tr>
</table>
<!-- @@@bufferAvailable -->
<!-- $$$error-prop$$$errorString -->
<h3 class="fn"><a name="error-prop"></a><span class="name">error</span> : const <span class="type">QString</span></h3>
<p>This property holds a string describing the last error condition.</p>
<p><b>Access functions:</b></p>
<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>
<p><b>See also </b><a href="qaudiodecoder.html#error">error</a>().</p>
<!-- @@@error -->
<!-- $$$sourceFilename-prop$$$sourceFilename$$$setSourceFilenameconstQString&$$$sourceChanged -->
<h3 class="fn"><a name="sourceFilename-prop"></a><span class="name">sourceFilename</span> : <span class="type">QString</span></h3>
<p>This property holds the active filename being decoded by the decoder object.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>sourceFilename</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSourceFilename</b></span>(const QString &<i> fileName</i>)</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>sourceChanged</b></span>()</td></tr>
</table>
<!-- @@@sourceFilename -->
<!-- $$$state-prop$$$state$$$stateChangedQAudioDecoder::State -->
<h3 class="fn"><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>
<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>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>stateChanged</b></span>(QAudioDecoder::State<i> state</i>)</td></tr>
</table>
<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"><a name="QAudioDecoder"></a>QAudioDecoder::<span class="name">QAudioDecoder</span>(<span class="type">QObject</span> *<i> parent</i> = 0)</h3>
<p>Construct an <a href="qaudiodecoder.html">QAudioDecoder</a> instance parented to <i>parent</i>.</p>
<!-- @@@QAudioDecoder -->
<!-- $$$~QAudioDecoder[overload1]$$$~QAudioDecoder -->
<h3 class="fn"><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"><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 -->
<!-- $$$bufferReady[overload1]$$$bufferReady -->
<h3 class="fn"><a name="bufferReady"></a><span class="type">void</span> QAudioDecoder::<span class="name">bufferReady</span>()<tt> [signal]</tt></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-prop">bufferAvailable</a>().</p>
<!-- @@@bufferReady -->
<!-- $$$duration[overload1]$$$duration -->
<h3 class="fn"><a name="duration"></a><span class="type">qint64</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"><a name="durationChanged"></a><span class="type">void</span> QAudioDecoder::<span class="name">durationChanged</span>(<span class="type">qint64</span><i> duration</i>)<tt> [signal]</tt></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"><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"><a name="error-2"></a><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>)<tt> [signal]</tt></h3>
<p>Signals that an <i>error</i> condition has occurred.</p>
<p><b>See also </b><a href="qaudiodecoder.html#error-prop">errorString</a>().</p>
<!-- @@@error -->
<!-- $$$finished[overload1]$$$finished -->
<h3 class="fn"><a name="finished"></a><span class="type">void</span> QAudioDecoder::<span class="name">finished</span>()<tt> [signal]</tt></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"><a name="formatChanged"></a><span class="type">void</span> QAudioDecoder::<span class="name">formatChanged</span>(const <span class="type"><a href="qaudioformat.html">QAudioFormat</a></span> &<i> format</i>)<tt> [signal]</tt></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"><a name="hasSupport"></a><span class="type"><a href="qmultimedia.html#SupportEstimate-enum">QMultimedia::SupportEstimate</a></span> QAudioDecoder::<span class="name">hasSupport</span>(const <span class="type">QString</span> &<i> mimeType</i>, const <span class="type">QStringList</span> &<i> codecs</i> = QStringList())<tt> [static]</tt></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"><a name="position"></a><span class="type">qint64</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"><a name="positionChanged"></a><span class="type">void</span> QAudioDecoder::<span class="name">positionChanged</span>(<span class="type">qint64</span><i> position</i>)<tt> [signal]</tt></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"><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-prop">bufferAvailable</a>() function before calling read() to make sure you get useful data.</p>
<!-- @@@read -->
<!-- $$$setAudioFormat[overload1]$$$setAudioFormatconstQAudioFormat& -->
<h3 class="fn"><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> &<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 <tt>FormatError</tt>.</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"><a name="setSourceDevice"></a><span class="type">void</span> QAudioDecoder::<span class="name">setSourceDevice</span>(<span class="type">QIODevice</span> *<i> device</i>)</h3>
<p>Sets the current audio QIODevice 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 QIODevice. Setting one will unset the other.</p>
<p><b>See also </b><a href="qaudiodecoder.html#sourceDevice">sourceDevice</a>().</p>
<!-- @@@setSourceDevice -->
<!-- $$$sourceDevice[overload1]$$$sourceDevice -->
<h3 class="fn"><a name="sourceDevice"></a><span class="type">QIODevice</span> * QAudioDecoder::<span class="name">sourceDevice</span>() const</h3>
<p>Returns the current source QIODevice, if one was set. If <a href="qaudiodecoder.html#sourceFilename-prop">setSourceFilename</a>() was called, this will be 0.</p>
<p><b>See also </b><a href="qaudiodecoder.html#setSourceDevice">setSourceDevice</a>().</p>
<!-- @@@sourceDevice -->
<!-- $$$start[overload1]$$$start -->
<h3 class="fn"><a name="start"></a><span class="type">void</span> QAudioDecoder::<span class="name">start</span>()<tt> [slot]</tt></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 -->
<!-- $$$stop[overload1]$$$stop -->
<h3 class="fn"><a name="stop"></a><span class="type">void</span> QAudioDecoder::<span class="name">stop</span>()<tt> [slot]</tt></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">©</acronym> 2013 Digia Plc and/or its
subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|