/usr/share/qt5/doc/qtmultimedia/qml-qtaudioengine-audioengine.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 | <?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_audioengine_p.cpp -->
<title>AudioEngine QML Type | 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-qmlmodule.html">QML Types</a></li>
<li>AudioEngine QML Type</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="#properties">Properties</a></li>
<li class="level1"><a href="#signals">Signals</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">AudioEngine QML Type</h1>
<span class="subtitle"></span>
<!-- $$$AudioEngine-brief -->
<p>Organize all your 3d audio content in one place. <a href="#details">More...</a></p>
<!-- @@@AudioEngine -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtAudioEngine 1.0</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-audioengine-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-audioengine.html#categories-prop">categories</a></b></b> : map</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audioengine.html#dopplerFactor-prop">dopplerFactor</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audioengine.html#listener-prop">listener</a></b></b> : QtAudioEngine::AudioListener</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audioengine.html#liveInstances-prop">liveInstances</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audioengine.html#loading-prop">loading</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audioengine.html#samples-prop">samples</a></b></b> : map</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audioengine.html#sounds-prop">sounds</a></b></b> : map</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audioengine.html#speedOfSound-prop">speedOfSound</a></b></b> : real</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtaudioengine-audioengine.html#finishedLoading-signal">finishedLoading</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audioengine.html#isLoadingChanged-signal">isLoadingChanged</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audioengine.html#liveInstanceCountChanged-signal">liveInstanceCountChanged</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audioengine.html#ready-signal">ready</a></b></b>()</li>
</ul>
<!-- $$$AudioEngine-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p><code>AudioEngine</code> is part of the <b><a href="qtaudioengine-qmlmodule.html">QtAudioEngine</a> 1.0</b> module.</p>
<pre class="qml">import QtQuick 2.0
import QtAudioEngine 1.0
<span class="type">Rectangle</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">"explosion"</span>
<span class="name">source</span>: <span class="string">"explosion-02.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">"explosion"</span>
}
}
<span class="name">dopplerFactor</span>: <span class="number">1</span>
<span class="name">speedOfSound</span>: <span class="number">343.33</span> <span class="comment">// Approximate speed of sound in air at 20 degrees Celsius</span>
<span class="name">listener</span>.up:<span class="string">"0,0,1"</span>
<span class="name">listener</span>.position:<span class="string">"0,0,0"</span>
<span class="name">listener</span>.velocity:<span class="string">"0,0,0"</span>
<span class="name">listener</span>.direction:<span class="string">"0,1,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">audioengine</span>.<span class="name">sounds</span>[<span class="string">"explosion"</span>].<span class="name">play</span>();
}
}
}</pre>
<p><code>AudioEngine</code> acts as a central library for configuring all 3d audio content in an app, so you should define only one in your app.</p>
<p>It is mostly used as a container to access other types such as <a href="qml-qtaudioengine-audiocategory.html">AudioCategory</a>, <a href="qml-qtaudioengine-audiosample.html">AudioSample</a> and Sound.</p>
<p><b>See also </b><a href="qml-qtaudioengine-audiocategory.html">AudioCategory</a>, <a href="qml-qtaudioengine-audiosample.html">AudioSample</a>, <a href="qml-qtaudioengine-sound.html">Sound</a>, <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a>, <a href="qml-qtaudioengine-attenuationmodellinear.html">AttenuationModelLinear</a>, and <a href="qml-qtaudioengine-attenuationmodelinverse.html">AttenuationModelInverse</a>.</p>
<!-- @@@AudioEngine -->
<h2>Property Documentation</h2>
<!-- $$$categories -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="categories-prop"><td class="tblQmlPropNode"><p><a name="categories-prop"></a><span class="name">categories</span> : <span class="type">map</span></p></td></tr></table></div></div><div class="qmldoc"><p>Container of all <a href="qml-qtaudioengine-audiocategory.html">AudioCategory</a> instances.</p>
</div></div><!-- @@@categories -->
<br/>
<!-- $$$dopplerFactor -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="dopplerFactor-prop"><td class="tblQmlPropNode"><p><a name="dopplerFactor-prop"></a><span class="name">dopplerFactor</span> : <span class="type">real</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds a simple scaling for the effect of doppler shift.</p>
</div></div><!-- @@@dopplerFactor -->
<br/>
<!-- $$$listener -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="listener-prop"><td class="tblQmlPropNode"><p><a name="listener-prop"></a><span class="name">listener</span> : <span class="type"><a href="qml-qtaudioengine-audiolistener.html">QtAudioEngine::AudioListener</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the listener object. You can change various properties to affect the 3D positioning of sounds.</p>
<p><b>See also </b><a href="qml-qtaudioengine-audiolistener.html">AudioListener</a>.</p>
</div></div><!-- @@@listener -->
<br/>
<!-- $$$liveInstances -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="liveInstances-prop"><td class="tblQmlPropNode"><p><a name="liveInstances-prop"></a><span class="name">liveInstances</span> : <span class="type">int</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property indicates how many live sound instances there are at the moment.</p>
</div></div><!-- @@@liveInstances -->
<br/>
<!-- $$$loading -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="loading-prop"><td class="tblQmlPropNode"><p><a name="loading-prop"></a><span class="name">loading</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property indicates if the audio engine is loading any audio sample at the moment. This may be useful if you specified the preloaded property in <a href="qml-qtaudioengine-audiosample.html">AudioSample</a> and would like to show a loading screen to the user before all audio samples are loaded.</p>
<p>/sa <a href="qml-qtaudioengine-audioengine.html#finishedLoading-signal">finishedLoading</a>, <a href="qml-qtaudioengine-audiosample.html#preloaded-prop">AudioSample::preloaded</a></p>
</div></div><!-- @@@loading -->
<br/>
<!-- $$$samples -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="samples-prop"><td class="tblQmlPropNode"><p><a name="samples-prop"></a><span class="name">samples</span> : <span class="type">map</span></p></td></tr></table></div></div><div class="qmldoc"><p>Container of all <a href="qml-qtaudioengine-audiosample.html">AudioSample</a> instances.</p>
</div></div><!-- @@@samples -->
<br/>
<!-- $$$sounds -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="sounds-prop"><td class="tblQmlPropNode"><p><a name="sounds-prop"></a><span class="name">sounds</span> : <span class="type">map</span></p></td></tr></table></div></div><div class="qmldoc"><p>Container of all Sound instances.</p>
</div></div><!-- @@@sounds -->
<br/>
<!-- $$$speedOfSound -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="speedOfSound-prop"><td class="tblQmlPropNode"><p><a name="speedOfSound-prop"></a><span class="name">speedOfSound</span> : <span class="type">real</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the reference value of the sound speed (in meters per second) which will be used in doppler shift calculation. The doppler shift calculation is used to emulate the change in frequency in sound that is perceived by an observer when the sound source is travelling towards or away from the observer. The speed of sound depends on the medium the sound is propagating through.</p>
</div></div><!-- @@@speedOfSound -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$finishedLoading -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="finishedLoading-signal"><td class="tblQmlFuncNode"><p><a name="finishedLoading-signal"></a><span class="name">finishedLoading</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>This signal is emitted when <a href="qml-qtaudioengine-audioengine.html#loading-prop">loading</a> has completed.</p>
<p>The corresponding handler is <code>onFinishedLoading</code>.</p>
</div></div><!-- @@@finishedLoading -->
<br/>
<!-- $$$isLoadingChanged -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="isLoadingChanged-signal"><td class="tblQmlFuncNode"><p><a name="isLoadingChanged-signal"></a><span class="name">isLoadingChanged</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>This signal is emitted when the <a href="qml-qtaudioengine-audioengine.html#loading-prop">loading</a> property changes.</p>
<p>The corresponding handler is <code>onIsLoadingChanged</code>.</p>
</div></div><!-- @@@isLoadingChanged -->
<br/>
<!-- $$$liveInstanceCountChanged -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="liveInstanceCountChanged-signal"><td class="tblQmlFuncNode"><p><a name="liveInstanceCountChanged-signal"></a><span class="name">liveInstanceCountChanged</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>This signal is emitted when the number of live instances managed by the <a href="qml-qtaudioengine-audioengine.html">AudioEngine</a> is changed.</p>
<p>The corresponding handler is <code>onLiveInstanceCountChanged</code>.</p>
</div></div><!-- @@@liveInstanceCountChanged -->
<br/>
<!-- $$$ready -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="ready-signal"><td class="tblQmlFuncNode"><p><a name="ready-signal"></a><span class="name">ready</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>This signal is emitted when the <a href="qml-qtaudioengine-audioengine.html">AudioEngine</a> is ready to use.</p>
<p>The corresponding handler is <code>onReady</code>.</p>
</div></div><!-- @@@ready -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
|