<?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.12.6</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.12</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"><a href="qtmultimedia-index.html">Qt 5.12.6 Reference Documentation</a></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"> </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"> </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> 2019 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>