WindowCapture QML Type

This type is used for capturing a window. More...

Import Statement:	`import QtMultimedia`
Since:	Qt 6.6
In C++:	QWindowCapture

List of all members, including inherited members

Properties

active : bool
error : enumeration
errorString : string
window : Window

Signals

errorChanged()

Methods

list<CapturableWindow> capturableWindows()
start()
stop()

Detailed Description

WindowCapture captures a window. It is managed by MediaCaptureSession where the captured window can be displayed in a video preview object or recorded to a file.

Window Capture Limitations

The following limitations apply to using WindowCapture:

WindowCapture is only supported with the FFmpeg backend.

See also CaptureSession and CapturableWindow.

Property Documentation

active : bool

Describes whether the capturing is currently active.

error : enumeration [read-only]

Returns a code of the last error.

errorString : string [read-only]

Returns a human readable string describing the cause of error.

window : Window

Describes the window for capturing.

Signal Documentation

errorChanged()

This signal is emitted when the error or errorString properties are changed.

This signal is not emitted whenever multiple identical errors are raised. To track such errors, use the signal errorOccurred.

Note: The corresponding handler is onErrorChanged.

Method Documentation

list<CapturableWindow> capturableWindows()

Returns a list of CapturableWindow objects that is available for capturing.

start()

stop()

© 2026 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.