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>.
Loading...
Searching...
No Matches
QPlatformSurfaceCapture Class Referenceabstract

#include <qplatformsurfacecapture_p.h>

+ Inheritance diagram for QPlatformSurfaceCapture:
+ Collaboration diagram for QPlatformSurfaceCapture:

Public Types

enum  Error {
  NoError = 0 , InternalError = 1 , CapturingNotSupported = 2 , CaptureFailed = 4 ,
  NotFound = 5
}
 
using ScreenSource = QPointer<QScreen>
 
using WindowSource = QCapturableWindow
 
using Source = std::variant<ScreenSource, WindowSource>
 

Public Slots

void updateError (Error error, const QString &errorString)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void sourceChanged (WindowSource)
 
void sourceChanged (ScreenSource)
 
void errorChanged ()
 
void errorOccurred (Error error, QString errorString)
 
- Signals inherited from QPlatformVideoSource
void newVideoFrame (const QVideoFrame &)
 
void activeChanged (bool)
 
- 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

 QPlatformSurfaceCapture (Source initialSource)
 
void setActive (bool active) override
 
bool isActive () const override
 
void setSource (Source source)
 
template<typename Type >
Type source () const
 
Source source () const
 
Error error () const
 
QString errorString () const
 
- Public Member Functions inherited from QPlatformVideoSource
virtual QVideoFrameFormat frameFormat () const =0
 
virtual std::optional< int > ffmpegHWPixelFormat () const
 
virtual void setCaptureSession (QPlatformMediaCaptureSession *)
 
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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.
 

Protected Member Functions

virtual bool setActiveInternal (bool)=0
 
bool checkScreenWithError (ScreenSource &screen)
 
- Protected Member Functions inherited from QObject
QObjectsender () 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)
 

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 Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 31 of file qplatformsurfacecapture_p.h.

Member Typedef Documentation

◆ ScreenSource

◆ Source

Definition at line 47 of file qplatformsurfacecapture_p.h.

◆ WindowSource

Member Enumeration Documentation

◆ Error

Enumerator
NoError 
InternalError 
CapturingNotSupported 
CaptureFailed 
NotFound 

Definition at line 36 of file qplatformsurfacecapture_p.h.

Constructor & Destructor Documentation

◆ QPlatformSurfaceCapture()

QT_BEGIN_NAMESPACE QPlatformSurfaceCapture::QPlatformSurfaceCapture ( Source initialSource)
explicit

Definition at line 11 of file qplatformsurfacecapture.cpp.

References Q_ASSERT, and source().

+ Here is the call graph for this function:

Member Function Documentation

◆ checkScreenWithError()

bool QPlatformSurfaceCapture::checkScreenWithError ( ScreenSource & screen)
protected

Definition at line 69 of file qplatformsurfacecapture.cpp.

References NotFound, QGuiApplication::primaryScreen, screen, and updateError().

Referenced by QAVFScreenCapture::setActiveInternal(), and QFFmpegScreenCaptureDxgi::setActiveInternal().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ error()

QPlatformSurfaceCapture::Error QPlatformSurfaceCapture::error ( ) const

Definition at line 54 of file qplatformsurfacecapture.cpp.

References QErrorInfo< ErrorCode, NoError >::code().

Referenced by QFFmpegWindowCaptureUwp::setActiveInternal(), and updateError().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ errorChanged

void QPlatformSurfaceCapture::errorChanged ( )
signal

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

+ Here is the caller graph for this function:

◆ errorOccurred

void QPlatformSurfaceCapture::errorOccurred ( Error error,
QString errorString )
signal

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

+ Here is the caller graph for this function:

◆ errorString()

QString QPlatformSurfaceCapture::errorString ( ) const

Definition at line 59 of file qplatformsurfacecapture.cpp.

References QErrorInfo< ErrorCode, NoError >::description().

Referenced by updateError().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isActive()

bool QPlatformSurfaceCapture::isActive ( ) const
overridevirtual

Implements QPlatformVideoSource.

Definition at line 29 of file qplatformsurfacecapture.cpp.

◆ setActive()

void QPlatformSurfaceCapture::setActive ( bool active)
overridevirtual

Implements QPlatformVideoSource.

Definition at line 17 of file qplatformsurfacecapture.cpp.

References QPlatformVideoSource::activeChanged(), emit, and setActiveInternal().

+ Here is the call graph for this function:

◆ setActiveInternal()

virtual bool QPlatformSurfaceCapture::setActiveInternal ( bool )
protectedpure virtual

Implemented in QAVFScreenCapture, QCGWindowCapture, QEglfsScreenCapture, QFFmpegScreenCaptureDxgi, QFFmpegWindowCaptureUwp, QGdiWindowCapture, QGrabWindowSurfaceCapture, and QX11SurfaceCapture.

Referenced by setActive(), and setSource().

+ Here is the caller graph for this function:

◆ setSource()

void QPlatformSurfaceCapture::setSource ( Source source)

Definition at line 34 of file qplatformsurfacecapture.cpp.

References QPlatformVideoSource::activeChanged(), emit, Q_ASSERT, setActiveInternal(), source(), and sourceChanged().

+ Here is the call graph for this function:

◆ source() [1/2]

template<typename Type >
Type QPlatformSurfaceCapture::source ( ) const
inline

Definition at line 57 of file qplatformsurfacecapture_p.h.

Referenced by QPlatformSurfaceCapture(), QGrabWindowSurfaceCapture::setActiveInternal(), QX11SurfaceCapture::setActiveInternal(), and setSource().

+ Here is the caller graph for this function:

◆ source() [2/2]

Source QPlatformSurfaceCapture::source ( ) const
inline

Definition at line 61 of file qplatformsurfacecapture_p.h.

◆ sourceChanged [1/2]

void QPlatformSurfaceCapture::sourceChanged ( ScreenSource )
signal

◆ sourceChanged [2/2]

void QPlatformSurfaceCapture::sourceChanged ( WindowSource )
signal

Referenced by QScreenCapture::QScreenCapture(), QWindowCapture::QWindowCapture(), and setSource().

+ Here is the caller graph for this function:

◆ updateError

void QPlatformSurfaceCapture::updateError ( Error error,
const QString & errorString )
slot

Definition at line 64 of file qplatformsurfacecapture.cpp.

References error(), errorString(), and QErrorInfo< ErrorCode, NoError >::setAndNotify().

Referenced by QCGWindowCapture::Grabber::Grabber(), QEglfsScreenCapture::Grabber::Grabber(), QFFmpegScreenCaptureDxgi::Grabber::Grabber(), QFFmpegWindowCaptureUwp::Grabber::Grabber(), checkScreenWithError(), QGdiWindowCapture::Grabber::create(), QAVFScreenCapture::setActiveInternal(), QCGWindowCapture::setActiveInternal(), QFFmpegScreenCaptureDxgi::setActiveInternal(), and QFFmpegWindowCaptureUwp::setActiveInternal().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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