WindowCapture QML Type

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

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

Properties

Methods

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.

See also QtMultimedia::WindowCapture::capturableWindows.


Method Documentation

list<CapturableWindow> capturableWindows()

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


start()


stop()