ScreenCapture QML Type

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

Import Statement: import QtMultimedia
Since: Qt 6.5
Instantiates: QScreenCapture


Detailed Description

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

The code below shows a simple capture session with ScreenCapture playing back the captured primary screen view in VideoOutput.

CaptureSession {
    id: captureSession
    screenCapture: ScreenCapture {
        id: screenCapture
        active: true
    videoOutput: VideoOutput {
        id: videoOutput

See also ScreenCapture and CaptureSession.

Property Documentation

active : bool

Describes whether the capturing is currently active.

[read-only] error : string

Returns a code of the last error.

[read-only] errorString : string

Returns a human readable string describing the cause of error.

screen : Screen

Describes the screen for capturing.

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