summaryrefslogtreecommitdiff
path: root/src/multimediawidgets/doc/src/qtmultimediawidgets-index.qdoc
blob: fc5bd6df60a3bf109797d6f237bd01a4fb36c4f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page qtmultimediawidgets-index.html
\title Qt Multimedia Widgets
\brief An essential module which provides multimedia-related widgets.

Qt Multimedia Widgets provides additional multimedia-related widgets and
controls. The classes expand the capabilities of the \l{Qt Multimedia} and
\l{Qt Widgets} modules.

\section1 Getting Started

To enable Qt Multimedia Widgets in a project, add this directive into the
C++ files:
\code
#include <QtMultimediaWidgets>
\endcode

To link against the C++ libraries, add the following to your \c qmake project
file:
\code
QT += multimediawidgets
\endcode

\section1 Licenses and Attributions

The Qt Quick Multimedia Widgets module is available under commercial licenses from \l{The Qt Company}.
In addition, it is available under free software licenses. Since Qt 5.4,
these free software licenses are
\l{GNU Lesser General Public License, version 3}, or
the \l{GNU General Public License, version 2}.
See \l{Qt Licensing} for further details.

\section1 Related Information

\section2 Reference
\list
\li \l{Qt Multimedia Widgets C++ Classes}{C++ Classes}
\endlist

\section2 Examples
\list
\li \l{Camera Example}
\li \l{Media Player Example}
\li \l{Video Graphics Item Example}
\li \l{Video Widget Example}
\endlist

*/