summaryrefslogtreecommitdiffstats
path: root/doc/src/audioengineoverview.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/audioengineoverview.qdoc')
-rw-r--r--doc/src/audioengineoverview.qdoc71
1 files changed, 71 insertions, 0 deletions
diff --git a/doc/src/audioengineoverview.qdoc b/doc/src/audioengineoverview.qdoc
new file mode 100644
index 000000000..aa988f497
--- /dev/null
+++ b/doc/src/audioengineoverview.qdoc
@@ -0,0 +1,71 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\page audioengineoverview.html
+\title QtAudioEngine Overview
+\brief 3D Positional Audio
+
+\section1 QtAudioEngine features
+
+Qt Multimedia includes the \c QtAudioEngine QML module for
+providing 3D positional audio.
+
+These element can be accessed through importing the
+\bold{QtAudioEngine 1.0} module.
+
+\qml
+import QtQuick 2.0
+import QtAudioEngine 1.0
+
+AudioEngine {
+// ...
+\endqml
+
+\section1 Examples
+\list
+ \o \l {AudioEngine Example}{Audio Engine}
+\endlist
+
+\section1 Reference Documentation
+
+\section2 QML Elements
+
+\list
+ \o \l AudioEngine
+ \o \l AudioSample
+ \o \l AudioCategory
+ \o \l Sound
+ \o \l SoundInstance
+ \o \l PlayVariation
+ \o \l AudioListener
+ \o \l AttenuationModelLinear
+ \o \l AttenuationModelInverse
+
+\endlist
+
+*/