Update documentation.

Rewrite the module overview, add video and audio overviews,
and update the camera overview. Tweak the radiooverview
slightly.

Still missing some links for examples and some fleshing out
but hopefully a lot better.

Change-Id: Id6486e20ba4a09c36d7739e327d4f9910ad083a5
Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>

1 files changed, 158 insertions, 0 deletions

diff --git a/doc/src/multimediaoverview.qdoc b/doc/src/multimediaoverview.qdoc
new file mode 100644
index 000000000..440a9fef0
--- /dev/null
+++ b/doc/src/multimediaoverview.qdoc
@@ -0,0 +1,158 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** 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.
+
+\section1 Multimedia Features
+
+Qt Multimedia offers APIs for doing many multimedia related tasks:
+
+\list
+\o Accessing raw audio devices for input and output
+\o Play low latency sound effects
+\o Play media files in playlists (like compressed audio, or video files)
+\o Record audio and compress it
+\o Tune and listen to radio stations, and receive radio program information
+\o Use a camera, including viewfinder, image capture, and movie recording
+\endlist
+
+\section1 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
+\o \l {Audio Overview}
+\o \l {Video Overview}
+\o \l {Camera Overview}
+\o \l {Radio Overview}
+\endlist
+
+\section1 Multimedia recipes
+For some quick recipes for specific tasks, look at the overviews above and consult this table:
+
+\table 70%
+    \header
+        \o Use case
+        \o Examples
+        \o QML Classes
+        \o C++ Classes
+    \row
+        \o Playing a sound effect
+        \o TBD
+        \o SoundEffect
+        \o QSoundEffect
+    \row
+        \o Playing low latency audio
+        \o audiooutput, spectrum
+        \o
+        \o QAudioOutput
+    \row
+        \o Playing encoded audio (MP3, AAC etc)
+        \o player
+        \o Audio, MediaPlayer
+        \o QMediaPlayer
+    \row
+        \o Accessing raw audio input data
+        \o spectrum, audioinput
+        \o
+        \o QAudioInput
+    \row
+        \o Recording encoded audio data
+        \o audiorecorder
+        \o
+        \o QAudioRecorder
+    \row
+        \o Discovering raw audio devices
+        \o audiodevices
+        \o
+        \o QAudioDeviceInfo
+    \row
+        \o Video Playback
+        \o player, qmlvideo, qmlvideofx
+        \o MediaPlayer, VideoOutput, Video
+        \o QMediaPlayer, QVideoWidget, QGraphicsVideoItem
+    \row
+        \o Video Processing
+        \o qmlvideofx
+        \o MediaPlayer, VideoOutput
+        \o QMediaPlayer, QAbstractVideoSurface, QVideoFrame
+    \row
+        \o Listening to the radio
+        \o radio, declarative-radio
+        \o Radio, RadioData
+        \o QRadioTuner, QRadioData
+    \row
+        \o Accessing camera viewfinder
+        \o camera, declarative-camera
+        \o Camera, VideoOutput
+        \o QCamera, QVideoWidget, QGraphicsVideoItem
+    \row
+        \o Viewfinder processing
+        \o
+        \o Camera, VideoOutput
+        \o QCamera, QAbstractVideoSurface, QVideoFrame
+    \row
+        \o Capturing photos
+        \o camera, declarative-camera
+        \o Camera
+        \o QCamera, QCameraImageCapture
+    \row
+        \o Capturing movies
+        \o camera, declarative-camera
+        \o Camera
+        \o QCamera, QMediaRecorder
+\endtable
+
+\section1 Multimedia 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.  See \l {Multimedia Platform Support} for more
+information on what frameworks are used and what this can mean.
+
+\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 Reference Documentation
+
+\section2 QML Elements
+
+\annotatedlist multimedia_qml
+
+\section2 Multimedia Classes
+
+\annotatedlist multimedia
+
+*/