/usr/share/qt5/doc/qtmultimedia/qml-qtaudioengine-soundinstance.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 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarative_soundinstance_p.cpp -->
<title>SoundInstance QML Type | 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-qmlmodule.html">QML Types</a></td><td >SoundInstance QML Type</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="#properties">Properties</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#methods">Methods</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">SoundInstance QML Type</h1>
<span class="subtitle"></span>
<!-- $$$SoundInstance-brief -->
<p>Play 3d audio content. <a href="#details">More...</a></p>
<!-- @@@SoundInstance -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtAudioEngine 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.0</td></tr></table></div><ul>
<li><a href="qml-qtaudioengine-soundinstance-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#direction-prop">direction</a></b></b> : vector3d</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#engine-prop">engine</a></b></b> : QtAudioEngine::AudioEngine</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#gain-prop">gain</a></b></b> : vector3d</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#pitch-prop">pitch</a></b></b> : vector3d</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#position-prop">position</a></b></b> : vector3d</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#sound-prop">sound</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#state-prop">state</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#velocity-prop">velocity</a></b></b> : vector3d</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#directionChanged-signal">directionChanged</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#gainChanged-signal">gainChanged</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#pitchChanged-signal">pitchChanged</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#positionChanged-signal">positionChanged</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#soundChanged-signal">soundChanged</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#stateChanged-signal">stateChanged</a></b></b>(<i>state</i>)</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#velocityChanged-signal">velocityChanged</a></b></b>()</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#pause-method">pause</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#play-method">play</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-soundinstance.html#stop-method">stop</a></b></b>()</li>
</ul>
<!-- $$$SoundInstance-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>There are two ways to create <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> objects. You can obtain it by calling newInstance method of a <a href="qml-qtaudioengine-sound.html">Sound</a>:</p>
<pre class="qml">
<span class="type">Rectangle</span> {
<span class="name">id</span>:<span class="name">root</span>
<span class="name">color</span>:<span class="string">"white"</span>
<span class="name">width</span>: <span class="number">300</span>
<span class="name">height</span>: <span class="number">500</span>
<span class="type"><a href="qml-qtaudioengine-audioengine.html">AudioEngine</a></span> {
<span class="name">id</span>:<span class="name">audioengine</span>
<span class="type"><a href="qml-qtaudioengine-audiosample.html">AudioSample</a></span> {
<span class="name">name</span>:<span class="string">"explosion01"</span>
<span class="name">source</span>: <span class="string">"explosion-01.wav"</span>
}
<span class="type"><a href="qml-qtaudioengine-sound.html">Sound</a></span> {
<span class="name">name</span>:<span class="string">"explosion"</span>
<span class="type"><a href="qml-qtaudioengine-playvariation.html">PlayVariation</a></span> {
<span class="name">sample</span>:<span class="string">"explosion01"</span>
}
}
}
property <span class="type">variant</span> <span class="name">soundEffect</span>: <span class="name">audioengine</span>.<span class="name">sounds</span>[<span class="string">"explosion"</span>].<span class="name">newInstance</span>();
<span class="type">MouseArea</span> {
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="name">onPressed</span>: {
<span class="name">root</span>.<span class="name">soundEffect</span>.<span class="name">play</span>();
}
}
}
</pre>
<p>Or alternatively, you can explicitly define <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> outside of <a href="qml-qtaudioengine-audioengine.html">AudioEngine</a> for easier qml bindings:</p>
<pre class="qml">
<span class="type">Rectangle</span> {
<span class="name">id</span>:<span class="name">root</span>
<span class="name">color</span>:<span class="string">"white"</span>
<span class="name">width</span>: <span class="number">300</span>
<span class="name">height</span>: <span class="number">500</span>
<span class="type"><a href="qml-qtaudioengine-audioengine.html">AudioEngine</a></span> {
<span class="name">id</span>:<span class="name">audioengine</span>
<span class="type"><a href="qml-qtaudioengine-audiosample.html">AudioSample</a></span> {
<span class="name">name</span>:<span class="string">"explosion01"</span>
<span class="name">source</span>: <span class="string">"explosion-01.wav"</span>
}
<span class="type"><a href="qml-qtaudioengine-sound.html">Sound</a></span> {
<span class="name">name</span>:<span class="string">"explosion"</span>
<span class="type"><a href="qml-qtaudioengine-playvariation.html">PlayVariation</a></span> {
<span class="name">sample</span>:<span class="string">"explosion01"</span>
}
}
}
<span class="type">Item</span> {
<span class="name">id</span>: <span class="name">animator</span>
<span class="name">x</span>: <span class="number">10</span> <span class="operator">+</span> <span class="name">observer</span>.<span class="name">percent</span> <span class="operator">*</span> <span class="number">100</span>
<span class="name">y</span>: <span class="number">20</span> <span class="operator">+</span> <span class="name">observer</span>.<span class="name">percent</span> <span class="operator">*</span> <span class="number">80</span>
property <span class="type">real</span> <span class="name">percent</span>: <span class="number">0</span>
SequentialAnimation on <span class="name">percent</span> {
<span class="name">loops</span>: <span class="name">Animation</span>.<span class="name">Infinite</span>
<span class="name">running</span>: <span class="number">true</span>
<span class="type">NumberAnimation</span> {
<span class="name">duration</span>: <span class="number">8000</span>
<span class="name">from</span>: <span class="number">0</span>
<span class="name">to</span>: <span class="number">1</span>
}
}
}
<span class="type"><a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a></span> {
<span class="name">id</span>:<span class="name">soundEffect</span>
<span class="name">engine</span>:<span class="name">audioengine</span>
<span class="name">sound</span>:<span class="string">"explosion"</span>
<span class="name">position</span>:<span class="name">Qt</span>.<span class="name">vector3d</span>(<span class="name">animator</span>.<span class="name">x</span>, <span class="name">animator</span>.<span class="name">y</span>, <span class="number">0</span>);
}
<span class="type">MouseArea</span> {
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="name">onPressed</span>: {
<span class="name">soundEffect</span>.<span class="name">play</span>();
}
}
}
</pre>
<!-- @@@SoundInstance -->
<h2>Property Documentation</h2>
<!-- $$$direction -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="direction-prop">
<td class="tblQmlPropNode"><p>
<a name="direction-prop"></a><span class="name">direction</span> : <span class="type">vector3d</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the current 3d direction.</p>
</div></div><!-- @@@direction -->
<br/>
<!-- $$$engine -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="engine-prop">
<td class="tblQmlPropNode"><p>
<a name="engine-prop"></a><span class="name">engine</span> : <span class="type"><a href="qml-qtaudioengine-audioengine.html">QtAudioEngine::AudioEngine</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the reference to <a href="qml-qtaudioengine-audioengine.html">AudioEngine</a>, must be set only once.</p>
</div></div><!-- @@@engine -->
<br/>
<!-- $$$gain -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="gain-prop">
<td class="tblQmlPropNode"><p>
<a name="gain-prop"></a><span class="name">gain</span> : <span class="type">vector3d</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the gain adjustment which will be used to modulate the audio output level from this <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a>.</p>
</div></div><!-- @@@gain -->
<br/>
<!-- $$$pitch -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="pitch-prop">
<td class="tblQmlPropNode"><p>
<a name="pitch-prop"></a><span class="name">pitch</span> : <span class="type">vector3d</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the pitch adjustment which will be used to modulate the audio pitch from this <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a>.</p>
</div></div><!-- @@@pitch -->
<br/>
<!-- $$$position -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="position-prop">
<td class="tblQmlPropNode"><p>
<a name="position-prop"></a><span class="name">position</span> : <span class="type">vector3d</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the current 3d position.</p>
</div></div><!-- @@@position -->
<br/>
<!-- $$$sound -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sound-prop">
<td class="tblQmlPropNode"><p>
<a name="sound-prop"></a><span class="name">sound</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property specifies which Sound this <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> will use. Unlike some properties in other types, this property can be changed dynamically.</p>
</div></div><!-- @@@sound -->
<br/>
<!-- $$$state -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="state-prop">
<td class="tblQmlPropNode"><p>
<a name="state-prop"></a><span class="name">state</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the current playback state. It can be one of:</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Value</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td >StopppedState</td><td >The <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> is not playing, and when playback begins next it will play from position zero.</td></tr>
<tr valign="top" class="even"><td >PlayingState</td><td >The <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> is playing the media.</td></tr>
<tr valign="top" class="odd"><td >PausedState</td><td >The <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> is not playing, and when playback begins next it will play from the position that it was paused at.</td></tr>
</table></div>
</div></div><!-- @@@state -->
<br/>
<!-- $$$velocity -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="velocity-prop">
<td class="tblQmlPropNode"><p>
<a name="velocity-prop"></a><span class="name">velocity</span> : <span class="type">vector3d</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the current 3d velocity.</p>
</div></div><!-- @@@velocity -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$directionChanged -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="directionChanged-signal">
<td class="tblQmlFuncNode"><p>
<a name="directionChanged-signal"></a><span class="name">directionChanged</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when <a href="qml-qtaudioengine-soundinstance.html#direction-prop">direction</a> is changed</p>
<p>The corresponding handler is <code>onDirectionChanged</code>.</p>
</div></div><!-- @@@directionChanged -->
<br/>
<!-- $$$gainChanged -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="gainChanged-signal">
<td class="tblQmlFuncNode"><p>
<a name="gainChanged-signal"></a><span class="name">gainChanged</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when <a href="qml-qtaudioengine-soundinstance.html#gain-prop">gain</a> is changed</p>
<p>The corresponding handler is <code>onGainChanged</code>.</p>
</div></div><!-- @@@gainChanged -->
<br/>
<!-- $$$pitchChanged -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="pitchChanged-signal">
<td class="tblQmlFuncNode"><p>
<a name="pitchChanged-signal"></a><span class="name">pitchChanged</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when <a href="qml-qtaudioengine-soundinstance.html#pitch-prop">pitch</a> is changed</p>
<p>The corresponding handler is <code>onPitchChanged</code>.</p>
</div></div><!-- @@@pitchChanged -->
<br/>
<!-- $$$positionChanged -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="positionChanged-signal">
<td class="tblQmlFuncNode"><p>
<a name="positionChanged-signal"></a><span class="name">positionChanged</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when <a href="qml-qtaudioengine-soundinstance.html#position-prop">position</a> is changed</p>
<p>The corresponding handler is <code>onPositionChanged</code>.</p>
</div></div><!-- @@@positionChanged -->
<br/>
<!-- $$$soundChanged -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="soundChanged-signal">
<td class="tblQmlFuncNode"><p>
<a name="soundChanged-signal"></a><span class="name">soundChanged</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when <a href="qml-qtaudioengine-soundinstance.html#sound-prop">sound</a> is changed</p>
<p>The corresponding handler is <code>onSoundChanged</code>.</p>
</div></div><!-- @@@soundChanged -->
<br/>
<!-- $$$stateChanged -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="stateChanged-signal">
<td class="tblQmlFuncNode"><p>
<a name="stateChanged-signal"></a><span class="name">stateChanged</span>(<i>state</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when <a href="qml-qtaudioengine-soundinstance.html#state-prop">state</a> is changed</p>
<p>The corresponding handler is <code>onStateChanged</code>.</p>
</div></div><!-- @@@stateChanged -->
<br/>
<!-- $$$velocityChanged -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="velocityChanged-signal">
<td class="tblQmlFuncNode"><p>
<a name="velocityChanged-signal"></a><span class="name">velocityChanged</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when <a href="qml-qtaudioengine-soundinstance.html#velocity-prop">velocity</a> is changed</p>
<p>The corresponding handler is <code>onVelocityChanged</code>.</p>
</div></div><!-- @@@velocityChanged -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$pause -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="pause-method">
<td class="tblQmlFuncNode"><p>
<a name="pause-method"></a><span class="name">pause</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Pauses current playback.</p>
</div></div><!-- @@@pause -->
<br/>
<!-- $$$play -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="play-method">
<td class="tblQmlFuncNode"><p>
<a name="play-method"></a><span class="name">play</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Starts playback.</p>
</div></div><!-- @@@play -->
<br/>
<!-- $$$stop -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="stop-method">
<td class="tblQmlFuncNode"><p>
<a name="stop-method"></a><span class="name">stop</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Stops current playback.</p>
</div></div><!-- @@@stop -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
|