qtmultimedia5-doc-html 5.5.1-4ubuntu2 / usr / share / qt5 / doc / qtmultimedia / qsoundeffect.html

This file is indexed.

/usr/share/qt5/doc/qtmultimedia/qsoundeffect.html is in qtmultimedia5-doc-html 5.5.1-4ubuntu2.

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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qsoundeffect.cpp -->
  <title>QSoundEffect Class | Qt Multimedia 5.5</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.5</li>
<li><a href="qtmultimedia-index.html">Qt Multimedia</a></li>
<li><a href="qtmultimedia-module.html">C++ Classes</a></li>
<li>QSoundEffect</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
    </ul>
    </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">QSoundEffect Class</h1>
<!-- $$$QSoundEffect-brief -->
<p>The <a href="qsoundeffect.html">QSoundEffect</a> class provides a way to play low latency sound effects. <a href="#details">More...</a></p>
<!-- @@@QSoundEffect -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;QSoundEffect&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"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qtmultimedia-soundeffect.html">SoundEffect</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtcore/qobject.html">QObject</a></td></tr></table></div><ul>
<li><a href="qsoundeffect-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="qsoundeffect.html#Loop-enum">Loop</a></b> { Infinite }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#Status-enum">Status</a></b> { Null, Loading, Ready, Error }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qsoundeffect.html#category-prop">category</a></b> : QString</li>
<li class="fn"><b><a href="qsoundeffect.html#loops-prop">loops</a></b> : int</li>
<li class="fn"><b><a href="qsoundeffect.html#loopsRemaining-prop">loopsRemaining</a></b> : const int</li>
<li class="fn"><b><a href="qsoundeffect.html#muted-prop">muted</a></b> : bool</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qsoundeffect.html#playing-prop">playing</a></b> : const bool</li>
<li class="fn"><b><a href="qsoundeffect.html#source-prop">source</a></b> : QUrl</li>
<li class="fn"><b><a href="qsoundeffect.html#status-prop">status</a></b> : const Status</li>
<li class="fn"><b><a href="qsoundeffect.html#volume-prop">volume</a></b> : qreal</li>
</ul>
</td></tr>
</table></div>
<ul>
<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="qsoundeffect.html#QSoundEffect">QSoundEffect</a></b>(QObject *<i> parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#dtor.QSoundEffect">~QSoundEffect</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#category-prop">category</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#isLoaded">isLoaded</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#muted-prop">isMuted</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#playing-prop">isPlaying</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#loops-prop">loopCount</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#loopsRemaining-prop">loopsRemaining</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#category-prop">setCategory</a></b>(const QString &amp;<i> category</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#loops-prop">setLoopCount</a></b>(int<i> loopCount</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#muted-prop">setMuted</a></b>(bool<i> muted</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#source-prop">setSource</a></b>(const QUrl &amp;<i> url</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#volume-prop">setVolume</a></b>(qreal<i> volume</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QUrl </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#source-prop">source</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Status </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#status-prop">status</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#volume-prop">volume</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">31 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="qsoundeffect.html#play">play</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.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="qsoundeffect.html#category-prop">categoryChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#loadedChanged">loadedChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#loops-prop">loopCountChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#loopsRemaining-prop">loopsRemainingChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#muted-prop">mutedChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#playing-prop">playingChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#source-prop">sourceChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#status-prop">statusChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#volume-prop">volumeChanged</a></b>()</td></tr>
</table></div>
<ul>
<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"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qsoundeffect.html#supportedMimeTypes">supportedMimeTypes</a></b>()</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">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>
<!-- $$$QSoundEffect-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qsoundeffect.html">QSoundEffect</a> class provides a way to play low latency sound effects.</p>
<p>This class allows you to play uncompressed audio files (typically WAV files) in a generally lower latency way, and is suitable for &quot;feedback&quot; type sounds in response to user actions (e.g&#x2e; virtual keyboard sounds, positive or negative feedback for popup dialogs, or game sounds). If low latency is not important, consider using the <a href="qmediaplayer.html">QMediaPlayer</a> class instead, since it supports a wider variety of media formats and is less resource intensive.</p>
<p>This example shows how a looping, somewhat quiet sound effect can be played:</p>
<pre class="cpp"><span class="type"><a href="qsoundeffect.html#QSoundEffect">QSoundEffect</a></span> effect;
effect<span class="operator">.</span>setSource(<span class="type"><a href="../qtcore/qurl.html">QUrl</a></span><span class="operator">::</span>fromLocalFile(<span class="string">&quot;engine.wav&quot;</span>));
effect<span class="operator">.</span>setLoopCount(<span class="type"><a href="qsoundeffect.html#QSoundEffect">QSoundEffect</a></span><span class="operator">::</span>Infinite);
effect<span class="operator">.</span>setVolume(<span class="number">0.25f</span>);
effect<span class="operator">.</span>play();</pre>
<p>Typically the sound effect should be reused, which allows all the parsing and preparation to be done ahead of time, and only triggered when necessary. This assists with lower latency audio playback.</p>
<pre class="cpp">MyGame()
    : m_explosion(<span class="keyword">this</span>)
{
    m_explosion<span class="operator">.</span>setSource(<span class="type"><a href="../qtcore/qurl.html">QUrl</a></span><span class="operator">::</span>fromLocalFile(<span class="string">&quot;explosion.wav&quot;</span>));
    m_explosion<span class="operator">.</span>setVolume(<span class="number">0.25f</span>);

    <span class="comment">// Set up click handling etc.</span>
    connect(clickSource<span class="operator">,</span> SIGNAL(clicked())<span class="operator">,</span> <span class="operator">&amp;</span>m_explosion<span class="operator">,</span> SLOT(play()));
}
<span class="keyword">private</span>:
<span class="type"><a href="qsoundeffect.html#QSoundEffect">QSoundEffect</a></span> m_explosion;</pre>
<p>Since <a href="qsoundeffect.html">QSoundEffect</a> requires slightly more resources to achieve lower latency playback, the platform may limit the number of simultaneously playing sound effects.</p>
</div>
<!-- @@@QSoundEffect -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Loop$$$Infinite -->
<h3 class="fn" id="Loop-enum"><a name="Loop-enum"></a>enum QSoundEffect::<span class="name">Loop</span></h3>
<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>QSoundEffect::Infinite</code></td><td class="topAlign"><code>-2</code></td><td class="topAlign">Used as a parameter to <a href="qsoundeffect.html#loops-prop">setLoopCount</a>() for infinite looping</td></tr>
</table></div>
<!-- @@@Loop -->
<!-- $$$Status$$$Null$$$Loading$$$Ready$$$Error -->
<h3 class="fn" id="Status-enum"><a name="Status-enum"></a>enum QSoundEffect::<span class="name">Status</span></h3>
<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>QSoundEffect::Null</code></td><td class="topAlign"><code>0</code></td><td class="topAlign">No source has been set or the source is null.</td></tr>
<tr><td class="topAlign"><code>QSoundEffect::Loading</code></td><td class="topAlign"><code>1</code></td><td class="topAlign">The <a href="qml-multimedia.html#soundeffect">SoundEffect</a> is trying to load the source.</td></tr>
<tr><td class="topAlign"><code>QSoundEffect::Ready</code></td><td class="topAlign"><code>2</code></td><td class="topAlign">The source is loaded and ready for play.</td></tr>
<tr><td class="topAlign"><code>QSoundEffect::Error</code></td><td class="topAlign"><code>3</code></td><td class="topAlign">An error occurred during operation, such as failure of loading the source.</td></tr>
</table></div>
<!-- @@@Status -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$category-prop$$$category$$$setCategoryconstQString&$$$categoryChanged -->
<h3 class="fn" id="category-prop"><a name="category-prop"></a><span class="name">category</span> : <span class="type"><a href="../qtcore/qstring.html">QString</a></span></h3>
<p>This property contains the <i>category</i> of this sound effect.</p>
<p>Some platforms can perform different audio routing for different categories, or may allow the user to set different volume levels for different categories.</p>
<p>This setting will be ignored on platforms that do not support audio categories.</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>category</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setCategory</b></span>(const QString &amp;<i> category</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>categoryChanged</b></span>()</td></tr>
</table></div>
<!-- @@@category -->
<!-- $$$loops-prop$$$loopCount$$$setLoopCountint$$$loopCountChanged -->
<h3 class="fn" id="loops-prop"><a name="loops-prop"></a><span class="name">loops</span> : <span class="type">int</span></h3>
<p>This property holds the number of times the sound is played. A value of 0 or 1 means the sound will be played only once; set to <a href="qml-multimedia.html#soundeffect">SoundEffect</a>.Infinite to enable infinite looping.</p>
<p>The value can be changed while the sound effect is playing, in which case it will update the remaining loops to the new value.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>loopCount</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setLoopCount</b></span>(int<i> loopCount</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>loopCountChanged</b></span>()</td></tr>
</table></div>
<!-- @@@loops -->
<!-- $$$loopsRemaining-prop$$$loopsRemaining$$$loopsRemainingChanged -->
<h3 class="fn" id="loopsRemaining-prop"><a name="loopsRemaining-prop"></a><span class="name">loopsRemaining</span> : const <span class="type">int</span></h3>
<p>This property contains the number of loops remaining before the sound effect stops by itself, or <a href="qsoundeffect.html#Loop-enum">QSoundEffect::Infinite</a> if that's what has been set in <a href="qsoundeffect.html#loops-prop">loops</a>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>loopsRemaining</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>loopsRemainingChanged</b></span>()</td></tr>
</table></div>
<!-- @@@loopsRemaining -->
<!-- $$$muted-prop$$$isMuted$$$setMutedbool$$$mutedChanged -->
<h3 class="fn" id="muted-prop"><a name="muted-prop"></a><span class="name">muted</span> : <span class="type">bool</span></h3>
<p>This property provides a way to control muting. A value of <code>true</code> will mute this effect.</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>isMuted</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setMuted</b></span>(bool<i> muted</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>mutedChanged</b></span>()</td></tr>
</table></div>
<!-- @@@muted -->
<!-- $$$playing-prop$$$isPlaying$$$playingChanged -->
<h3 class="fn" id="playing-prop"><a name="playing-prop"></a><span class="name">playing</span> : const <span class="type">bool</span></h3>
<p>This property indicates whether the sound effect is playing or not.</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>isPlaying</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>playingChanged</b></span>()</td></tr>
</table></div>
<!-- @@@playing -->
<!-- $$$source-prop$$$source$$$setSourceconstQUrl&$$$sourceChanged -->
<h3 class="fn" id="source-prop"><a name="source-prop"></a><span class="name">source</span> : <span class="type"><a href="../qtcore/qurl.html">QUrl</a></span></h3>
<p>This property holds the url for the sound to play. For the <a href="qml-multimedia.html#soundeffect">SoundEffect</a> to attempt to load the source, the URL must exist and the application must have read permission in the specified directory.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QUrl </td><td class="memItemRight bottomAlign"><span class="name"><b>source</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSource</b></span>(const QUrl &amp;<i> url</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>sourceChanged</b></span>()</td></tr>
</table></div>
<!-- @@@source -->
<!-- $$$status-prop$$$status$$$statusChanged -->
<h3 class="fn" id="status-prop"><a name="status-prop"></a><span class="name">status</span> : const <span class="type"><a href="qsoundeffect.html#Status-enum">Status</a></span></h3>
<p>This property indicates the current status of the sound effect from the <a href="qsoundeffect.html#Status-enum">QSoundEffect::Status</a> enumeration.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Status </td><td class="memItemRight bottomAlign"><span class="name"><b>status</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>statusChanged</b></span>()</td></tr>
</table></div>
<!-- @@@status -->
<!-- $$$volume-prop$$$volume$$$setVolumeqreal$$$volumeChanged -->
<h3 class="fn" id="volume-prop"><a name="volume-prop"></a><span class="name">volume</span> : <span class="type"><a href="../qtcore/qtglobal.html#qreal-typedef">qreal</a></span></h3>
<p>This property holds the volume of the sound effect playback, from 0.0 (silent) to 1.0 (maximum volume).</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> qreal </td><td class="memItemRight bottomAlign"><span class="name"><b>volume</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setVolume</b></span>(qreal<i> volume</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>volumeChanged</b></span>()</td></tr>
</table></div>
<!-- @@@volume -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QSoundEffect[overload1]$$$QSoundEffectQObject* -->
<h3 class="fn" id="QSoundEffect"><a name="QSoundEffect"></a>QSoundEffect::<span class="name">QSoundEffect</span>(<span class="type"><a href="../qtcore/qobject.html#QObject">QObject</a></span> *<i> parent</i> = 0)</h3>
<p>Creates a <a href="qsoundeffect.html">QSoundEffect</a> with the given <i>parent</i>.</p>
<!-- @@@QSoundEffect -->
<!-- $$$~QSoundEffect[overload1]$$$~QSoundEffect -->
<h3 class="fn" id="dtor.QSoundEffect"><a name="dtor.QSoundEffect"></a>QSoundEffect::<span class="name">~QSoundEffect</span>()</h3>
<p>Destroys this sound effect.</p>
<!-- @@@~QSoundEffect -->
<!-- $$$isLoaded[overload1]$$$isLoaded -->
<h3 class="fn" id="isLoaded"><a name="isLoaded"></a><span class="type">bool</span> QSoundEffect::<span class="name">isLoaded</span>() const</h3>
<p>Returns whether the sound effect has finished loading the <a href="qsoundeffect.html#source-prop">source</a>().</p>
<!-- @@@isLoaded -->
<!-- $$$loadedChanged[overload1]$$$loadedChanged -->
<h3 class="fn" id="loadedChanged"><a name="loadedChanged"></a><code>[signal] </code><span class="type">void</span> QSoundEffect::<span class="name">loadedChanged</span>()</h3>
<p>The <code>loadedChanged</code> signal is emitted when the loading state has changed.</p>
<!-- @@@loadedChanged -->
<!-- $$$play[overload1]$$$play -->
<h3 class="fn" id="play"><a name="play"></a><code>[slot] </code><span class="type">void</span> QSoundEffect::<span class="name">play</span>()</h3>
<p>Start playback of the sound effect, looping the effect for the number of times as specified in the loops property.</p>
<!-- @@@play -->
<!-- $$$stop[overload1]$$$stop -->
<h3 class="fn" id="stop"><a name="stop"></a><code>[slot] </code><span class="type">void</span> QSoundEffect::<span class="name">stop</span>()</h3>
<p>Stop current playback.</p>
<!-- @@@stop -->
<!-- $$$supportedMimeTypes[overload1]$$$supportedMimeTypes -->
<h3 class="fn" id="supportedMimeTypes"><a name="supportedMimeTypes"></a><code>[static] </code><span class="type"><a href="../qtcore/qstringlist.html">QStringList</a></span> QSoundEffect::<span class="name">supportedMimeTypes</span>()</h3>
<p>Returns a list of the supported mime types for this platform.</p>
<!-- @@@supportedMimeTypes -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2015 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.