slapin/qtmultimedia
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Doc: Updated landing page to be consistent with other module landing pages

Browse Source 
Change-Id: Ib230a7c01f2573b08f0a505fb0ada80d01757ba7
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
This commit is contained in:
Venugopal Shivashankar
2012-09-06 17:41:54 +02:00
committed by Qt by Nokia
parent f328a74153
commit e06c037e10
3 changed files with 70 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/multimedia/doc/src/qtmultimedia-cpp.qdoc
View File

@@ -27,23 +27,13 @@
/*!
\module QtMultimedia
\title Qt Multimedia - C++ Classes
\title Qt Multimedia C++ Classes
\ingroup modules
\brief The QtMultimedia module provides audio, video, radio and camera functionality.
To include the definitions of the module's classes, use the
following directive:
\code
#include <QtMultimedia>
\endcode
To link against the module, add this line to your \l qmake \c
.pro file:
\code
QT += multimedia
\endcode
\brief The \l {Qt Multimedia}{QtMultimedia} module provides audio, video, radio and camera functionality.
The C++ classes provide more control over the multimedia content than the QML alternatives.
If your application is serving complex use cases such as decoding media files, accessing video or audio buffers,
use the C++ alternative. For more details about the complex audio, video, and camera use cases supported by the C++
classes, refer to \l {Qt Multimedia Overview}.
*/

75
src/multimedia/doc/src/qtmultimedia-index.qdoc
View File

@@ -34,7 +34,25 @@
\section1 Getting started
To start using the QML types and C++ classes in your application, include/import the QtMultimedia module. Refer to \l {Qt Multimedia - QML Types} and \l {Qt Multimedia - C++ Classes}, for the include/import statements and the complete list of QML types and C++ classes.
The QML types can be imported into your applciation using the following import statement in your \c {.qml} file.
\code
import QtMultimedia 5.0
\endcode
If you intend to use the C++ classes in your application, include the C++ definitions using the following directive:
\code
#include <QtMultimedia>
\endcode
\note If your using a few classes from this module, we recommend including those specific classes only instead of the module.
To link against the corresponding C++ libraries, add the following to your \c {qmake} project file:
\code
QT += multimedia
\endcode
\section1 Key types and classes
@@ -86,15 +104,48 @@
\endtable
\section1 Related topics
\list
\li \l {Qt Multimedia Overview}
\li \l {Changes in Qt Multimedia}
\li \l {Audio Overview}
\li \l {Camera Overview}
\li \l {Radio Overview}
\li \l {Video Overview}
\li \l {Positional Audio}
\endlist
\table
\header
\li {1,4} Reference
\li {1,4} Guides
\li {4,1} Examples
\header
\li QML API examples
\li C++ API examples
\row
\li \l{Qt Multimedia QML Types}{QML Types}
\li \l{Qt Multimedia Overview}
\li
\li
\row
\li \l{Qt Multimedia C++ Classes}{C++ Classes}
\li \l{Audio Overview}
\li
\li \l{audiooutput}
\l{audioinput}
\l{audiorecorder}
\l{audiodevices}
\l{spectrum}
\row
\li
\li \l{Positional Audio}
\li
\li \l{AudioEngine Example}{Audio Engine}
\row
\li
\li \l{Video Overview}
\li \l{video/qmlvideo}{qmlvideo}
\l{video/qmlvideofx}{qmlvideofx}
\li \l {player}
\row
\li
\li \l{Camera Overview}
\li \l{declarative-camera}
\li \l{Camera Example}
\row
\li
\li \l{Radio Overview}
\li \l{declarative-radio}
\li
\endtable
*/

2
src/multimedia/doc/src/qtmultimedia5.qdoc
View File

@@ -27,7 +27,7 @@
/*!
\qmlmodule QtMultimedia 5
\title Qt Multimedia - QML Types
\title Qt Multimedia QML Types
\brief List of all QML types in the Qt Multimedia module.
\section1 Overview