\inmodule QtMultimedia More...

#include <qwindowcapture.h>

Inheritance diagram for QWindowCapture:

Collaboration diagram for QWindowCapture:

Public Types
enum	Error { NoError = 0 , InternalError = 1 , CapturingNotSupported = 2 , CaptureFailed = 4 , NotFound = 5 }
	\qmltype WindowCapture \nativetype QWindowCapture \inqmlmodule QtMultimedia More...

Public Slots
void	setActive (bool active)
void	start ()
	\qmlmethod void QtMultimedia::WindowCapture::start()
void	stop ()
	\qmlmethod void QtMultimedia::WindowCapture::stop()
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	activeChanged (bool)
void	windowChanged (QCapturableWindow window)
void	errorChanged ()
	\qmlsignal QtMultimedia::WindowCapture::errorChanged()
void	errorOccurred (QWindowCapture::Error error, const QString &errorString)
	\qmlsignal QtMultimedia::WindowCapture::errorOccurred(int error, string errorString)
	Q_REVISION (6, 12) void maximumFrameRateChanged()
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QWindowCapture (QObject *parent=nullptr)
	Constructs a new QWindowCapture object with parent.
	~QWindowCapture () override
	Destroys the object.
QMediaCaptureSession *	captureSession () const
	Returns the capture session this QWindowCapture is connected to.
void	setWindow (QCapturableWindow window)
QCapturableWindow	window () const
bool	isActive () const
Error	error () const
QString	errorString () const
void	setMaximumFrameRate (std::optional< qreal > frameRate)
std::optional< qreal >	maximumFrameRate () const
void	resetMaximumFrameRate ()
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlExposed () const noexcept
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Static Public Member Functions
static Q_INVOKABLE QList< QCapturableWindow >	capturableWindows ()
	\qmlmethod list<CapturableWindow> QtMultimedia::WindowCapture::capturableWindows()
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}.
static bool	disconnect (QMetaObject::Connection &)
static bool	disconnect (QMetaObject::Connection &&conn)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Properties
bool	active
	\qmlproperty bool QtMultimedia::WindowCapture::active Describes whether the capturing is currently active.
QCapturableWindow	window
	\qmlproperty Window QtMultimedia::WindowCapture::window Describes the window for capturing.
Error	error
	\qmlproperty enumeration QtMultimedia::WindowCapture::error Returns a code of the last error.
QString	errorString
	\qmlproperty string QtMultimedia::WindowCapture::errorString Returns a human readable string describing the cause of error.
std::optional< qreal >	maximumFrameRate
	The window capture frame rate upper limit.
Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QMediaCaptureSession

Additional Inherited Members
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

\inmodule QtMultimedia

Since: 6.6

This class is used for capturing a window.

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

The following snippet shows how to select one of the capturable windows and display the result in a \l QVideoWidget:

{content} {Q}

See also: QMediaCaptureSession, QCapturableWindow

Definition at line 18 of file qwindowcapture.h.

Member Enumeration Documentation

◆ Error

enum QWindowCapture::Error

\qmltype WindowCapture \nativetype QWindowCapture \inqmlmodule QtMultimedia

Since: 6.6

This type is used for capturing a window.

WindowCapture captures a window. It is managed by \l {QtMultimedia::CaptureSession}{CaptureSession} where the captured window can be displayed in a video preview object or recorded to a file.

The code below shows a simple capture session that captures one of the available windows with WindowCapture and plays it back in a \l {QtMultimedia::VideoOutput}{VideoOutput}.

{content} {}

See also: CaptureSession, CapturableWindow

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

\value NoError No error \value InternalError Internal window capturing driver error \value CapturingNotSupported Window capturing is not supported \value CaptureFailed Capturing window failed \value NotFound Selected window not found

Enumerator
NoError
InternalError
CapturingNotSupported
CaptureFailed
NotFound

Definition at line 28 of file qwindowcapture.h.

Constructor & Destructor Documentation

◆ QWindowCapture()

QWindowCapture::QWindowCapture ( QObject * parent = nullptr )

explicit

Constructs a new QWindowCapture object with parent.

Definition at line 90 of file qwindowcapture.cpp.

◆ ~QWindowCapture()

QWindowCapture::~QWindowCapture ( )

override

Destroys the object.

Definition at line 121 of file qwindowcapture.cpp.

Member Function Documentation

◆ activeChanged

void QWindowCapture::activeChanged ( bool )

signal

◆ capturableWindows()

QList< QCapturableWindow > QWindowCapture::capturableWindows ( )

static

\qmlmethod list<CapturableWindow> QtMultimedia::WindowCapture::capturableWindows()

Returns a list of \l{QtMultimedia::CapturableWindow}{CapturableWindow} objects that are currently available for capturing.

Note: On macOS, invoking this method will trigger the "Screen Recording" permission dialog. If permissions have not yet been granted, this method will return an empty list. Invoking it multiple times will bring this dialog to the foreground.

Returns a list of \l QCapturableWindow objects that are currently available for capturing.

Note: On macOS, invoking this method will trigger the "Screen Recording" permission dialog. If permissions have not yet been granted, this method will return an empty list. Invoking it multiple times will bring this dialog to the foreground.

Definition at line 151 of file qwindowcapture.cpp.

◆ captureSession()

QMediaCaptureSession * QWindowCapture::captureSession ( ) const

Returns the capture session this QWindowCapture is connected to.

Use \l QMediaCaptureSession::setWindowCapture() to connect the window capture to a session.

Definition at line 162 of file qwindowcapture.cpp.

◆ error()

QWindowCapture::Error QWindowCapture::error ( ) const

Definition at line 328 of file qwindowcapture.cpp.

◆ errorChanged

void QWindowCapture::errorChanged ( )

signal

\qmlsignal QtMultimedia::WindowCapture::errorChanged()

This signal is emitted when the \l{error} or \l{errorString} properties are changed.

This signal is not emitted whenever multiple identical errors are raised. To track such errors, use the signal \l errorOccurred.

This signal is emitted when the \l{error} or \l{errorString} properties are changed.

This signal is not emitted whenever multiple identical errors are raised. To track such errors, use the signal \l errorOccurred.

◆ errorOccurred

void QWindowCapture::errorOccurred	(	QWindowCapture::Error	error,
		const QString &	errorString )

signal

\qmlsignal QtMultimedia::WindowCapture::errorOccurred(int error, string errorString)

Signals when an error occurs, along with the errorString.

For the error parameter, see the enumeration table in \l {QtMultimedia::WindowCapture::error}{error} for what values may be passed.

See also: {QtMultimedia::WindowCapture::error}{error}

Signals when an error occurs, along with the errorString.

◆ errorString()

QString QWindowCapture::errorString ( ) const

Definition at line 361 of file qwindowcapture.cpp.

◆ isActive()

bool QWindowCapture::isActive ( ) const

Definition at line 219 of file qwindowcapture.cpp.

◆ maximumFrameRate()

std::optional< qreal > QWindowCapture::maximumFrameRate ( ) const

Definition at line 255 of file qwindowcapture.cpp.

◆ Q_REVISION

QWindowCapture::Q_REVISION	(	6	,
		12	)

signal

◆ resetMaximumFrameRate()

void QWindowCapture::resetMaximumFrameRate ( )

Definition at line 262 of file qwindowcapture.cpp.

◆ setActive

void QWindowCapture::setActive ( bool active )

slot

Definition at line 226 of file qwindowcapture.cpp.

◆ setMaximumFrameRate()

void QWindowCapture::setMaximumFrameRate ( std::optional< qreal > frameRate )

Definition at line 247 of file qwindowcapture.cpp.

◆ setWindow()

void QWindowCapture::setWindow ( QCapturableWindow window )

Definition at line 198 of file qwindowcapture.cpp.

◆ start

void QWindowCapture::start ( )

inlineslot

\qmlmethod void QtMultimedia::WindowCapture::start()

Starts capturing the \l window.

This is equivalent to setting the \l active property to true.

Starts capturing the \l window.

This is equivalent to setting the \l active property to true.

Definition at line 59 of file qwindowcapture.h.

◆ stop

void QWindowCapture::stop ( )

inlineslot

\qmlmethod void QtMultimedia::WindowCapture::stop()

Stops capturing.

This is equivalent to setting the \l active property to false.

Stops capturing.

This is equivalent to setting the \l active property to false.

Definition at line 60 of file qwindowcapture.h.

◆ window()

QCapturableWindow QWindowCapture::window ( ) const

Definition at line 190 of file qwindowcapture.cpp.

◆ windowChanged

void QWindowCapture::windowChanged ( QCapturableWindow window )

signal

◆ QMediaCaptureSession

friend class QMediaCaptureSession

friend

Definition at line 73 of file qwindowcapture.h.

Property Documentation

◆ active

bool QWindowCapture::active

readwrite

\qmlproperty bool QtMultimedia::WindowCapture::active Describes whether the capturing is currently active.

See also: start(), stop()

whether the capturing is currently active.

See also: start(), stop()

Definition at line 21 of file qwindowcapture.h.

◆ error

Error QWindowCapture::error

read

\qmlproperty enumeration QtMultimedia::WindowCapture::error Returns a code of the last error.

\qmlenumeratorsfrom QWindowCapture::Error

the code of the last error.

Definition at line 23 of file qwindowcapture.h.

◆ errorString

QString QWindowCapture::errorString

read

\qmlproperty string QtMultimedia::WindowCapture::errorString Returns a human readable string describing the cause of error.

a human readable string describing the cause of error.

Definition at line 24 of file qwindowcapture.h.

◆ maximumFrameRate

std::optional<qreal> QWindowCapture::maximumFrameRate

readwrite

The window capture frame rate upper limit.

Since: 6.12

This can be set to override the capture frame rate used by default based on e.g. display refresh rate, but only as an upper limit since window capture produces frames at a variable rate. Setting this higher than the display refresh rate is not recommended and can cause errors.

Any changes to this property are applied the next time the QWindowCapture goes active.

Definition at line 25 of file qwindowcapture.h.

◆ window

QCapturableWindow QWindowCapture::window

readwrite

\qmlproperty Window QtMultimedia::WindowCapture::window Describes the window for capturing.

Setting this property to an invalid window on an active WindowCapture will cause it to go inactive and emit an error.

See also: capturableWindows

the window for capturing.

Setting this property to an invalid window on an active QWindowCapture will cause it to go inactive and emit an error.

See also: QWindowCapture::capturableWindows

Definition at line 22 of file qwindowcapture.h.

The documentation for this class was generated from the following files:

qtmultimedia/src/multimedia/recording/qwindowcapture.h (788302f9b2493bc38a3b969a9aa33520d0f8239c)
qtmultimedia/src/multimedia/recording/qwindowcapture.cpp (d67fd541f981d47ddc7594651d53066d2c3f0029)

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Error

Constructor & Destructor Documentation

◆ QWindowCapture()

◆ ~QWindowCapture()

Member Function Documentation

◆ activeChanged

◆ capturableWindows()

◆ captureSession()

◆ error()

◆ errorChanged

◆ errorOccurred

◆ errorString()

◆ isActive()

◆ maximumFrameRate()

◆ Q_REVISION

◆ resetMaximumFrameRate()

◆ setActive

◆ setMaximumFrameRate()

◆ setWindow()

◆ start

◆ stop

◆ window()

◆ windowChanged

Friends And Related Symbol Documentation

◆ QMediaCaptureSession

Property Documentation

◆ active

◆ error

◆ errorString

◆ maximumFrameRate

◆ window