<?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_audiosample_p.cpp --> <title>AudioSample 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 >AudioSample 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="#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">AudioSample QML Type</h1> <span class="subtitle"></span> <!-- $$$AudioSample-brief --> <p>Load audio samples, mostly .wav. <a href="#details">More...</a></p> <!-- @@@AudioSample --> <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-audiosample-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-audiosample.html#loaded-prop">loaded</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-qtaudioengine-audiosample.html#name-prop">name</a></b></b> : string</li> <li class="fn"><b><b><a href="qml-qtaudioengine-audiosample.html#preloaded-prop">preloaded</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-qtaudioengine-audiosample.html#source-prop">source</a></b></b> : url</li> </ul> <a name="signals"></a> <h2 id="signals">Signals</h2> <ul> <li class="fn"><b><b><a href="qml-qtaudioengine-audiosample.html#loadedChanged-signal">loadedChanged</a></b></b>()</li> </ul> <a name="methods"></a> <h2 id="methods">Methods</h2> <ul> <li class="fn">void <b><b><a href="qml-qtaudioengine-audiosample.html#load-method">load</a></b></b>()</li> </ul> <!-- $$$AudioSample-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p>It can be accessed through <a href="qml-qtaudioengine-audioengine.html#samples-prop">QtAudioEngine::AudioEngine::samples</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#addAudioSample-method">AudioEngine.addAudioSample()</a> if <a href="qml-qtaudioengine-audiosample.html">AudioSample</a> is created dynamically.</p> <pre class="qml"> </pre> <!-- @@@AudioSample --> <h2>Property Documentation</h2> <!-- $$$loaded --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="loaded-prop"> <td class="tblQmlPropNode"><p> <a name="loaded-prop"></a><span class="name">loaded</span> : <span class="type">bool</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property indicates whether this sample has been loaded into memory or not.</p> </div></div><!-- @@@loaded --> <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 the sample, which must be unique among all samples and only defined once.</p> </div></div><!-- @@@name --> <br/> <!-- $$$preloaded --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="preloaded-prop"> <td class="tblQmlPropNode"><p> <a name="preloaded-prop"></a><span class="name">preloaded</span> : <span class="type">bool</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property indicates whether this sample needs to be preloaded or not. If <code>true</code>, the audio engine will start loading the sample file immediately when the application starts, otherwise the sample will not be loaded until explicitly requested.</p> </div></div><!-- @@@preloaded --> <br/> <!-- $$$source --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="source-prop"> <td class="tblQmlPropNode"><p> <a name="source-prop"></a><span class="name">source</span> : <span class="type">url</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the source URL of the audio sample.</p> </div></div><!-- @@@source --> <br/> <h2>Signal Documentation</h2> <!-- $$$loadedChanged --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="loadedChanged-signal"> <td class="tblQmlFuncNode"><p> <a name="loadedChanged-signal"></a><span class="name">loadedChanged</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when <a href="qml-qtaudioengine-audiosample.html#loaded-prop">loaded</a> is changed.</p> <p>The corresponding handler is <code>onLoadedChanged</code>.</p> </div></div><!-- @@@loadedChanged --> <br/> <h2>Method Documentation</h2> <!-- $$$load --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="load-method"> <td class="tblQmlFuncNode"><p> <a name="load-method"></a><span class="type">void</span> <span class="name">load</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>Starts loading the sample into memory if not loaded.</p> </div></div><!-- @@@load --> <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>