summaryrefslogtreecommitdiffstats
path: root/doc/src/audioengineoverview.qdoc
blob: aa988f4974f0764e6da9bb73288db85f65d8994d (plain)
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
/****************************************************************************
**
** 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

*/