<?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_audiolistener_p.cpp -->
<title>AudioListener 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 >AudioListener QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">AudioListener QML Type</h1>
<span class="subtitle"></span>
<!-- $$$AudioListener-brief -->
<p>Control global listener parameters. <a href="#details">More...</a></p>
<!-- @@@AudioListener -->
<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-audiolistener-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-audiolistener.html#direction-prop">direction</a></b></b> : vector3d</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audiolistener.html#engine-prop">engine</a></b></b> : QtAudioEngine::AudioEngine</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audiolistener.html#gain-prop">gain</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audiolistener.html#position-prop">position</a></b></b> : vector3d</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audiolistener.html#up-prop">up</a></b></b> : vector3d</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-audiolistener.html#velocity-prop">velocity</a></b></b> : vector3d</li>
</ul>
<!-- $$$AudioListener-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qml-qtaudioengine-audiolistener.html">AudioListener</a> will have only one global instance and you can either access it through the listener property of <a href="qml-qtaudioengine-audioengine.html">AudioEngine</a>:</p>
<pre class="qml">
<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="name">listener</span>.up:<span class="string">"0,0,1"</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="name">listener</span>.position:<span class="name">Qt</span>.<span class="name">vector3d</span>(<span class="name">observer</span>.<span class="name">x</span>, <span class="name">observer</span>.<span class="name">y</span>, <span class="number">0</span>);
}
<span class="type">Item</span> {
<span class="name">id</span>: <span class="name">observer</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>
}
}
}
}
</pre>
<p>or alternatively, by defining an <a href="qml-qtaudioengine-audiolistener.html">AudioListener</a> outside <a href="qml-qtaudioengine-audioengine.html">AudioEngine</a>:</p>
<pre class="qml">
<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="name">listener</span>.up:<span class="string">"0,0,1"</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"><a href="qml-qtaudioengine-audiolistener.html">AudioListener</a></span> {
<span class="name">engine</span>:<span class="name">audioengine</span>
<span class="name">position</span>: <span class="name">Qt</span>.<span class="name">vector3d</span>(<span class="name">observer</span>.<span class="name">x</span>, <span class="name">observer</span>.<span class="name">y</span>, <span class="number">0</span>);
}
<span class="type">Item</span> {
<span class="name">id</span>: <span class="name">observer</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>
}
}
}
}
</pre>
<p>This separate <a href="qml-qtaudioengine-audiolistener.html">AudioListener</a> definition is allowed to make QML bindings easier in some cases.</p>
<!-- @@@AudioListener -->
<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 normalized 3D direction vector of the listener.</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>, and must only be set 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">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property will modulate all audio output from audio engine instances.</p>
</div></div><!-- @@@gain -->
<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 3D position of the listener.</p>
</div></div><!-- @@@position -->
<br/>
<!-- $$$up -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="up-prop">
<td class="tblQmlPropNode"><p>
<a name="up-prop"></a><span class="name">up</span> : <span class="type">vector3d</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the normalized 3D up vector of the listener.</p>
</div></div><!-- @@@up -->
<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 3D velocity vector of the listener.</p>
</div></div><!-- @@@velocity -->
<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>
