Doc: Several cosmetic doc fixes.
[qt:qtmultimedia.git] / src / multimedia / doc / src / qtmultimedia-index.qdoc
1 /****************************************************************************
2 **
3 ** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the documentation of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:FDL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia.  For licensing terms and
14 ** conditions see http://qt.digia.com/licensing.  For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Free Documentation License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Free
19 ** Documentation License version 1.3 as published by the Free Software
20 ** Foundation and appearing in the file included in the packaging of
21 ** this file.  Please review the following information to ensure
22 ** the GNU Free Documentation License version 1.3 requirements
23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
24 ** $QT_END_LICENSE$
25 **
26 ****************************************************************************/
27
28 /*!
29     \page qtmultimedia-index.html
30     \title Qt Multimedia
31     \brief The Qt Multimedia module provides APIs for audio, video, radio, and
32     camera-related functionality.
33
34     Qt Multimedia is an essential module that provides a rich set of QML types
35     and C++ classes to handle multimedia content. It also provides necessary
36     APIs to access the camera and radio functionality.
37
38     The \l{Qt Multimedia Widgets} module provides widget based multimedia
39     classes.
40
41    \section1 Getting Started
42
43     The QML types can be imported into your applciation using the following
44     import statement in your \c {.qml} file.
45
46     \code
47      import QtMultimedia 5.0
48     \endcode
49
50     If you intend to use the C++ classes in your application, include the C++
51     definitions using the following directive:
52
53     \code
54       #include <QtMultimedia>
55     \endcode
56
57     \note If you are using a few classes from this module, we recommend
58     including those specific classes only instead of the module.
59
60     To link against the corresponding C++ libraries, add the following to your
61     \c {qmake} project file:
62
63    \code
64      QT += multimedia
65    \endcode
66
67     \section1 QML Types and C++ Classes
68
69     The following is a list of important QML types and C++ classes provided by
70     this module:
71
72     \table
73     \header
74      \li Type
75      \li Description
76     \row
77      \li \l {QtMultimedia5::Audio}{Audio}
78      \li Add audio playback functionality to a scene
79     \row
80      \li \l {QtMultimedia5::Camera}{Camera}
81      \li Access camera viewfinder frames
82     \row
83      \li MediaPlayer
84      \li Add media playback functionality to a scene. It is same as Audio type,
85      but can be used for video playback with the VideoOutput type.
86     \row
87      \li \l {QtMultimedia5::Radio}{Radio}
88      \li Access radio functionality
89     \row
90      \li \l {QtMultimedia5::Video}{Video}
91      \li Add Video playback functionality to a scene. It uses MediaPlayer and
92      VideoOutput types to provide video playback functionality.
93     \endtable
94
95     \table
96     \header
97      \li Class
98      \li Description
99     \row
100      \li QAudioOutput
101      \li Sends audio data to an audio output device
102     \row
103      \li QCamera
104      \li Access camera viewfinder.
105     \row
106      \li QCameraImageCapture
107      \li Record media content. Intended to be used with QCamera to record media.
108     \row
109      \li QMediaPlayer
110      \li Playback media from a source.
111     \row
112      \li QRadioTuner
113      \li Access radio device.
114     \row
115      \li QVideoRendererControl
116      \li Control video data.
117     \endtable
118
119     \section1 Related Information
120
121     \section2 Guides
122      \list
123       \li \l Multimedia - overview of multimedia support in Qt
124       \li \l{Audio Overview}
125       \li \l{Positional Audio}
126       \li \l{Video Overview}
127       \li \l{Camera Overview}
128       \li \l{Radio Overview}
129      \endlist
130
131     \section2 Platform Notes
132      \list
133       \li \l{BlackBerry}
134      \endlist
135
136     \section2 Reference
137      \list
138       \li \l{Qt Multimedia QML Types}{QML Types}
139       \li \l{Qt Multimedia C++ Classes}{C++ Classes}
140      \endlist
141
142     \section2 Examples
143      \list
144       \li \l{Qt Multimedia Examples}
145      \endlist
146 */