<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtaudioengine.qdoc -->
<title>Qt Audio Engine QML Types | 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 >Qt Audio Engine QML Types</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="#qt-audio-engine-features">Qt Audio Engine Features</a></li>
<li class="level1"><a href="#examples">Examples</a></li>
<li class="level1"><a href="#qml-types">QML types</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt Audio Engine QML Types</h1>
<span class="subtitle"></span>
<!-- $$$QtAudioEngine-description -->
<div class="descr"> <a name="details"></a>
<p>Qt Audio Engine is part of the <a href="qtmultimedia-index.html">Qt Multimedia</a> module. Qt Audio Engine provides types for 3D positional audio playback and content management.</p>
<p>The QML types can be imported into your application using the following import statement in your .qml file:</p>
<pre class="cpp">
import <span class="type">QtAudioEngine</span> <span class="number">1.1</span>
</pre>
<a name="qt-audio-engine-features"></a>
<h2 id="qt-audio-engine-features">Qt Audio Engine Features</h2>
<p>Qt Audio Engine enables developers to organize wave files into discrete <a href="qml-qtaudioengine-sound.html">Sound</a> with different <a href="qml-qtaudioengine-playvariation.html">play variations</a>, group sound controls by <a href="qml-qtaudioengine-audiocategory.html">AudioCategory</a> categories and define <a href="qml-qtaudioengine-attenuationmodellinear.html">attenuation models</a> and various 3D audio settings all in one place. Playback of <a href="qml-qtaudioengine-soundinstance.html">sound instances</a> can be conveniently activated by in-app events and managed by <a href="qtaudioengine-qmlmodule.html">QtAudioEngine</a> or controlled by explicitly defining <a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a> for easier QML bindings.</p>
<a name="examples"></a>
<h2 id="examples">Examples</h2>
<ul>
<li><a href="qtmultimedia-multimedia-audioengine-example.html">Audio Engine</a></li>
</ul>
<a name="qml-types"></a>
<h2 id="qml-types">QML types</h2>
</div>
<!-- @@@QtAudioEngine -->
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtaudioengine-attenuationmodelinverse.html">AttenuationModelInverse</a></p></td><td class="tblDescr"><p>Defines a non-linear attenuation curve for a Sound</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtaudioengine-attenuationmodellinear.html">AttenuationModelLinear</a></p></td><td class="tblDescr"><p>Defines a linear attenuation curve for a Sound</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtaudioengine-audiocategory.html">AudioCategory</a></p></td><td class="tblDescr"><p>Control all active sound instances by group</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtaudioengine-audioengine.html">AudioEngine</a></p></td><td class="tblDescr"><p>Organize all your 3d audio content in one place</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtaudioengine-audiolistener.html">AudioListener</a></p></td><td class="tblDescr"><p>Control global listener parameters</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtaudioengine-audiosample.html">AudioSample</a></p></td><td class="tblDescr"><p>Load audio samples, mostly .wav</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtaudioengine-playvariation.html">PlayVariation</a></p></td><td class="tblDescr"><p>Define a playback variation for sounds. So each time the playback of the same sound can be a slightly different even with the same AudioSample</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-qtaudioengine-sound.html">Sound</a></p></td><td class="tblDescr"><p>Define a variety of samples and parameters to be used for SoundInstance</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qtaudioengine-soundinstance.html">SoundInstance</a></p></td><td class="tblDescr"><p>Play 3d audio content</p></td></tr>
</table></div>
</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>
