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
Signals | Public Member Functions | Friends | List of all members
QVideoFrameInput Class Reference

\inmodule QtMultimedia More...

#include <qvideoframeinput.h>

+ Inheritance diagram for QVideoFrameInput:
+ Collaboration diagram for QVideoFrameInput:

Signals

void readyToSendVideoFrame ()
 Signals that a new frame can be sent to the video frame input.
 
- 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

 QVideoFrameInput (QObject *parent=nullptr)
 Constructs a new QVideoFrameInput object with parent.
 
 QVideoFrameInput (const QVideoFrameFormat &format, QObject *parent=nullptr)
 Constructs a new QVideoFrameInput object with video frame format and parent.
 
 ~QVideoFrameInput () override
 Destroys the object.
 
bool sendVideoFrame (const QVideoFrame &frame)
 Sends \l QVideoFrame to \l QMediaRecorder or a video output through \l QMediaCaptureSession.
 
QVideoFrameFormat format () const
 Returns the video frame format that was specified upon construction of the video frame input.
 
QMediaCaptureSession * captureSession () const
 Returns the capture session this video frame input is connected to, or a nullptr if the video frame input is not connected to a capture session.
 
- 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.
 

Friends

class QMediaCaptureSession
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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
 
- Properties inherited from QObject
QString objectName
 the name of this object
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

\inmodule QtMultimedia

Since
6.8

The QVideoFrameInput class is used for providing custom video frames to \l QMediaRecorder or a video output through \l QMediaCaptureSession.

See also
QMediaRecorder, QMediaCaptureSession, QVideoSink

Definition at line 17 of file qvideoframeinput.h.

Constructor & Destructor Documentation

◆ QVideoFrameInput() [1/2]

QVideoFrameInput::QVideoFrameInput ( QObject * parent = nullptr)
explicit

Constructs a new QVideoFrameInput object with parent.

Definition at line 82 of file qvideoframeinput.cpp.

◆ QVideoFrameInput() [2/2]

QVideoFrameInput::QVideoFrameInput ( const QVideoFrameFormat & format,
QObject * parent = nullptr )
explicit

Constructs a new QVideoFrameInput object with video frame format and parent.

The specified format will work as a hint for the initialization of the matching video encoder upon invoking \l QMediaRecorder::record(). If the format is not specified or not valid, the video encoder will be initialized upon sending the first frame. Sending of video frames with another pixel format and size after initialization of the matching video encoder might cause a performance penalty during recording.

We recommend specifying the format if you know in advance what kind of frames you're going to send.

Definition at line 97 of file qvideoframeinput.cpp.

References d.

◆ ~QVideoFrameInput()

QVideoFrameInput::~QVideoFrameInput ( )
override

Destroys the object.

Definition at line 107 of file qvideoframeinput.cpp.

References d.

Member Function Documentation

◆ captureSession()

QMediaCaptureSession * QVideoFrameInput::captureSession ( ) const

Returns the capture session this video frame input is connected to, or a nullptr if the video frame input is not connected to a capture session.

Use QMediaCaptureSession::setVideoFrameInput() to connect the video frame input to a session.

Definition at line 153 of file qvideoframeinput.cpp.

References d.

Referenced by QMediaCaptureSession::setVideoFrameInput().

+ Here is the caller graph for this function:

◆ format()

QVideoFrameFormat QVideoFrameInput::format ( ) const

Returns the video frame format that was specified upon construction of the video frame input.

Definition at line 140 of file qvideoframeinput.cpp.

References d.

◆ readyToSendVideoFrame

void QVideoFrameInput::readyToSendVideoFrame ( )
signal

Signals that a new frame can be sent to the video frame input.

After receiving the signal, if you have frames to be sent, invoke \l sendVideoFrame once or in a loop until it returns false.

See also
sendVideoFrame()

◆ sendVideoFrame()

bool QVideoFrameInput::sendVideoFrame ( const QVideoFrame & frame)

Sends \l QVideoFrame to \l QMediaRecorder or a video output through \l QMediaCaptureSession.

Returns true if the specified frame has been sent successfully to the destination. Returns false, if the frame hasn't been sent, which can happen if the instance is not assigned to \l QMediaCaptureSession, the session doesn't have video outputs or a media recorder, the media recorder is not started or its queue is full. The signal \l readyToSendVideoFrame will be sent as soon as the destination is able to handle a new frame.

Sending of an empty video frame is treated by \l QMediaRecorder as an end of the input stream. QMediaRecorder stops the recording automatically if \l QMediaRecorder::autoStop is true and all the inputs have reported the end of the stream.

Definition at line 130 of file qvideoframeinput.cpp.

References d, and frame.

Friends And Related Symbol Documentation

◆ QMediaCaptureSession

friend class QMediaCaptureSession
friend

Definition at line 41 of file qvideoframeinput.h.

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