Back to Qt.io
Contact Us Blog Download Qt

QWebEngineDesktopMediaRequest Class

A request for populating a dialog with available sources for screen capturing. More...

Header: #include <QWebEngineDesktopMediaRequest>
CMake: find_package(Qt6 REQUIRED COMPONENTS WebEngineCore)
target_link_libraries(mytarget PRIVATE Qt6::WebEngineCore)
qmake: QT += webenginecore
Since: Qt 6.7

Public Functions

void cancel() const
QAbstractListModel *screensModel() const
void selectScreen(const QModelIndex &index) const
void selectWindow(const QModelIndex &index) const
QAbstractListModel *windowsModel() const

Detailed Description

To allow web applications to capture contents of a display, applications must connect to QWebEnginePage::desktopMediaRequested, which takes a QWebEngineDesktopMediaRequest instance as an argument.

If a web application requests access to the contents of a display, QWebEnginePage::desktopMediaRequested will be emitted with a QWebEngineDesktopMediaRequest instance as an argument which holds references to QAbstractListModels for available windows and screens that can be captured.

The data model's Qt::DisplayRole specifies the name of the source which is the title of a window or the number of the display. The model is dynamically updates if the available list of sources has changed e.g a window is opened/closed.

The signal handler needs to then either call QWebEngineDesktopMediaRequest:selectScreen() or QWebEngineDesktopMediaRequest::selectWindow() to accept the request and start screensharing.

See also QWebEnginePage::desktopMediaRequested().

Member Function Documentation

[invokable] void QWebEngineDesktopMediaRequest::cancel() const

Rejects a request. Screen capturing will be aborted.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

QAbstractListModel *QWebEngineDesktopMediaRequest::screensModel() const

Returns a QAbstractListModel for the available screens.

Note: Getter function for property screensModel.

See also windowsModel().

[invokable] void QWebEngineDesktopMediaRequest::selectScreen(const QModelIndex &index) const

Selects the screen on the index to be captured.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

See also QWebEngineDesktopMediaRequest::selectWindow().

[invokable] void QWebEngineDesktopMediaRequest::selectWindow(const QModelIndex &index) const

Selects the window on the index to be captured.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

See also QWebEngineDesktopMediaRequest::selectScreen().

QAbstractListModel *QWebEngineDesktopMediaRequest::windowsModel() const

Returns a QAbstractListModel for the available windows.

Note: Getter function for property windowsModel.

See also screensModel().

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.