slapin/qtmultimedia
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Doc: Various fixes to Qt Audio Engine documentation

Browse Source 
-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
Download Patch File Download Diff File Expand all files Collapse all files

60
src/multimedia/doc/src/audioengineoverview.qdoc → src/multimedia/doc/src/qtaudioengine.qdoc
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.
\section1 QtAudioEngine Features
Qt Audio Engine is part of the \l{Qt Multimedia} module. Qt Audio
Engine provides types for 3D positional audio playback and content management.
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
The QML types can be imported into your application using the following import
statement in your .qml file:
\code
import QtAudioEngine 1.0
\endcode
AudioEngine {
//...
}
\endqml
\section1 Qt Audio Engine Features
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
*/

23
src/multimedia/doc/src/qtmultimedia-index.qdoc
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 \l{Qt Multimedia QML Types}{QML Types}
\li \l{Qt Multimedia C++ Classes}{C++ Classes}
\endlist
\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