API reference - Class QVideoSurfaceFormat

!=

Signature: [const] bool != (const QVideoSurfaceFormat format)

Description: Method bool QVideoSurfaceFormat::operator !=(const QVideoSurfaceFormat &format)

==

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

Description: Method bool QVideoSurfaceFormat::operator ==(const QVideoSurfaceFormat &format)

BottomToTop

Signature: [static,const] QVideoSurfaceFormat_Direction BottomToTop

Description: Enum constant QVideoSurfaceFormat::BottomToTop

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

TopToBottom

Signature: [static,const] QVideoSurfaceFormat_Direction TopToBottom

Description: Enum constant QVideoSurfaceFormat::TopToBottom

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

YCbCr_BT601

Signature: [static,const] QVideoSurfaceFormat_YCbCrColorSpace YCbCr_BT601

Description: Enum constant QVideoSurfaceFormat::YCbCr_BT601

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

YCbCr_BT709

Signature: [static,const] QVideoSurfaceFormat_YCbCrColorSpace YCbCr_BT709

Description: Enum constant QVideoSurfaceFormat::YCbCr_BT709

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

YCbCr_CustomMatrix

Signature: [static,const] QVideoSurfaceFormat_YCbCrColorSpace YCbCr_CustomMatrix

Description: Enum constant QVideoSurfaceFormat::YCbCr_CustomMatrix

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

YCbCr_JPEG

Signature: [static,const] QVideoSurfaceFormat_YCbCrColorSpace YCbCr_JPEG

Description: Enum constant QVideoSurfaceFormat::YCbCr_JPEG

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

YCbCr_Undefined

Signature: [static,const] QVideoSurfaceFormat_YCbCrColorSpace YCbCr_Undefined

Description: Enum constant QVideoSurfaceFormat::YCbCr_Undefined

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

YCbCr_xvYCC601

Signature: [static,const] QVideoSurfaceFormat_YCbCrColorSpace YCbCr_xvYCC601

Description: Enum constant QVideoSurfaceFormat::YCbCr_xvYCC601

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

YCbCr_xvYCC709

Signature: [static,const] QVideoSurfaceFormat_YCbCrColorSpace YCbCr_xvYCC709

Description: Enum constant QVideoSurfaceFormat::YCbCr_xvYCC709

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

_assign

Signature: void _assign (const QVideoSurfaceFormat other)

Description: Assigns another object to self

_const_cast

Signature: [const] QVideoSurfaceFormat 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.

assign

Signature: QVideoSurfaceFormat assign (const QVideoSurfaceFormat format)

Description: Method QVideoSurfaceFormat &QVideoSurfaceFormat::operator =(const QVideoSurfaceFormat &format)

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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.

dup

Signature: [const] new QVideoSurfaceFormat ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

frameHeight

Signature: [const] int frameHeight

Description: Method int QVideoSurfaceFormat::frameHeight()

frameRate

Signature: [const] double frameRate

Description: Method double QVideoSurfaceFormat::frameRate()

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

frameRate=

Signature: void frameRate= (double rate)

Description: Method void QVideoSurfaceFormat::setFrameRate(double rate)

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

frameSize

Signature: [const] QSize frameSize

Description: Method QSize QVideoSurfaceFormat::frameSize()

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

frameSize=

Signature: void frameSize= (const QSize size)

Description: Method void QVideoSurfaceFormat::setFrameSize(const QSize &size)

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

frameWidth

Signature: [const] int frameWidth

Description: Method int QVideoSurfaceFormat::frameWidth()

handleType

Signature: [const] QAbstractVideoBuffer_HandleType handleType

Description: Method QAbstractVideoBuffer::HandleType QVideoSurfaceFormat::handleType()

isMirrored?

Signature: [const] bool isMirrored?

Description: Method bool QVideoSurfaceFormat::isMirrored()

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

isValid?

Signature: [const] bool isValid?

Description: Method bool QVideoSurfaceFormat::isValid()

is_const_object?

Signature: [const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

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

mirrored

Signature: [const] bool mirrored

Description: Method bool QVideoSurfaceFormat::isMirrored()

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

mirrored=

Signature: void mirrored= (bool mirrored)

Description: Method void QVideoSurfaceFormat::setMirrored(bool mirrored)

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

new

(1) Signature: [static] new QVideoSurfaceFormat new

Description: Constructor QVideoSurfaceFormat::QVideoSurfaceFormat()

This method creates an object of class QVideoSurfaceFormat.

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

(2) Signature: [static] new QVideoSurfaceFormat new (const QSize size, const QVideoFrame_PixelFormat pixelFormat, const QAbstractVideoBuffer_HandleType handleType = QAbstractVideoBuffer::NoHandle)

Description: Constructor QVideoSurfaceFormat::QVideoSurfaceFormat(const QSize &size, QVideoFrame::PixelFormat pixelFormat, QAbstractVideoBuffer::HandleType handleType)

This method creates an object of class QVideoSurfaceFormat.

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

(3) Signature: [static] new QVideoSurfaceFormat new (const QVideoSurfaceFormat format)

Description: Constructor QVideoSurfaceFormat::QVideoSurfaceFormat(const QVideoSurfaceFormat &format)

This method creates an object of class QVideoSurfaceFormat.

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

pixelAspectRatio

Signature: [const] QSize pixelAspectRatio

Description: Method QSize QVideoSurfaceFormat::pixelAspectRatio()

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

pixelAspectRatio=

Signature: void pixelAspectRatio= (const QSize ratio)

Description: Method void QVideoSurfaceFormat::setPixelAspectRatio(const QSize &ratio)

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

pixelFormat

Signature: [const] QVideoFrame_PixelFormat pixelFormat

Description: Method QVideoFrame::PixelFormat QVideoSurfaceFormat::pixelFormat()

property

Signature: [const] variant property (string name)

Description: Method QVariant QVideoSurfaceFormat::property(const char *name)

propertyNames

Signature: [const] bytes[] propertyNames

Description: Method QList<QByteArray> QVideoSurfaceFormat::propertyNames()

scanLineDirection

Signature: [const] QVideoSurfaceFormat_Direction scanLineDirection

Description: Method QVideoSurfaceFormat::Direction QVideoSurfaceFormat::scanLineDirection()

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

scanLineDirection=

Signature: void scanLineDirection= (const QVideoSurfaceFormat_Direction direction)

Description: Method void QVideoSurfaceFormat::setScanLineDirection(QVideoSurfaceFormat::Direction direction)

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

setFrameRate

Signature: void setFrameRate (double rate)

Description: Method void QVideoSurfaceFormat::setFrameRate(double rate)

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

setFrameSize

(1) Signature: void setFrameSize (const QSize size)

Description: Method void QVideoSurfaceFormat::setFrameSize(const QSize &size)

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

(2) Signature: void setFrameSize (int width, int height)

Description: Method void QVideoSurfaceFormat::setFrameSize(int width, int height)

setMirrored

Signature: void setMirrored (bool mirrored)

Description: Method void QVideoSurfaceFormat::setMirrored(bool mirrored)

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

setPixelAspectRatio

(1) Signature: void setPixelAspectRatio (const QSize ratio)

Description: Method void QVideoSurfaceFormat::setPixelAspectRatio(const QSize &ratio)

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

(2) Signature: void setPixelAspectRatio (int width, int height)

Description: Method void QVideoSurfaceFormat::setPixelAspectRatio(int width, int height)

setProperty

Signature: void setProperty (string name, variant value)

Description: Method void QVideoSurfaceFormat::setProperty(const char *name, const QVariant &value)

setScanLineDirection

Signature: void setScanLineDirection (const QVideoSurfaceFormat_Direction direction)

Description: Method void QVideoSurfaceFormat::setScanLineDirection(QVideoSurfaceFormat::Direction direction)

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

setViewport

Signature: void setViewport (const QRect viewport)

Description: Method void QVideoSurfaceFormat::setViewport(const QRect &viewport)

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

setYCbCrColorSpace

Signature: void setYCbCrColorSpace (const QVideoSurfaceFormat_YCbCrColorSpace colorSpace)

Description: Method void QVideoSurfaceFormat::setYCbCrColorSpace(QVideoSurfaceFormat::YCbCrColorSpace colorSpace)

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

sizeHint

Signature: [const] QSize sizeHint

Description: Method QSize QVideoSurfaceFormat::sizeHint()

viewport

Signature: [const] QRect viewport

Description: Method QRect QVideoSurfaceFormat::viewport()

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

viewport=

Signature: void viewport= (const QRect viewport)

Description: Method void QVideoSurfaceFormat::setViewport(const QRect &viewport)

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

yCbCrColorSpace

Signature: [const] QVideoSurfaceFormat_YCbCrColorSpace yCbCrColorSpace

Description: Method QVideoSurfaceFormat::YCbCrColorSpace QVideoSurfaceFormat::yCbCrColorSpace()

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

yCbCrColorSpace=

Signature: void yCbCrColorSpace= (const QVideoSurfaceFormat_YCbCrColorSpace colorSpace)

Description: Method void QVideoSurfaceFormat::setYCbCrColorSpace(QVideoSurfaceFormat::YCbCrColorSpace colorSpace)

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