QScreenCapture#

This class is used for capturing a screen. More…

Inheritance diagram of PySide6.QtMultimedia.QScreenCapture

New in version 6.5.

Synopsis#

Properties#

  • active - Whether the capturing is currently active

  • error - The code of the last error

  • errorString - Human readable string describing the cause of error

  • screen - The screen for capturing

Functions#

Slots#

Signals#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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

session = QMediaCaptureSession()
audioInput = QAudioInput()
session.setAudioInput(input)
recorder = QMediaRecorder()
session.setRecorder(recorder)
recorder.setQuality(QMediaRecorder.HighQuality)
recorder.setOutputLocation(QUrl.fromLocalFile("test.mp3"))
recorder.record()

Screen Capture Limitations#

On Qt 6.5.2 and 6.5.3, the following limitations apply to using QScreenCapture :

  • It is only supported with the FFmpeg backend.

  • It is supported on all desktop platforms, except Linux with Wayland compositor, due to Wayland protocol restrictions and limitations.

  • It is not supported on mobile operating systems, except on Android. There, you might run into performance issues as the class is currently implemented via QScreen::grabWindow, which is not optimal for the use case.

  • On Linux, it works with X11, but it has not been tested on embedded.

  • In most cases, we set a screen capture frame rate that equals the screen refresh rate, except on Windows, where the rate might be flexible. Such a frame rate (75/120 FPS) might cause performance issues on weak CPUs if the captured screen is of 4K resolution.

See also

QWindowCapture QMediaCaptureSession

class PySide6.QtMultimedia.QScreenCapture([parent=None])#
Parameters:

parent – PySide6.QtCore.QObject

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property PᅟySide6.QtMultimedia.QScreenCapture.active: bool#

This property holds whether the capturing is currently active..

Access functions:
property PᅟySide6.QtMultimedia.QScreenCapture.error: Error#

This property holds the code of the last error..

Access functions:
property PᅟySide6.QtMultimedia.QScreenCapture.errorString: str#

This property holds a human readable string describing the cause of error..

Access functions:
property PᅟySide6.QtMultimedia.QScreenCapture.screen: PySide6.QtGui.QScreen#

This property holds the screen for capturing..

Access functions:
PySide6.QtMultimedia.QScreenCapture.Error#

Enumerates error codes that can be signaled by the QScreenCapture class. errorString() provides detailed information about the error cause.

Constant

Description

QScreenCapture.NoError

No error

QScreenCapture.InternalError

Internal screen capturing driver error

QScreenCapture.CapturingNotSupported

Capturing is not supported

QScreenCapture.CaptureFailed

Capturing screen failed

QScreenCapture.NotFound

Selected screen not found
PySide6.QtMultimedia.QScreenCapture.activeChanged(arg__1)#
Parameters:

arg__1 – bool

Notification signal of property active .

PySide6.QtMultimedia.QScreenCapture.captureSession()#
Return type:

PySide6.QtMultimedia.QMediaCaptureSession

Returns the capture session this QScreenCapture is connected to.

Use setScreenCapture() to connect the camera to a session.

PySide6.QtMultimedia.QScreenCapture.error()#
Return type:

Error

Getter of property error .

PySide6.QtMultimedia.QScreenCapture.errorChanged()#

Notification signal of property error .

PySide6.QtMultimedia.QScreenCapture.errorOccurred(error, errorString)#
Parameters:

  • error – Error

  • errorString – str

Signals when an error occurs, along with the errorString.

PySide6.QtMultimedia.QScreenCapture.errorString()#
Return type:

str

Getter of property errorString .

PySide6.QtMultimedia.QScreenCapture.isActive()#
Return type:

bool

Getter of property active .

PySide6.QtMultimedia.QScreenCapture.screen()#
Return type:

PySide6.QtGui.QScreen

See also

setScreen()

Getter of property screen .

PySide6.QtMultimedia.QScreenCapture.screenChanged(arg__1)#
Parameters:

arg__1 – PySide6.QtGui.QScreen

Notification signal of property screen .

PySide6.QtMultimedia.QScreenCapture.setActive(active)#
Parameters:

active – bool

See also

isActive()

Setter of property active .

PySide6.QtMultimedia.QScreenCapture.setScreen(screen)#
Parameters:

screen – PySide6.QtGui.QScreen

See also

screen()

Setter of property screen .

PySide6.QtMultimedia.QScreenCapture.start()#

Starts screen capture.

PySide6.QtMultimedia.QScreenCapture.stop()#

Stops screen capture.