/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/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
*/
