The QVideoSink class represents a generic sink for video data. More...

#include <qvideosink.h>

Inheritance diagram for QVideoSink:

Collaboration diagram for QVideoSink:

Signals
void	videoFrameChanged (const QVideoFrame &frame) QT6_ONLY(const)
	Signals when the video frame changes.

void	subtitleTextChanged (const QString &subtitleText) QT6_ONLY(const)

void	videoSizeChanged ()

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
	QVideoSink (QObject *parent=nullptr)
	Constructs a new QVideoSink object with parent.

	~QVideoSink ()
	Destroys the object.

QRhi *	rhi () const
	Returns the QRhi instance being used to create texture data in the video frames.

void	setRhi (QRhi *rhi)

QSize	videoSize () const

QString	subtitleText () const

void	setSubtitleText (const QString &subtitle)
	Sets the current subtitle text.

void	setVideoFrame (const QVideoFrame &frame)
	Sets the current video frame.

QVideoFrame	videoFrame () const
	Returns the current video frame.

QPlatformVideoSink *	platformVideoSink () 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
QString	subtitleText
	Returns the current subtitle text.

QSize	videoSize
	Returns the size of the video currently being played back.

Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QMediaPlayerPrivate

class	QMediaCaptureSessionPrivate

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

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

The QVideoSink class represents a generic sink for video data.

\inmodule QtMultimedia

The QVideoSink class can be used to retrieve video data on a frame by frame basis from Qt Multimedia.

QVideoSink will provide individual video frames to the application developer through the videoFrameChanged() signal.

The video frame can then be used to read out the data of those frames and handle them further. When using QPainter, the QVideoFrame can be drawing using the paint() method in QVideoSink.

QVideoFrame objects can consume a significant amount of memory or system resources and should thus not be held for longer than required by the application.

See also: QMediaPlayer, QMediaCaptureSession

Definition at line 21 of file qvideosink.h.

Constructor & Destructor Documentation

◆ QVideoSink()

QVideoSink::QVideoSink ( QObject * parent = nullptr )

Constructs a new QVideoSink object with parent.

Definition at line 82 of file qvideosink.cpp.

◆ ~QVideoSink()

QVideoSink::~QVideoSink ( )

Destroys the object.

Definition at line 92 of file qvideosink.cpp.

Member Function Documentation

◆ platformVideoSink()

QPlatformVideoSink * QVideoSink::platformVideoSink ( ) const

Definition at line 124 of file qvideosink.cpp.

◆ rhi()

QRhi * QVideoSink::rhi ( ) const

Returns the QRhi instance being used to create texture data in the video frames.

Definition at line 102 of file qvideosink.cpp.

◆ setRhi()

void QVideoSink::setRhi ( QRhi * rhi )

Sets the QRhi instance being used to create texture data in the video frames to rhi.

Definition at line 112 of file qvideosink.cpp.

◆ setSubtitleText()

void QVideoSink::setSubtitleText ( const QString & subtitle )

Sets the current subtitle text.

Definition at line 164 of file qvideosink.cpp.

◆ setVideoFrame()

void QVideoSink::setVideoFrame ( const QVideoFrame & frame )

Sets the current video frame.

Definition at line 145 of file qvideosink.cpp.

◆ subtitleText()

QString QVideoSink::subtitleText ( ) const

Definition at line 156 of file qvideosink.cpp.

◆ subtitleTextChanged

void QVideoSink::subtitleTextChanged ( const QString & subtitleText ) const

signal

◆ videoFrame()

QVideoFrame QVideoSink::videoFrame ( ) const

Returns the current video frame.

Definition at line 132 of file qvideosink.cpp.

◆ videoFrameChanged

void QVideoSink::videoFrameChanged ( const QVideoFrame & frame ) const

signal

Signals when the video frame changes.

◆ videoSize()

QSize QVideoSink::videoSize ( ) const

Definition at line 176 of file qvideosink.cpp.

◆ videoSizeChanged

void QVideoSink::videoSizeChanged ( )

signal

Friends And Related Symbol Documentation

◆ QMediaCaptureSessionPrivate

friend class QMediaCaptureSessionPrivate

friend

Definition at line 49 of file qvideosink.h.

◆ QMediaPlayerPrivate

friend class QMediaPlayerPrivate

friend

Definition at line 48 of file qvideosink.h.

Property Documentation

◆ subtitleText

QString QVideoSink::subtitleText

readwrite

Returns the current subtitle text.

Definition at line 24 of file qvideosink.h.

◆ videoSize

QSize QVideoSink::videoSize

read

Returns the size of the video currently being played back.

If no video is being played, this method returns an invalid size.

Definition at line 25 of file qvideosink.h.

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

qtmultimedia/src/multimedia/video/qvideosink.h (d04d08a22b0c1a46dc80c0779fe11f3964f0bb99)
qtmultimedia/src/multimedia/video/qvideosink.cpp (3e781ec9b9d46ca444ef711d0a4ffecbd6c3b225)

Signals

Public Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QVideoSink()

◆ ~QVideoSink()

Member Function Documentation

◆ platformVideoSink()

◆ rhi()

◆ setRhi()

◆ setSubtitleText()

◆ setVideoFrame()

◆ subtitleText()

◆ subtitleTextChanged

◆ videoFrame()

◆ videoFrameChanged

◆ videoSize()

◆ videoSizeChanged

Friends And Related Symbol Documentation

◆ QMediaCaptureSessionPrivate

◆ QMediaPlayerPrivate

Property Documentation

◆ subtitleText

◆ videoSize