Doc: Various fixes to Qt Audio Engine documentation

-fixed \since to "\since 5.0" (Qt version 5.0)
-made a \qmlmodule page so the list of related classes are automatically
 listed
-made changes in the Qt Multimedia documentation to link to the
 Qt Audio Engine documentation

Change-Id: Ibdd3da02871648988a73172934e684840c4ce0ae
Reviewed-by: Yoann Lopes <yoann.lopes@digia.com>
This commit is contained in:
Jerome Pasion
2013-10-02 16:27:06 +02:00
committed by The Qt Project
parent 43be5d9763
commit 3793b0653f
10 changed files with 55 additions and 64 deletions

View File

@@ -92,9 +92,9 @@ void QDeclarativeAttenuationModel::setName(const QString& name)
/*!
\qmltype AttenuationModelLinear
\instantiates QDeclarativeAttenuationModelLinear
\since 1.0
\since 5.0
\brief Defines a linear attenuation curve for a \l Sound.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary
@@ -225,9 +225,9 @@ qreal QDeclarativeAttenuationModelLinear::calculateGain(const QVector3D &listene
\qmltype AttenuationModelInverse
\instantiates QDeclarativeAttenuationModelInverse
\since 1.0
\since 5.0
\brief Defines a non-linear attenuation curve for a \l Sound.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -49,9 +49,9 @@ QT_USE_NAMESPACE
/*!
\qmltype AudioCategory
\instantiates QDeclarativeAudioCategory
\since 1.0
\since 5.0
\brief Control all active sound instances by group.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -58,9 +58,9 @@ QT_BEGIN_NAMESPACE
/*!
\qmltype AudioEngine
\instantiates QDeclarativeAudioEngine
\since 1.0
\since 5.0
\brief Organize all your 3d audio content in one place.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -50,9 +50,9 @@ QT_USE_NAMESPACE
/*!
\qmltype AudioListener
\instantiates QDeclarativeAudioListener
\since 1.0
\since 5.0
\brief Control global listener parameters.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -52,9 +52,9 @@ QT_USE_NAMESPACE
/*!
\qmltype AudioSample
\instantiates QDeclarativeAudioSample
\since 1.0
\since 5.0
\brief Load audio samples, mostly .wav.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -51,12 +51,12 @@ QT_USE_NAMESPACE
/*!
\qmltype PlayVariation
\instantiates QDeclarativePlayVariation
\since 1.0
\since 5.0
\brief Define a playback variation for \l {Sound} {sounds}.
So each time the playback of the same sound can be a slightly different even with the same
AudioSample.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -140,10 +140,10 @@ void QDeclarativeSoundCone::componentComplete()
/*!
\qmltype Sound
\instantiates QDeclarativeSound
\since 1.0
\since 5.0
\brief Define a variety of samples and parameters to be used for
SoundInstance.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -53,9 +53,9 @@ QT_USE_NAMESPACE
/*!
\qmltype SoundInstance
\instantiates QDeclarativeSoundInstance
\since 1.0
\since 5.0
\brief Play 3d audio content.
\inqmlmodule QtAudioEngine 1.0
\inqmlmodule QtAudioEngine
\ingroup multimedia_audioengine
\inherits Item
\preliminary

View File

@@ -26,54 +26,34 @@
****************************************************************************/
/*!
\page audioengineoverview.html
\title Positional Audio
\brief 3D positional audio playback and content management
\qmlmodule QtAudioEngine 1.0
\title Qt Audio Engine QML Types
\ingroup qmlmodules
\brief Provides QML types for 3D positional audio playback and content management.
Qt Audio Engine is part of the \l{Qt Multimedia} module. Qt Audio
Engine provides types for 3D positional audio playback and content management.
The QML types can be imported into your application using the following import
statement in your .qml file:
\code
import QtAudioEngine 1.0
\endcode
\section1 Qt Audio Engine Features
Qt Multimedia includes the \c QtAudioEngine QML module for
providing 3D positional audio playback and content management.
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 \l SoundInstance
for easier QML bindings.
To access these QML types import the
\b{QtAudioEngine 1.0} module.
\qml
import QtQuick 2.0
import QtAudioEngine 1.0
AudioEngine {
//...
}
\endqml
Qt Audio Engine 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 \l
SoundInstance for easier QML bindings.
\section1 Examples
\list
\li \l {AudioEngine Example}{Audio Engine}
\endlist
\section1 Reference Documentation
\section2 QML Types
\list
\li \l AudioEngine
\li \l AudioSample
\li \l AudioCategory
\li \l AttenuationModelLinear
\li \l AttenuationModelInverse
\li \l Sound
\li \l PlayVariation
\li \l AudioListener
\li \l SoundInstance
\endlist
\section1 QML types
*/

View File

@@ -33,7 +33,9 @@
Qt Multimedia is an essential module that provides a rich set of QML types
and C++ classes to handle multimedia content. It also provides necessary
APIs to access the camera and radio functionality.
APIs to access the camera and radio functionality. The included
\l{Qt Audio Engine QML Types}{Qt Audio Engine} provides types for
3D positional audio playback and management.
The \l{Qt Multimedia Widgets} module provides widget based multimedia
classes.
@@ -122,7 +124,6 @@
\list
\li \l Multimedia - overview of multimedia support in Qt
\li \l{Audio Overview}
\li \l{Positional Audio}
\li \l{Video Overview}
\li \l{Camera Overview}
\li \l{Radio Overview}
@@ -135,10 +136,20 @@
\endlist
\section2 Reference
\list
\li Qt Multimedia
\list
\li \l{Qt Multimedia QML Types}{QML Types}
\li \l{Qt Multimedia C++ Classes}{C++ Classes}
\endlist
\endlist
\list
\li Qt Audio Engine
\list
\li \l{Qt Audio Engine QML Types}{QML Types}
\endlist
\endlist
\section2 Examples
\list