Doc: Add Qt Multimedia platform notes for Windows

Add a page with details about Qt Multimedia backends on Windows, and
link to it from the module index page.

Initially, cover the status of camera backend in WMF and DirectShow
plugins.

Task-number: QTBUG-29552
Change-Id: I53e5901e2d621c4bbc96a61d5dbb249b4debb8d4
Reviewed-by: Yoann Lopes <yoann.lopes@digia.com>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>

diff --git a/src/multimedia/doc/src/platform-notes-windows.qdoc b/src/multimedia/doc/src/platform-notes-windows.qdoc
new file mode 100644 (file)
index 0000000..2f72ea1
--- /dev/null
+++ b/src/multimedia/doc/src/platform-notes-windows.qdoc
@@ -0,0 +1,57 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+\page platform-notes-windows.html
+\title Qt Multimedia on Windows
+\brief Platform notes for Windows
+
+This page covers the availability of Qt Multimedia features on Windows.
+
+\section1 Implementation
+
+Qt Multimedia features for Windows are implemented in two plugins; one
+using the Microsoft DirectShow API, and another using WMF (Windows Media
+Foundation) framework. DirectShow API was introduced in Windows 98, and
+gradually deprecated from Windows XP onwards. Media Foundation framework
+was introduced in Windows Vista as a replacement for DirectShow and other
+multimedia APIs. Consequently, WMF plugin in Qt is supported only for
+Windows Vista and later versions of the operating system.
+
+\section1 Limitations
+
+The WMF plugin in Qt does not currently provide a camera backend. Instead,
+limited support for camera features is provided by the DirectShow
+plugin. Basic features such as displaying a viewfinder and capturing a
+still image are supported, however, majority of camera controls are not
+implemented.
+
+Video recording is currently not supported. Additionally, the DirectShow
+plugin does not support any low-level video functionality such as
+monitoring video frames being played or recorded using \l QVideoProbe or
+related classes.
+*/

diff --git a/src/multimedia/doc/src/qtmultimedia-index.qdoc b/src/multimedia/doc/src/qtmultimedia-index.qdoc
index 417c0c4..4cd59fd 100644 (file)
--- a/src/multimedia/doc/src/qtmultimedia-index.qdoc
+++ b/src/multimedia/doc/src/qtmultimedia-index.qdoc
@@ -131,6 +131,7 @@
     \section2 Platform Notes
      \list
       \li \l{BlackBerry}
+      \li \l{Qt Multimedia on Windows}{Windows}
      \endlist
 
     \section2 Reference