- class QScreenCapture#
This class is used for capturing a screen. More…
New in version 6.5.
Synopsis#
Properties#
activeᅟ
- Whether the capturing is currently activeerrorᅟ
- The code of the last errorerrorStringᅟ
- Human readable string describing the cause of errorscreenᅟ
- The screen for capturing
Methods#
def
__init__()
def
captureSession()
def
error()
def
errorString()
def
isActive()
def
screen()
def
setScreen()
Slots#
def
setActive()
def
start()
def
stop()
Signals#
def
activeChanged()
def
errorChanged()
def
errorOccurred()
def
screenChanged()
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
- class 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
Note
Properties can be used directly when
from __feature__ import true_property
is used or via accessor functions otherwise.- property activeᅟ: bool#
This property holds whether the capturing is currently active..
- Access functions:
Signal
activeChanged()
- property errorᅟ: QScreenCapture.Error#
This property holds the code of the last error..
- Access functions:
Signal
errorChanged()
- property errorStringᅟ: str#
This property holds a human readable string describing the cause of error..
- Access functions:
Signal
errorChanged()
This property holds the screen for capturing..
- Access functions:
Signal
screenChanged()
- activeChanged(arg__1)#
- Parameters:
arg__1 – bool
Notification signal of property
activeᅟ
.- captureSession()#
- Return type:
Returns the capture session this
QScreenCapture
is connected to.Use
setScreenCapture()
to connect the camera to a session.Getter of property
errorᅟ
.- errorChanged()#
Notification signal of property
errorᅟ
.Signals when an
error
occurs, along with theerrorString
.- errorString()#
- Return type:
str
Getter of property
errorStringᅟ
.- isActive()#
- Return type:
bool
Getter of property
activeᅟ
.- screen()#
- Return type:
See also
Getter of property
screenᅟ
.Notification signal of property
screenᅟ
.- setActive(active)#
- Parameters:
active – bool
See also
Setter of property
activeᅟ
.Setter of property
screenᅟ
.- start()#
Starts screen capture.
- stop()#
Stops screen capture.