summaryrefslogtreecommitdiffstats
path: root/src/webengine/doc/src/qtwebengine-platform-notes.qdoc
blob: 55f6c550402ac6d7ac2b358e535aad0fc5704c1e (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://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 qtwebengine-platform-notes.html
    \title Qt WebEngine Platform Notes

    \brief Contains information about issues that are specific to the Qt WebEngine module.

    \section1 Building Qt WebEngine from Source

    The requirements for building Qt 5 modules from source are listed separately for each supported
    platform:

    \list
        \li \l{Qt for Windows - Requirements}
        \li \l{Qt for X11 Requirements}
        \li \l{Qt for OS X - Requirements}
    \endlist

    In addition, the following tools are required for building the \l {Qt WebEngine} module:

    \list
        \li Windows: Visual Studio 2013 or Visual Studio 2015
        \li Linux: Clang or GCC version 4.7 or later
        \li OS X: Xcode version 5.1 or later
    \endlist

    \section1 Pepper Plugin API Support

    Qt WebEngine supports loading Pepper Plugin API (PPAPI) plugins. The plugins must be loaded
    manually using the Chromium command line syntax with the \c --register-pepper-plugins argument.
    The argument value is a list of entries, separated by commas, that contain the file path and
    one or several MIME types, separated by semicolons:

    \code
    <file-path-plugin1>;<mime-type-plugin1>,<file-path-plugin2>;<mime-type1-plugin2>;<mime-type2-plugin2>
    \endcode

    For example:

    \code
    --register-pepper-plugins="libppapi_example.so;application/x-ppapi-example"
    \endcode

    The MIME type is important because it determines which embeds the plugin is used for.

    This process has been automated for the Adobe Flash Player Plugin.

    \section2 Adobe Flash Player Plugin Support

    The Adobe Flash player plugin can be loaded automatically if it is installed in one of the
    following locations, depending on the platform:

    \list
        \li Windows
            \code
            C:\Windows\SysWOW64\Macromed\Flash\pepflashplayer*.dll
            C:\Windows\System32\Macromed\Flash\pepflashplayer*.dll
            \endcode
        \li OS X
            \code
            /Library/Internet Plug-Ins/PepperFlashPlayer/PepperFlashPlayer.plugin
            \endcode
        \li Linux
            \code
            /usr/lib/pepperflashplugin-nonfree/libpepflashplayer.so
            /usr/lib/PepperFlash/libpepflashplayer.so
            /usr/lib64/chromium/PepperFlash/libpepflashplayer.so
            \endcode
    \endlist

    You can also load the Flash player from a specific location by using command line arguments:

    \code
    --ppapi-flash-path=./libpepflashplayer.so
    \endcode

    \section1 Audio and Video Codec Support

    Qt WebEngine supports the MPEG-4 Part 14 (MP4) file format only if the required proprietary
    audio and video codecs, such as H.264 and MPEG layer-3 (MP3), have been enabled. Proprietary
    codecs can be enabled by passing the following option to qmake:

    \code
    qmake WEBENGINE_CONFIG += use_proprietary_codecs
    \endcode

    \warning When distributing proprietary codec libraries, you must acquire licenses for them.

    \l FFmpeg is a cross-platform solution to record, convert, and stream audio and video. It can
    be configured for use with several codecs, which rises licensing issues during distribution
    with the codec libraries. For some codecs, open source implementations, such as \l {OpenH264},
    are available.
*/