API reference - Class QAbstractVideoSurface

IncorrectFormatError

Signature: [static,const] QAbstractVideoSurface_Error IncorrectFormatError

Description: Enum constant QAbstractVideoSurface::IncorrectFormatError

Python specific notes:
The object exposes a readable attribute 'IncorrectFormatError'. This is the getter.

NoError

Signature: [static,const] QAbstractVideoSurface_Error NoError

Description: Enum constant QAbstractVideoSurface::NoError

Python specific notes:
The object exposes a readable attribute 'NoError'. This is the getter.

ResourceError

Signature: [static,const] QAbstractVideoSurface_Error ResourceError

Description: Enum constant QAbstractVideoSurface::ResourceError

Python specific notes:
The object exposes a readable attribute 'ResourceError'. This is the getter.

StoppedError

Signature: [static,const] QAbstractVideoSurface_Error StoppedError

Description: Enum constant QAbstractVideoSurface::StoppedError

Python specific notes:
The object exposes a readable attribute 'StoppedError'. This is the getter.

UnsupportedFormatError

Signature: [static,const] QAbstractVideoSurface_Error UnsupportedFormatError

Description: Enum constant QAbstractVideoSurface::UnsupportedFormatError

Python specific notes:
The object exposes a readable attribute 'UnsupportedFormatError'. This is the getter.

_const_cast

Signature: [const] QAbstractVideoSurface ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

activeChanged

Signature: [signal] void activeChanged (bool active)

Description: Signal declaration for QAbstractVideoSurface::activeChanged(bool active)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'activeChanged'. This is the getter.
The object exposes a writable attribute 'activeChanged'. This is the setter.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QAbstractVideoSurface::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QAbstractVideoSurface::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QAbstractVideoSurface::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QAbstractVideoSurface::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_activeChanged

Signature: void emit_activeChanged (bool active)

Description: Emitter for signal void QAbstractVideoSurface::activeChanged(bool active)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QAbstractVideoSurface::destroyed(QObject *)

Call this method to emit this signal.

emit_nativeResolutionChanged

Signature: void emit_nativeResolutionChanged (const QSize resolution)

Description: Emitter for signal void QAbstractVideoSurface::nativeResolutionChanged(const QSize &resolution)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QAbstractVideoSurface::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_supportedFormatsChanged

Signature: void emit_supportedFormatsChanged

Description: Emitter for signal void QAbstractVideoSurface::supportedFormatsChanged()

Call this method to emit this signal.

emit_surfaceFormatChanged

Signature: void emit_surfaceFormatChanged (const QVideoSurfaceFormat format)

Description: Emitter for signal void QAbstractVideoSurface::surfaceFormatChanged(const QVideoSurfaceFormat &format)

Call this method to emit this signal.

error

Signature: [const] QAbstractVideoSurface_Error error

Description: Method QAbstractVideoSurface::Error QAbstractVideoSurface::error()

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QAbstractVideoSurface::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QAbstractVideoSurface::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

isActive?

Signature: [const] bool isActive?

Description: Method bool QAbstractVideoSurface::isActive()

isFormatSupported

Signature: [const] bool isFormatSupported (const QVideoSurfaceFormat format)

Description: Virtual method bool QAbstractVideoSurface::isFormatSupported(const QVideoSurfaceFormat &format)

This method can be reimplemented in a derived class.

isFormatSupported?

Signature: [const] bool isFormatSupported? (const QVideoSurfaceFormat format)

Description: Method bool QAbstractVideoSurface::isFormatSupported(const QVideoSurfaceFormat &format)

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QAbstractVideoSurface::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

nativeResolution

Signature: [const] QSize nativeResolution

Description: Method QSize QAbstractVideoSurface::nativeResolution()

Python specific notes:
The object exposes a readable attribute 'nativeResolution'. This is the getter.

nativeResolutionChanged

Signature: [signal] void nativeResolutionChanged (const QSize resolution)

Description: Signal declaration for QAbstractVideoSurface::nativeResolutionChanged(const QSize &resolution)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'nativeResolutionChanged'. This is the getter.
The object exposes a writable attribute 'nativeResolutionChanged'. This is the setter.

nearestFormat

Signature: [const] QVideoSurfaceFormat nearestFormat (const QVideoSurfaceFormat format)

Description: Virtual method QVideoSurfaceFormat QAbstractVideoSurface::nearestFormat(const QVideoSurfaceFormat &format)

This method can be reimplemented in a derived class.

new

Signature: [static] new QAbstractVideoSurface new (QObject ptr parent = nullptr)

Description: Constructor QAbstractVideoSurface::QAbstractVideoSurface(QObject *parent)

This method creates an object of class QAbstractVideoSurface.

Python specific notes:
This method is the default initializer of the object.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QAbstractVideoSurface::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

present

Signature: bool present (const QVideoFrame frame)

Description: Virtual method bool QAbstractVideoSurface::present(const QVideoFrame &frame)

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QAbstractVideoSurface::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QAbstractVideoSurface::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QAbstractVideoSurface::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setError

Signature: void setError (const QAbstractVideoSurface_Error error)

Description: Method void QAbstractVideoSurface::setError(QAbstractVideoSurface::Error error)

This method is protected and can only be called from inside a derived class.

setNativeResolution

Signature: void setNativeResolution (const QSize resolution)

Description: Method void QAbstractVideoSurface::setNativeResolution(const QSize &resolution)

This method is protected and can only be called from inside a derived class.

start

Signature: bool start (const QVideoSurfaceFormat format)

Description: Virtual method bool QAbstractVideoSurface::start(const QVideoSurfaceFormat &format)

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

stop

Signature: void stop

Description: Virtual method void QAbstractVideoSurface::stop()

This method can be reimplemented in a derived class.

supportedFormatsChanged

Signature: [signal] void supportedFormatsChanged

Description: Signal declaration for QAbstractVideoSurface::supportedFormatsChanged()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'supportedFormatsChanged'. This is the getter.
The object exposes a writable attribute 'supportedFormatsChanged'. This is the setter.

supportedPixelFormats

Signature: [const] QVideoFrame_PixelFormat[] supportedPixelFormats (const QAbstractVideoBuffer_HandleType type)

Description: Virtual method QList<QVideoFrame::PixelFormat> QAbstractVideoSurface::supportedPixelFormats(QAbstractVideoBuffer::HandleType type)

This method can be reimplemented in a derived class.

surfaceFormat

Signature: [const] QVideoSurfaceFormat surfaceFormat

Description: Method QVideoSurfaceFormat QAbstractVideoSurface::surfaceFormat()

surfaceFormatChanged

Signature: [signal] void surfaceFormatChanged (const QVideoSurfaceFormat format)

Description: Signal declaration for QAbstractVideoSurface::surfaceFormatChanged(const QVideoSurfaceFormat &format)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'surfaceFormatChanged'. This is the getter.
The object exposes a writable attribute 'surfaceFormatChanged'. This is the setter.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QAbstractVideoSurface::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QAbstractVideoSurface::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QAbstractVideoSurface::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.