PySide6.QtMultimedia.QCapturableWindow¶

class QCapturableWindow¶

Used for getting the basic information of a capturable window.

Details

The class contains a set of window information, except the method isValid which pulls the current state whenever it’s called.

See also

QWindowCapture

Added in version 6.6.

Synopsis¶

Methods¶

def __init__()
def description()
def isValid()
def __ne__()
def swap()

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

Note

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

property descriptionᅟ: str¶

Access functions:

description()

property isValidᅟ: bool¶

Access functions:

isValid()

__init__()¶

Constructs a null capturable window information that doesn’t refer to any window.

__init__(window)

Parameters:: window – QWindow

Constructs a QCapturableWindow instance that maps to the given window.

The description of the QCapturableWindow will match the title of the given QWindow.

Note, the constructor may create an invalid instance if the specified QWindow has not been presented yet. Thus, if the Qt application is not running, an invalid QCapturableWindow instance is expected. The validity of the instance can be tracked by querying isValid over time.

If given a nullptr as input, this method will return an instance that will never become valid.

If given a window that is not top-level, this method will return an instance will never become valid.

__init__(other)

Parameters:: other – QCapturableWindow

Construct a new window information using other QCapturableWindow .

description()¶

Return type:: str

Returns a description of the window. In most cases it represents the window title.

Getter of property descriptionᅟ .

isValid()¶

Return type:: bool

Identifies whether a window information is valid.

An invalid window information refers to non-existing window or doesn’t refer to any one.

Returns true if the window is valid, and false if it is not.

Getter of property isValidᅟ .

__ne__(rhs)¶

Parameters:: rhs – QCapturableWindow
Return type:: bool

Returns true if window information lhs and rhs refer to different windows, otherwise returns false.

swap(other)¶

Parameters:: other – QCapturableWindow

Swaps the current window information with other.