diff options
author | Ling Hu <ling.hu@nokia.com> | 2012-02-14 11:59:13 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-02-21 07:35:41 +0100 |
commit | d5f344be4c6f73cca5aab0a3f374a15d999b590c (patch) | |
tree | 540772f6e5de335d4f4433e0f81036cc83d5520c /doc | |
parent | 2ab74b7ff298cb15d5c82476e15e568df6f3e26e (diff) |
Update audioengine overview doc & reference doc
Change-Id: If1061b3dc113f4354d741c536d63cbe36e7a65eb
Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/src/audioengineoverview.qdoc | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/doc/src/audioengineoverview.qdoc b/doc/src/audioengineoverview.qdoc index aa988f497..bc979f6ca 100644 --- a/doc/src/audioengineoverview.qdoc +++ b/doc/src/audioengineoverview.qdoc @@ -28,14 +28,21 @@ /*! \page audioengineoverview.html \title QtAudioEngine Overview -\brief 3D Positional Audio +\brief 3D positional audio playback and content management \section1 QtAudioEngine features Qt Multimedia includes the \c QtAudioEngine QML module for -providing 3D positional audio. +providing 3D positional audio playback and content management. -These element can be accessed through importing the +QtAudioEngine enables developers to organize wave files into discrete \l Sound with different +\l {PlayVariation}{play variations}, group sound controls by \l {AudioCategory} categories and +define \l {AttenuationModelLinear}{attenuation models} and various 3d audio settings all in one +place. Playback of \l {SoundInstance}{sound instances} can be conveniently activated by in-app +events and managed by QtAudioEngine or controlled by explicitly defining a \l SoundInstance elment +for easier qml bindings. + +QtAudioEngine elements can be accessed through importing the \bold{QtAudioEngine 1.0} module. \qml @@ -43,7 +50,7 @@ import QtQuick 2.0 import QtAudioEngine 1.0 AudioEngine { -// ... +//... \endqml \section1 Examples @@ -59,12 +66,12 @@ AudioEngine { \o \l AudioEngine \o \l AudioSample \o \l AudioCategory + \o \l AttenuationModelLinear + \o \l AttenuationModelInverse \o \l Sound - \o \l SoundInstance \o \l PlayVariation \o \l AudioListener - \o \l AttenuationModelLinear - \o \l AttenuationModelInverse + \o \l SoundInstance \endlist |