1 files changed, 183 insertions, 0 deletions
diff --git a/src/multimedia/doc/src/multimedia.qdoc b/src/multimedia/doc/src/multimedia.qdoc
new file mode 100644
index 000000000..2b73fdf4d
--- /dev/null
+++ b/src/multimedia/doc/src/multimedia.qdoc
@@ -0,0 +1,183 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 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$
+**
+****************************************************************************/
+
+/*!
+\page multimediaoverview.html
+\title Multimedia Overview
+\brief A set of APIs for working with audio, video, radio and camera devices.
+
+\ingroup technology-apis
+
+
+\section1 Overview
+
+\section2 Features
+
+Qt Multimedia offers APIs for doing many multimedia related tasks:
+
+\list
+\li Accessing raw audio devices for input and output
+\li Play low latency sound effects
+\li Play media files in playlists (like compressed audio, or video files)
+\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 with \l {Positional Audio} {QtAudioEngine}
+\li Decode audio media files into memory for processing
+\li Accessing video frames or audio buffers as they are played or recorded
+\endlist
+
+\section2 Multimedia Components
+
+All of these tasks can be broadly broken down into four main areas.  More information
+(including background information and class references) are available here:
+
+\list
+\li \l {Audio Overview}
+\li \l {Video Overview}
+\li \l {Camera Overview}
+\li \l {Radio Overview}
+\endlist
+
+\section2 Multimedia Recipes
+For some quick recipes for specific tasks, look at the overviews above and consult this table:
+
+\table 70%
+    \header
+        \li Use case
+        \li Examples
+        \li QML Types
+        \li C++ Classes
+    \row
+        \li Playing a sound effect
+        \li TBD
+        \li \l SoundEffect
+        \li QSoundEffect
+    \row
+        \li Playing low latency audio
+        \li \l{audiooutput}, \l{spectrum}
+        \li
+        \li QAudioOutput
+    \row
+        \li Playing encoded audio (MP3, AAC etc)
+        \li \l{player}
+        \li \l Audio, \l {MediaPlayer}
+        \li QMediaPlayer
+    \row
+        \li Accessing raw audio input data
+        \li \l{spectrum}, \l audioinput
+        \li
+        \li QAudioInput
+    \row
+        \li Recording encoded audio data
+        \li \l audiorecorder
+        \li
+        \li QAudioRecorder
+    \row
+        \li Discovering raw audio devices
+        \li \l audiodevices
+        \li
+        \li QAudioDeviceInfo
+    \row
+        \li Video Playback
+        \li \l {player}, \l {video/qmlvideo}{qmlvideo}, \l{video/qmlvideofx}{qmlvideofx}
+        \li \l MediaPlayer, \l VideoOutput, \l Video
+        \li QMediaPlayer, QVideoWidget, QGraphicsVideoItem
+    \row
+        \li Video Processing
+        \li \l {video/qmlvideofx}{qmlvideofx}
+        \li \l {MediaPlayer}, \l VideoOutput
+        \li QMediaPlayer, QAbstractVideoSurface, QVideoFrame
+    \row
+        \li Listening to the radio
+        \li \l declarative-radio
+        \li \l Radio, \l RadioData
+        \li QRadioTuner, QRadioData
+    \row
+        \li Accessing camera viewfinder
+        \li \l {Camera Example}{camera}, \l declarative-camera
+        \li \l Camera, \l VideoOutput
+        \li QCamera, QVideoWidget, QGraphicsVideoItem
+    \row
+        \li Viewfinder processing
+        \li
+        \li \l Camera, \l VideoOutput
+        \li QCamera, QAbstractVideoSurface, QVideoFrame
+    \row
+        \li Capturing photos
+        \li \l {Camera Example}{camera}, \l declarative-camera
+        \li \l Camera
+        \li QCamera, QCameraImageCapture
+    \row
+        \li Capturing movies
+        \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
+
+In many cases the Qt Multimedia APIs build upon the multimedia framework of the underlying system.
+This can mean that support for various codec or containers can vary between machines,
+depending on what the end user has installed.
+
+\section1 Advanced Usage
+
+For developers wishing to access some platform specific settings,
+or to port the Qt Multimedia APIs to a new platform or technology,
+see \l{Multimedia Backend Development}.
+
+\section1 Changes from Previous Versions
+
+If you've previously used Qt Multimedia in Qt 4.x, or used Qt Multimedia Kit in Qt Mobility, please see
+\l {Changes in Qt Multimedia} for more information on what has changed, and what you might need to
+change when porting code.
+
+\section1 Reference Documentation
+
+\section2 QML Types
+The following types are accessed by using:
+\qml
+import QtMultimedia 5.0
+\endqml
+\annotatedlist multimedia_qml
+The following types are accessed by using \l {Positional Audio} {QtAudioEngine}:
+\qml
+import QtAudioEngine 1.0
+\endqml
+\annotatedlist multimedia_audioengine
+
+\section2 Multimedia Classes
+
+\annotatedlist multimedia
+
+*/