<?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_sound_p.cpp --> <title>Sound QML Type | Qt Multimedia 5.12.2</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 >Sound QML Type</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qtmultimedia-index.html">Qt 5.12.2 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="#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">Sound QML Type</h1> <span class="subtitle"></span> <!-- $$$Sound-brief --> <p>Define a variety of samples and parameters to be used for <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a>. <a href="#details">More...</a></p> <!-- @@@Sound --> <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-sound-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-sound.html#attenuationModel-prop">attenuationModel</a></b></b> : string</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#category-prop">category</a></b></b> : string</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#name-prop">name</a></b></b> : string</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#playType-prop">playType</a></b></b> : enumeration</li> </ul> <a name="methods"></a> <h2 id="methods">Methods</h2> <ul> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#addPlayVariation-method">addPlayVariation</a></b></b>(PlayVariation <i>playVariation</i>)</li> <li class="fn">QtAudioEngine::SoundInstance <b><b><a href="qml-qtaudioengine-sound.html#newInstance-method">newInstance</a></b></b>()</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#play-method">play</a></b></b>()</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#play-method-1">play</a></b></b>(<i>gain</i>)</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#play-method-2">play</a></b></b>(<i>gain</i>, <i>pitch</i>)</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#play-method-3">play</a></b></b>(<i>position</i>)</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#play-method-4">play</a></b></b>(<i>position</i>, <i>velocity</i>)</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#play-method-5">play</a></b></b>(<i>position</i>, <i>velocity</i>, <i>direction</i>)</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#play-method-6">play</a></b></b>(<i>position</i>, <i>gain</i>)</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#play-method-7">play</a></b></b>(<i>position</i>, <i>velocity</i>, <i>gain</i>)</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#play-method-8">play</a></b></b>(<i>position</i>, <i>velocity</i>, <i>direction</i>, <i>gain</i>)</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#play-method-9">play</a></b></b>(<i>position</i>, <i>gain</i>, <i>pitch</i>)</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#play-method-10">play</a></b></b>(<i>position</i>, <i>velocity</i>, <i>gain</i>, <i>pitch</i>)</li> <li class="fn"><b><b><a href="qml-qtaudioengine-sound.html#play-method-11">play</a></b></b>(<i>position</i>, <i>velocity</i>, <i>direction</i>, <i>gain</i>, <i>pitch</i>)</li> </ul> <!-- $$$Sound-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p>Sound can be accessed through <a href="qml-qtaudioengine-audioengine.html#sounds-prop">QtAudioEngine::AudioEngine::sounds</a> with its unique name and must be defined inside <a href="qml-qtaudioengine-audioengine.html">AudioEngine</a> or be added to it using <a href="qml-qtaudioengine-audioengine.html#addSound-method">AudioEngine.addSound()</a> if <a href="qml-qtaudioengine-sound.html">Sound</a> is created dynamically.</p> <pre class="qml"> </pre> <!-- @@@Sound --> <h2>Property Documentation</h2> <!-- $$$attenuationModel --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="attenuationModel-prop"> <td class="tblQmlPropNode"><p> <a name="attenuationModel-prop"></a><span class="name">attenuationModel</span> : <span class="type">string</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property specifies which attenuation model this sound will apply.</p> </div></div><!-- @@@attenuationModel --> <br/> <!-- $$$category --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="category-prop"> <td class="tblQmlPropNode"><p> <a name="category-prop"></a><span class="name">category</span> : <span class="type">string</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property specifies which <a href="qml-qtaudioengine-audiocategory.html">AudioCategory</a> this sound belongs to.</p> </div></div><!-- @@@category --> <br/> <!-- $$$name --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="name-prop"> <td class="tblQmlPropNode"><p> <a name="name-prop"></a><span class="name">name</span> : <span class="type">string</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the name of Sound, must be unique among all sounds and only defined once.</p> </div></div><!-- @@@name --> <br/> <!-- $$$playType --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="playType-prop"> <td class="tblQmlPropNode"><p> <a name="playType-prop"></a><span class="name">playType</span> : <span class="type">enumeration</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the playType. It can be one of:</p> <ul> <li>Random - randomly picks up a play variation when playback is triggered</li> <li>Sequential - plays each variation in sequence when playback is triggered</li> </ul> <p>The default value is Random.</p> </div></div><!-- @@@playType --> <br/> <h2>Method Documentation</h2> <!-- $$$addPlayVariation --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="addPlayVariation-method"> <td class="tblQmlFuncNode"><p> <a name="addPlayVariation-method"></a><span class="name">addPlayVariation</span>(<span class="type"><a href="qml-qtaudioengine-playvariation.html">PlayVariation</a></span> <i>playVariation</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Adds the given <i>playVariation</i> to sound. This can be used when the <a href="qml-qtaudioengine-playvariation.html">PlayVariation</a> is created dynamically:</p> <pre class="qml"> </pre> </div></div><!-- @@@addPlayVariation --> <br/> <!-- $$$newInstance --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="newInstance-method"> <td class="tblQmlFuncNode"><p> <a name="newInstance-method"></a><span class="type"><a href="qml-qtaudioengine-soundinstance.html">QtAudioEngine::SoundInstance</a></span> <span class="name">newInstance</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>Returns a new <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a>.</p> </div></div><!-- @@@newInstance --> <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>Creates a new <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> and starts playing. Position, direction and velocity are all set to <code>"0,0,0"</code>.</p> </div></div><!-- @@@play --> <br/> <!-- $$$play --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="play-method-1"> <td class="tblQmlFuncNode"><p> <a name="play-method-1"></a><span class="name">play</span>(<i>gain</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Creates a new <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> and starts playing with the adjusted <i>gain</i>. Position, direction and velocity are all set to <code>"0,0,0"</code>.</p> </div></div><!-- @@@play --> <br/> <!-- $$$play --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="play-method-2"> <td class="tblQmlFuncNode"><p> <a name="play-method-2"></a><span class="name">play</span>(<i>gain</i>, <i>pitch</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Creates a new <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> and starts playing with the adjusted <i>gain</i> and <i>pitch</i>. Position, direction and velocity are all set to <code>"0,0,0"</code>.</p> </div></div><!-- @@@play --> <br/> <!-- $$$play --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="play-method-3"> <td class="tblQmlFuncNode"><p> <a name="play-method-3"></a><span class="name">play</span>(<i>position</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Creates a new <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> and starts playing with specified <i>position</i>. Direction and velocity are all set to <code>"0,0,0"</code>.</p> </div></div><!-- @@@play --> <br/> <!-- $$$play --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="play-method-4"> <td class="tblQmlFuncNode"><p> <a name="play-method-4"></a><span class="name">play</span>(<i>position</i>, <i>velocity</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Creates a new <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> and starts playing with specified <i>position</i> and <i>velocity</i>. Direction is set to <code>"0,0,0"</code>.</p> </div></div><!-- @@@play --> <br/> <!-- $$$play --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="play-method-5"> <td class="tblQmlFuncNode"><p> <a name="play-method-5"></a><span class="name">play</span>(<i>position</i>, <i>velocity</i>, <i>direction</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Creates a new <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> and starts playing with specified <i>position</i>, <i>velocity</i> and <i>direction</i>.</p> </div></div><!-- @@@play --> <br/> <!-- $$$play --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="play-method-6"> <td class="tblQmlFuncNode"><p> <a name="play-method-6"></a><span class="name">play</span>(<i>position</i>, <i>gain</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Creates a new <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> and starts playing with specified <i>position</i> and adjusted <i>gain</i>. Direction and velocity are all set to <code>"0,0,0"</code>.</p> </div></div><!-- @@@play --> <br/> <!-- $$$play --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="play-method-7"> <td class="tblQmlFuncNode"><p> <a name="play-method-7"></a><span class="name">play</span>(<i>position</i>, <i>velocity</i>, <i>gain</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Creates a new <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> and starts playing with specified <i>position</i>, <i>velocity</i> and adjusted <i>gain</i>. Direction is set to <code>"0,0,0"</code>.</p> </div></div><!-- @@@play --> <br/> <!-- $$$play --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="play-method-8"> <td class="tblQmlFuncNode"><p> <a name="play-method-8"></a><span class="name">play</span>(<i>position</i>, <i>velocity</i>, <i>direction</i>, <i>gain</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Creates a new <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> and starts playing with specified <i>position</i>, <i>velocity</i>, <i>direction</i> and adjusted <i>gain</i>.</p> </div></div><!-- @@@play --> <br/> <!-- $$$play --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="play-method-9"> <td class="tblQmlFuncNode"><p> <a name="play-method-9"></a><span class="name">play</span>(<i>position</i>, <i>gain</i>, <i>pitch</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Creates a new <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> and starts playing with specified <i>position</i>, adjusted <i>gain</i> and <i>pitch</i>. Direction and velocity are all set to <code>"0,0,0"</code>.</p> </div></div><!-- @@@play --> <br/> <!-- $$$play --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="play-method-10"> <td class="tblQmlFuncNode"><p> <a name="play-method-10"></a><span class="name">play</span>(<i>position</i>, <i>velocity</i>, <i>gain</i>, <i>pitch</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Creates a new <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> and starts playing with specified <i>position</i>, <i>velocity</i>, adjusted <i>gain</i> and <i>pitch</i>. Direction is set to <code>"0,0,0"</code>.</p> </div></div><!-- @@@play --> <br/> <!-- $$$play --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="play-method-11"> <td class="tblQmlFuncNode"><p> <a name="play-method-11"></a><span class="name">play</span>(<i>position</i>, <i>velocity</i>, <i>direction</i>, <i>gain</i>, <i>pitch</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Creates a new <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> and starts playing with specified <i>position</i>, <i>velocity</i>, <i>direction</i>, adjusted <i>gain</i> and <i>pitch</i>.</p> </div></div><!-- @@@play --> <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>