diff --git a/doc/doc.pro b/doc/doc.pro index db2f3119..d4655c9f 100644 --- a/doc/doc.pro +++ b/doc/doc.pro @@ -20,6 +20,7 @@ OTHER_FILES += \ src/radiooverview.qdoc \ src/videooverview.qdoc \ src/examples/audiodevices.qdoc \ + src/examples/audioengine.qdoc \ src/examples/audioinput.qdoc \ src/examples/audiooutput.qdoc \ src/examples/audiorecorder.qdoc \ diff --git a/doc/src/examples/audioengine.qdoc b/doc/src/examples/audioengine.qdoc new file mode 100644 index 00000000..24067cf6 --- /dev/null +++ b/doc/src/examples/audioengine.qdoc @@ -0,0 +1,39 @@ +/**************************************************************************** +** +** Copyright (C) 2012 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$ +** +****************************************************************************/ + +/*! + \example audioengine + \title AudioEngine Example + \ingroup audioengine_examples + \brief The Audio Engine example demonstrates 3D sound control using + the QtAudioEngine API. + + \image audioengine.png + +*/ + + diff --git a/doc/src/multimedia.qdoc b/doc/src/multimedia.qdoc index fb0ba873..6e3c62e0 100644 --- a/doc/src/multimedia.qdoc +++ b/doc/src/multimedia.qdoc @@ -46,7 +46,7 @@ Qt Multimedia offers APIs for doing many multimedia related tasks: \li Record audio and compress it \li Tune and listen to radio stations, and receive radio program information \li Use a camera, including viewfinder, image capture, and movie recording -\li Play 3D positional audio +\li Play 3D positional audio with \l {QtAudioEngine Overview} {QtAudioEngine} \li Decode audio media files into memory for processing \li Accessing video frames or audio buffers as they are played or recorded \endlist @@ -137,6 +137,11 @@ For some quick recipes for specific tasks, look at the overviews above and consu \li \l {Camera Example}{camera}, \l declarative-camera \li \l Camera \li QCamera, QMediaRecorder + \row + \li 3D sound sources + \li \l {AudioEngine Example}{Audio Engine} + \li \l {AudioEngine}, \l Sound + \li \endtable \section1 Limitations @@ -165,7 +170,7 @@ The following elements are accessed by using: import QtMultimedia 5.0 \endqml \annotatedlist multimedia_qml -The following elements are accessed by using: +The following elements are accessed by using \l {QtAudioEngine Overview} {QtAudioEngine}: \qml import QtAudioEngine 1.0 \endqml