Add some recent things to the overview docs.
Also clean up a few other doc related bits and pieces. Change-Id: I56714e1811e38a7225131c1d141430b49f5f509c Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
This commit is contained in:
committed by
Qt by Nokia
parent
c77e442b99
commit
db781f29e0
71
doc/src/audioengineoverview.qdoc
Normal file
71
doc/src/audioengineoverview.qdoc
Normal file
@@ -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
|
||||
|
||||
*/
|
||||
Reference in New Issue
Block a user