class QScreenCapture#

This class is used for capturing a screen. More

Inheritance diagram of PySide6.QtMultimedia.QScreenCapture

New in version 6.5.

Synopsis#

Properties#

Methods#

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()
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:
property errorᅟ: QScreenCapture.Error#

This property holds the code of the last error..

Access functions:
property errorStringᅟ: str#

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

Access functions:
property screenᅟ: QScreen#

This property holds the screen for capturing..

Access functions:
__init__([parent=None])#
Parameters:

parentQObject

activeChanged(arg__1)#
Parameters:

arg__1 – bool

Notification signal of property activeᅟ .

captureSession()#
Return type:

QMediaCaptureSession

Returns the capture session this QScreenCapture is connected to.

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

error()#
Return type:

Error

Getter of property errorᅟ .

errorChanged()#

Notification signal of property errorᅟ .

errorOccurred(error, errorString)#
Parameters:
  • errorError

  • errorString – str

Signals when an error occurs, along with the errorString.

errorString()#
Return type:

str

Getter of property errorStringᅟ .

isActive()#
Return type:

bool

Getter of property activeᅟ .

screen()#
Return type:

QScreen

See also

setScreen()

Getter of property screenᅟ .

screenChanged(arg__1)#
Parameters:

arg__1QScreen

Notification signal of property screenᅟ .

setActive(active)#
Parameters:

active – bool

See also

isActive()

Setter of property activeᅟ .

setScreen(screen)#
Parameters:

screenQScreen

See also

screen()

Setter of property screenᅟ .

start()#

Starts screen capture.

stop()#

Stops screen capture.