Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QFFmpeg::QMacScreenCaptureKit Class Reference

#include <qmacscreencapturekit_p.h>

Inheritance diagram for QFFmpeg::QMacScreenCaptureKit:
Collaboration diagram for QFFmpeg::QMacScreenCaptureKit:

Classes

struct  CapturableItems

Signals

void newVideoFrameGenerated (int64_t streamId, QVideoFrame)
void streamStoppedWithError (int64_t streamId, QString)
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

 QMacScreenCaptureKit ()=default
 ~QMacScreenCaptureKit ()
 QMacScreenCaptureKit (const QMacScreenCaptureKit &)=delete
QMacScreenCaptureKitoperator= (const QMacScreenCaptureKit &)=delete
 QMacScreenCaptureKit (QMacScreenCaptureKit &&other) noexcept=delete
QMacScreenCaptureKitoperator= (QMacScreenCaptureKit &&other)=delete
int64_t streamId () const noexcept
void updateStream (QSize resolutionPx)
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 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).
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.

Static Public Member Functions

static CFStringRef cgColorSpace ()
static AVFScopedPointer< SCStreamConfiguration > createStreamConfig (QSize resolutionPx, std::optional< qreal > frameRate)
static std::future< q23::expected< CapturableItems, QString > > enumerateCapturableItems ()
static std::future< q23::expected< std::unique_ptr< QMacScreenCaptureKit >, QString > > createStreamFromFilter (int64_t streamId, SCContentFilter *, QSize resolutionPx, std::optional< qreal > frameRate)
static std::future< q23::expected< std::unique_ptr< QMacScreenCaptureKit >, QString > > createStream (int64_t streamId, SCWindow *, std::optional< qreal > frameRate)
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)

Static Public Attributes

static constexpr FourCharCode cvPixelFormat = kCVPixelFormatType_32BGRA
static constexpr QVideoFrameFormat::PixelFormat pixelFormat
static constexpr int queueDepth = 3
static constexpr QVideoFrameFormat::ColorSpace colorSpace
static constexpr QVideoFrameFormat::ColorRange colorRange
static constexpr QVideoFrameFormat::ColorTransfer colorTransfer

Additional Inherited Members

Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
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)
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

Definition at line 55 of file qmacscreencapturekit_p.h.

Constructor & Destructor Documentation

◆ QMacScreenCaptureKit() [1/3]

QFFmpeg::QMacScreenCaptureKit::QMacScreenCaptureKit ( )
default

◆ ~QMacScreenCaptureKit()

QFFmpeg::QMacScreenCaptureKit::~QMacScreenCaptureKit ( )

Definition at line 316 of file qmacscreencapturekit.mm.

◆ QMacScreenCaptureKit() [2/3]

QFFmpeg::QMacScreenCaptureKit::QMacScreenCaptureKit ( const QMacScreenCaptureKit & )
delete

◆ QMacScreenCaptureKit() [3/3]

QFFmpeg::QMacScreenCaptureKit::QMacScreenCaptureKit ( QMacScreenCaptureKit && other)
deletenoexcept

Member Function Documentation

◆ cgColorSpace()

CFStringRef QFFmpeg::QMacScreenCaptureKit::cgColorSpace ( )
inlinestaticnodiscard

Definition at line 68 of file qmacscreencapturekit_p.h.

◆ createStream()

std::future< q23::expected< std::unique_ptr< QMacScreenCaptureKit >, QString > > QFFmpeg::QMacScreenCaptureKit::createStream ( int64_t streamId,
SCWindow * scWindow,
std::optional< qreal > frameRate )
staticnodiscard

Definition at line 462 of file qmacscreencapturekit.mm.

◆ createStreamConfig()

AVFScopedPointer< SCStreamConfiguration > QFFmpeg::QMacScreenCaptureKit::createStreamConfig ( QSize resolutionPx,
std::optional< qreal > frameRate )
staticnodiscard

Definition at line 485 of file qmacscreencapturekit.mm.

References queueDepth.

◆ createStreamFromFilter()

std::future< q23::expected< std::unique_ptr< QMacScreenCaptureKit >, QString > > QFFmpeg::QMacScreenCaptureKit::createStreamFromFilter ( int64_t streamId,
SCContentFilter * scContentFilter,
QSize resolutionPx,
std::optional< qreal > frameRate )
staticnodiscard

Definition at line 382 of file qmacscreencapturekit.mm.

◆ enumerateCapturableItems()

std::future< q23::expected< QMacScreenCaptureKit::CapturableItems, QString > > QFFmpeg::QMacScreenCaptureKit::enumerateCapturableItems ( )
staticnodiscard

Definition at line 347 of file qmacscreencapturekit.mm.

◆ newVideoFrameGenerated

void QFFmpeg::QMacScreenCaptureKit::newVideoFrameGenerated ( int64_t streamId,
QVideoFrame  )
signal

◆ operator=() [1/2]

QMacScreenCaptureKit & QFFmpeg::QMacScreenCaptureKit::operator= ( const QMacScreenCaptureKit & )
delete

◆ operator=() [2/2]

QMacScreenCaptureKit & QFFmpeg::QMacScreenCaptureKit::operator= ( QMacScreenCaptureKit && other)
delete

◆ streamId()

int64_t QFFmpeg::QMacScreenCaptureKit::streamId ( ) const
inlinenodiscardnoexcept

Definition at line 88 of file qmacscreencapturekit_p.h.

◆ streamStoppedWithError

void QFFmpeg::QMacScreenCaptureKit::streamStoppedWithError ( int64_t streamId,
QString  )
signal

◆ updateStream()

void QFFmpeg::QMacScreenCaptureKit::updateStream ( QSize resolutionPx)

Definition at line 548 of file qmacscreencapturekit.mm.

Member Data Documentation

◆ colorRange

QVideoFrameFormat::ColorRange QFFmpeg::QMacScreenCaptureKit::colorRange
staticconstexpr

◆ colorSpace

QVideoFrameFormat::ColorSpace QFFmpeg::QMacScreenCaptureKit::colorSpace
staticconstexpr

◆ colorTransfer

QVideoFrameFormat::ColorTransfer QFFmpeg::QMacScreenCaptureKit::colorTransfer
staticconstexpr

◆ cvPixelFormat

FourCharCode QFFmpeg::QMacScreenCaptureKit::cvPixelFormat = kCVPixelFormatType_32BGRA
staticconstexpr

Definition at line 61 of file qmacscreencapturekit_p.h.

◆ pixelFormat

QVideoFrameFormat::PixelFormat QFFmpeg::QMacScreenCaptureKit::pixelFormat
staticconstexpr

◆ queueDepth

int QFFmpeg::QMacScreenCaptureKit::queueDepth = 3
staticconstexpr

Definition at line 67 of file qmacscreencapturekit_p.h.

Referenced by createStreamConfig().


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