\inmodule QtMultimedia More...

#include <qscreencapture.h>

Inheritance diagram for QScreenCapture:

Collaboration diagram for QScreenCapture:

Public Types
enum	Error { NoError = 0 , InternalError = 1 , CapturingNotSupported = 2 , CaptureFailed = 4 , NotFound = 5 }
	Enumerates error codes that can be signaled by the QScreenCapture class. More...

Public Slots
void	setActive (bool active)

void	start ()
	Starts screen capture.

void	stop ()
	Stops screen capture.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	activeChanged (bool)

void	errorChanged ()

void	screenChanged (QScreen *)

void	errorOccurred (QScreenCapture::Error error, const QString &errorString)
	Signals when an error occurs, along with the errorString.

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
	QScreenCapture (QObject *parent=nullptr)

	~QScreenCapture () override

QMediaCaptureSession *	captureSession () const
	Returns the capture session this QScreenCapture is connected to.

void	setScreen (QScreen *screen)

QScreen *	screen () const

bool	isActive () const

Error	error () const

QString	errorString () const

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	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`.

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

QScreen *	screen
	\qmlproperty Screen QtMultimedia::ScreenCapture::screen Describes the screen for capturing.

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

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

Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QMediaCaptureSession

Additional Inherited Members
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 &)
	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)

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.5

This class is used for capturing a screen.

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.

{content} {Q}

See also: QWindowCapture, QMediaCaptureSession

Definition at line 20 of file qscreencapture.h.

Member Enumeration Documentation

◆ Error

enum QScreenCapture::Error

Enumerates error codes that can be signaled by the QScreenCapture class.

errorString() provides detailed information about the error cause.

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

Enumerator
NoError
InternalError
CapturingNotSupported
CaptureFailed
NotFound

Definition at line 29 of file qscreencapture.h.

Constructor & Destructor Documentation

◆ QScreenCapture()

QScreenCapture::QScreenCapture ( QObject * parent = nullptr )

explicit

\qmltype ScreenCapture
\instantiates QScreenCapture
\brief This type is used for capturing a screen.

\inqmlmodule QtMultimedia
\ingroup multimedia_qml
\ingroup multimedia_video_qml

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

\since 6.5
The code below shows a simple capture session with ScreenCapture playing
back the captured primary screen view in VideoOutput.

\qml CaptureSession { id: captureSession screenCapture: ScreenCapture { id: screenCapture active: true } videoOutput: VideoOutput { id: videoOutput } } \endqml

\include qscreencapture-limitations.qdocinc {content} {}

\sa WindowCapture, CaptureSession

Definition at line 78 of file qscreencapture.cpp.

References QPlatformVideoSource::activeChanged(), activeChanged(), QObject::connect(), d, emit, error, QPlatformVideoSource::errorChanged(), errorChanged(), QPlatformSurfaceCapture::errorOccurred(), errorOccurred(), errorString, QPlatformMediaIntegration::instance(), screenChanged(), QPlatformSurfaceCapture::sourceChanged(), and toScreenCaptureError().

Here is the call graph for this function:

◆ ~QScreenCapture()

QScreenCapture::~QScreenCapture ( )

override

Definition at line 103 of file qscreencapture.cpp.

References d.

Member Function Documentation

◆ activeChanged

void QScreenCapture::activeChanged ( bool )

signal

Referenced by QScreenCapture().

Here is the caller graph for this function:

◆ captureSession()

QMediaCaptureSession * QScreenCapture::captureSession ( ) const

Returns the capture session this QScreenCapture is connected to.

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

Definition at line 133 of file qscreencapture.cpp.

References d.

Referenced by QMediaCaptureSession::setScreenCapture().

Here is the caller graph for this function:

◆ error()

QScreenCapture::Error QScreenCapture::error ( ) const

Definition at line 200 of file qscreencapture.cpp.

References CapturingNotSupported, d, and toScreenCaptureError().

Here is the call graph for this function:

◆ errorChanged

void QScreenCapture::errorChanged ( )

signal

Referenced by QScreenCapture().

Here is the caller graph for this function:

◆ errorOccurred

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

signal

Signals when an error occurs, along with the errorString.

Referenced by QScreenCapture().

Here is the caller graph for this function:

◆ errorString()

QString QScreenCapture::errorString ( ) const

Definition at line 222 of file qscreencapture.cpp.

References d.

◆ isActive()

bool QScreenCapture::isActive ( ) const

Definition at line 157 of file qscreencapture.cpp.

References d.

◆ screen()

QScreen * QScreenCapture::screen ( ) const

Definition at line 182 of file qscreencapture.cpp.

References d.

◆ screenChanged

void QScreenCapture::screenChanged ( QScreen * )

signal

Referenced by QQuickScreenCatpure::QQuickScreenCatpure(), and QScreenCapture().

Here is the caller graph for this function:

◆ setActive

void QScreenCapture::setActive ( bool active )

slot

Definition at line 149 of file qscreencapture.cpp.

References active, and d.

◆ setScreen()

void QScreenCapture::setScreen ( QScreen * screen )

Definition at line 174 of file qscreencapture.cpp.

References d, and screen.

Referenced by QQuickScreenCatpure::qmlSetScreen().

Here is the caller graph for this function:

◆ start

void QScreenCapture::start ( )

inlineslot

Starts screen capture.

Definition at line 53 of file qscreencapture.h.

◆ stop

void QScreenCapture::stop ( )

inlineslot

Stops screen capture.

Definition at line 54 of file qscreencapture.h.

Friends And Related Symbol Documentation

◆ QMediaCaptureSession

friend class QMediaCaptureSession

friend

Definition at line 65 of file qscreencapture.h.

Property Documentation

◆ active

QScreenCapture::active

readwrite

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

whether the capturing is currently active.

Definition at line 23 of file qscreencapture.h.

Referenced by setActive().

◆ error

QScreenCapture::error

read

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

the code of the last error.

Definition at line 25 of file qscreencapture.h.

Referenced by QScreenCapture().

◆ errorString

QScreenCapture::errorString

read

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

a human readable string describing the cause of error.

Definition at line 26 of file qscreencapture.h.

Referenced by QScreenCapture().

◆ screen

QScreenCapture::screen

readwrite

\qmlproperty Screen QtMultimedia::ScreenCapture::screen Describes the screen for capturing.

the screen for capturing.

Definition at line 24 of file qscreencapture.h.

Referenced by setScreen().

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

qtmultimedia/src/multimedia/recording/qscreencapture.h (aff72ee9082ae770746b4da9ddafa1a867ba31d2)
qtmultimedia/src/multimedia/recording/qscreencapture.cpp (8fad1fafc746ff70971413302770d3681dae8f5a)

Public Types

Public Slots

Signals

Public Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Error

Constructor & Destructor Documentation

◆ QScreenCapture()

◆ ~QScreenCapture()

Member Function Documentation

◆ activeChanged

◆ captureSession()

◆ error()

◆ errorChanged

◆ errorOccurred

◆ errorString()

◆ isActive()

◆ screen()

◆ screenChanged

◆ setActive

◆ setScreen()

◆ start

◆ stop

Friends And Related Symbol Documentation

◆ QMediaCaptureSession

Property Documentation

◆ active

◆ error

◆ errorString

◆ screen