Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
\inmodule QtMultimedia More...
#include <qscreencapture.h>
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) | |
\inmodule QtMultimedia
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}
Definition at line 20 of file qscreencapture.h.
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.
\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().
|
override |
Definition at line 103 of file qscreencapture.cpp.
References d.
|
signal |
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().
QScreenCapture::Error QScreenCapture::error | ( | ) | const |
Definition at line 200 of file qscreencapture.cpp.
References CapturingNotSupported, d, and toScreenCaptureError().
|
signal |
|
signal |
Signals when an error occurs, along with the errorString.
Referenced by QScreenCapture().
QString QScreenCapture::errorString | ( | ) | const |
Definition at line 222 of file qscreencapture.cpp.
References d.
bool QScreenCapture::isActive | ( | ) | const |
Definition at line 157 of file qscreencapture.cpp.
References d.
QScreen * QScreenCapture::screen | ( | ) | const |
Definition at line 182 of file qscreencapture.cpp.
References d.
Referenced by QQuickScreenCatpure::QQuickScreenCatpure(), and QScreenCapture().
|
slot |
Definition at line 149 of file qscreencapture.cpp.
Definition at line 174 of file qscreencapture.cpp.
Referenced by QQuickScreenCatpure::qmlSetScreen().
|
inlineslot |
Starts screen capture.
Definition at line 53 of file qscreencapture.h.
|
inlineslot |
Stops screen capture.
Definition at line 54 of file qscreencapture.h.
|
friend |
Definition at line 65 of file qscreencapture.h.
|
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().
|
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().
|
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().
|
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().