summaryrefslogtreecommitdiffstats
path: root/src/webengine/doc/src/qtwebengine-platform-notes.qdoc
blob: 5a81c777522c27182eb7e93098e03415440a63ee (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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/****************************************************************************
**
** 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 Target Platforms

    Qt WebEngine does try to support all \l{Supported Platforms} of Qt. However, due to
    different requirements of Chromium this is not always possible. Known limitations are:

    \list
        \li Qt WebEngine currently supports only Windows, Linux, and OS X.

        \li On Windows, Qt WebEngine only supports Windows Vista or newer as target platform.
            Due to use of newer API in Chromium, Windows XP is not supported. WinRT is
            not supported, either.
    \endlist

    \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 on OS X 10.9 or later
    \endlist

    \note Qt WebEngine cannot be built for the 32-bit mode of OS X (using the
    macx-clang-32 mkspec).

    \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 Pepper Flash player plugin.

    \section2 Pepper Flash Player Plugin Support

    The Pepper 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 Pepper Flash player from a specific location by using command line
    arguments:

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

    By default, the Flash version is set to \c{11.2.999.999}. You can use the
    \c{ppapi-flash-version=} argument to set another Flash version in the
    in the format \c{major.minor.build.revision}:

    \code
    --ppapi-flash-version=16.0.0.235
    \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.

    \section1 Mac App Store Compatibility

    By default, Qt WebEngine uses private OS X API, which might cause an application to be
    rejected when submitted to the Mac App Store. To configure Qt WebEngine not to use these API
    calls, Qt WebEngine has to be recompiled:

    \code
    qmake WEBENGINE_CONFIG += use_appstore_compliant_code
    \endcode

    However, this will cause some behavioral changes, such as:

    \list
        \li The OS X Kill Ring functionality will no longer work (emacs-like copy pasting).
        \li Certain Chromium sandboxing cleanup is not done.
        \li Text areas will be painted with a different style.
        \li Text fields might be painted with a different style on Mountain Lion (OS X 10.8).
    \endlist

    \section1 Default QSurfaceFormat OpenGL Profile Support

    If a new default QSurfaceFormat with a modified OpenGL profile has to be set, it should be set
    before the application instance is declared, to make sure that all created OpenGL contexts use
    the same OpenGL profile.

    On OS X, if the default QSurfaceFormat is set after the application instance, the application
    will exit with qFatal(), and print a message that the default QSurfaceFormat should be set
    before the application instance.
*/