diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2013-10-02 16:27:06 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-03 10:54:17 +0200 |
commit | 3793b0653f4127e8f84808419b05115a66c3bc03 (patch) | |
tree | 5b76d644393791ac555595ae162d66b3544328cb /src/multimedia/doc/src/qtaudioengine.qdoc | |
parent | 43be5d9763eea0b7a71c627f05ffb5de0b97249f (diff) |
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>
Diffstat (limited to 'src/multimedia/doc/src/qtaudioengine.qdoc')
-rw-r--r-- | src/multimedia/doc/src/qtaudioengine.qdoc | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/src/multimedia/doc/src/qtaudioengine.qdoc b/src/multimedia/doc/src/qtaudioengine.qdoc new file mode 100644 index 000000000..b6fec8b19 --- /dev/null +++ b/src/multimedia/doc/src/qtaudioengine.qdoc @@ -0,0 +1,59 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** 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. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\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 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 QML types +*/ |