diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2020-03-26 17:16:52 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2020-04-02 23:30:02 +0100 |
commit | b688719130142e1bee4b7e1c010332dc65e89cb5 (patch) | |
tree | 70c95767bfe917e9d9329cd195a977242a98f54c | |
parent | 0223d2911cea5a8a412e4b8a625c19b8c8b7848b (diff) |
Doc: Fix docs for playbackRequiresUserGesture WebEngine setting
Fixes: QTBUG-83101
Change-Id: I7ca8271cc88c7e157c36c79e06fa378f4bce48e4
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
-rw-r--r-- | src/webengine/api/qquickwebenginesettings.cpp | 8 | ||||
-rw-r--r-- | src/webengine/doc/src/external-resources.qdoc | 5 | ||||
-rw-r--r-- | src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc | 8 |
3 files changed, 16 insertions, 5 deletions
diff --git a/src/webengine/api/qquickwebenginesettings.cpp b/src/webengine/api/qquickwebenginesettings.cpp index 9a102a504..78fbe16e8 100644 --- a/src/webengine/api/qquickwebenginesettings.cpp +++ b/src/webengine/api/qquickwebenginesettings.cpp @@ -404,10 +404,14 @@ bool QQuickWebEngineSettings::showScrollBars() const \qmlproperty bool WebEngineSettings::playbackRequiresUserGesture \since QtWebEngine 1.7 Inhibits playback of media content until the user interacts with - the page. Disabled by default. + the page. + + By default, Qt WebEngine uses Chromium settings, as described in + \l {Autoplay Policy Changes}. To overwrite the default behavior, + this property must be set to \c false. \note The behavior is similar to Chrome on Android when enabled, - and similar to Chrome on desktops when disabled (default). + and similar to Chrome on desktops when disabled. */ bool QQuickWebEngineSettings::playbackRequiresUserGesture() const { diff --git a/src/webengine/doc/src/external-resources.qdoc b/src/webengine/doc/src/external-resources.qdoc index 55f6a68a3..acf63fb04 100644 --- a/src/webengine/doc/src/external-resources.qdoc +++ b/src/webengine/doc/src/external-resources.qdoc @@ -139,3 +139,8 @@ \externalpage https://www.w3.org/TR/notifications \title Web Notifications API */ + +/*! + \externalpage https://developers.google.com/web/updates/2017/09/autoplay-policy-changes + \title Autoplay Policy Changes +*/ diff --git a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc index 0706598ef..5cd0132aa 100644 --- a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc @@ -175,9 +175,11 @@ Enabled by default. (Added in Qt 5.10) \value PlaybackRequiresUserGesture Inhibits playback of media content until the user interacts with - the page. This is similar to how Chrome on Android behaves, while - the default behavior when it is disabled is similar to Chrome on desktops. - (Added in Qt 5.11) + the page. By default, WebEngine uses Chromium settings, as described + in \l {Autoplay Policy Changes}. This is similar to how Chrome on + Android behaves, while the default behavior when it is disabled is + similar to Chrome on desktops. To overwrite the default behavior, + disable this setting. (Added in Qt 5.11) \value JavascriptCanPaste Enables JavaScript \c{execCommand("paste")}. This also requires enabling JavascriptCanAccessClipboard. |