API reference - Class QVideoFrame

!=

Signature: [const] bool != (const QVideoFrame other)

Description: Method bool QVideoFrame::operator!=(const QVideoFrame &other)

==

Signature: [const] bool == (const QVideoFrame other)

Description: Method bool QVideoFrame::operator==(const QVideoFrame &other)

BottomField

Signature: [static,const] QVideoFrame_FieldType BottomField

Description: Enum constant QVideoFrame::BottomField

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

Format_ARGB32

Signature: [static,const] QVideoFrame_PixelFormat Format_ARGB32

Description: Enum constant QVideoFrame::Format_ARGB32

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

Format_ARGB32_Premultiplied

Signature: [static,const] QVideoFrame_PixelFormat Format_ARGB32_Premultiplied

Description: Enum constant QVideoFrame::Format_ARGB32_Premultiplied

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

Format_ARGB8565_Premultiplied

Signature: [static,const] QVideoFrame_PixelFormat Format_ARGB8565_Premultiplied

Description: Enum constant QVideoFrame::Format_ARGB8565_Premultiplied

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

Format_AYUV444

Signature: [static,const] QVideoFrame_PixelFormat Format_AYUV444

Description: Enum constant QVideoFrame::Format_AYUV444

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

Format_AYUV444_Premultiplied

Signature: [static,const] QVideoFrame_PixelFormat Format_AYUV444_Premultiplied

Description: Enum constant QVideoFrame::Format_AYUV444_Premultiplied

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

Format_AdobeDng

Signature: [static,const] QVideoFrame_PixelFormat Format_AdobeDng

Description: Enum constant QVideoFrame::Format_AdobeDng

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

Format_BGR24

Signature: [static,const] QVideoFrame_PixelFormat Format_BGR24

Description: Enum constant QVideoFrame::Format_BGR24

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

Format_BGR32

Signature: [static,const] QVideoFrame_PixelFormat Format_BGR32

Description: Enum constant QVideoFrame::Format_BGR32

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

Format_BGR555

Signature: [static,const] QVideoFrame_PixelFormat Format_BGR555

Description: Enum constant QVideoFrame::Format_BGR555

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

Format_BGR565

Signature: [static,const] QVideoFrame_PixelFormat Format_BGR565

Description: Enum constant QVideoFrame::Format_BGR565

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

Format_BGRA32

Signature: [static,const] QVideoFrame_PixelFormat Format_BGRA32

Description: Enum constant QVideoFrame::Format_BGRA32

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

Format_BGRA32_Premultiplied

Signature: [static,const] QVideoFrame_PixelFormat Format_BGRA32_Premultiplied

Description: Enum constant QVideoFrame::Format_BGRA32_Premultiplied

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

Format_BGRA5658_Premultiplied

Signature: [static,const] QVideoFrame_PixelFormat Format_BGRA5658_Premultiplied

Description: Enum constant QVideoFrame::Format_BGRA5658_Premultiplied

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

Format_CameraRaw

Signature: [static,const] QVideoFrame_PixelFormat Format_CameraRaw

Description: Enum constant QVideoFrame::Format_CameraRaw

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

Format_IMC1

Signature: [static,const] QVideoFrame_PixelFormat Format_IMC1

Description: Enum constant QVideoFrame::Format_IMC1

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

Format_IMC2

Signature: [static,const] QVideoFrame_PixelFormat Format_IMC2

Description: Enum constant QVideoFrame::Format_IMC2

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

Format_IMC3

Signature: [static,const] QVideoFrame_PixelFormat Format_IMC3

Description: Enum constant QVideoFrame::Format_IMC3

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

Format_IMC4

Signature: [static,const] QVideoFrame_PixelFormat Format_IMC4

Description: Enum constant QVideoFrame::Format_IMC4

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

Format_Invalid

Signature: [static,const] QVideoFrame_PixelFormat Format_Invalid

Description: Enum constant QVideoFrame::Format_Invalid

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

Format_Jpeg

Signature: [static,const] QVideoFrame_PixelFormat Format_Jpeg

Description: Enum constant QVideoFrame::Format_Jpeg

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

Format_NV12

Signature: [static,const] QVideoFrame_PixelFormat Format_NV12

Description: Enum constant QVideoFrame::Format_NV12

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

Format_NV21

Signature: [static,const] QVideoFrame_PixelFormat Format_NV21

Description: Enum constant QVideoFrame::Format_NV21

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

Format_RGB24

Signature: [static,const] QVideoFrame_PixelFormat Format_RGB24

Description: Enum constant QVideoFrame::Format_RGB24

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

Format_RGB32

Signature: [static,const] QVideoFrame_PixelFormat Format_RGB32

Description: Enum constant QVideoFrame::Format_RGB32

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

Format_RGB555

Signature: [static,const] QVideoFrame_PixelFormat Format_RGB555

Description: Enum constant QVideoFrame::Format_RGB555

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

Format_RGB565

Signature: [static,const] QVideoFrame_PixelFormat Format_RGB565

Description: Enum constant QVideoFrame::Format_RGB565

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

Format_UYVY

Signature: [static,const] QVideoFrame_PixelFormat Format_UYVY

Description: Enum constant QVideoFrame::Format_UYVY

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

Format_User

Signature: [static,const] QVideoFrame_PixelFormat Format_User

Description: Enum constant QVideoFrame::Format_User

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

Format_Y16

Signature: [static,const] QVideoFrame_PixelFormat Format_Y16

Description: Enum constant QVideoFrame::Format_Y16

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

Format_Y8

Signature: [static,const] QVideoFrame_PixelFormat Format_Y8

Description: Enum constant QVideoFrame::Format_Y8

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

Format_YUV420P

Signature: [static,const] QVideoFrame_PixelFormat Format_YUV420P

Description: Enum constant QVideoFrame::Format_YUV420P

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

Format_YUV444

Signature: [static,const] QVideoFrame_PixelFormat Format_YUV444

Description: Enum constant QVideoFrame::Format_YUV444

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

Format_YUYV

Signature: [static,const] QVideoFrame_PixelFormat Format_YUYV

Description: Enum constant QVideoFrame::Format_YUYV

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

Format_YV12

Signature: [static,const] QVideoFrame_PixelFormat Format_YV12

Description: Enum constant QVideoFrame::Format_YV12

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

InterlacedFrame

Signature: [static,const] QVideoFrame_FieldType InterlacedFrame

Description: Enum constant QVideoFrame::InterlacedFrame

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

NPixelFormats

Signature: [static,const] QVideoFrame_PixelFormat NPixelFormats

Description: Enum constant QVideoFrame::NPixelFormats

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

ProgressiveFrame

Signature: [static,const] QVideoFrame_FieldType ProgressiveFrame

Description: Enum constant QVideoFrame::ProgressiveFrame

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

TopField

Signature: [static,const] QVideoFrame_FieldType TopField

Description: Enum constant QVideoFrame::TopField

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

_assign

Signature: void _assign (const QVideoFrame other)

Description: Assigns another object to self

_const_cast

Signature: [const] QVideoFrame 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: QVideoFrame assign (const QVideoFrame other)

Description: Method QVideoFrame &QVideoFrame::operator =(const QVideoFrame &other)

availableMetaData

Signature: [const] map<string,variant> availableMetaData

Description: Method QMap<QString, QVariant> QVideoFrame::availableMetaData()

bits

(1) Signature: [const] string bits

Description: Method const unsigned char *QVideoFrame::bits()

(2) Signature: [const] string bits (int plane)

Description: Method const unsigned char *QVideoFrame::bits(int plane)

bytesPerLine

(1) Signature: [const] int bytesPerLine

Description: Method int QVideoFrame::bytesPerLine()

(2) Signature: [const] int bytesPerLine (int plane)

Description: Method int QVideoFrame::bytesPerLine(int plane)

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 QVideoFrame ptr dup

Description: Creates a copy of self

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

endTime

Signature: [const] long long endTime

Description: Method qint64 QVideoFrame::endTime()

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

endTime=

Signature: void endTime= (long long time)

Description: Method void QVideoFrame::setEndTime(qint64 time)

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

fieldType

Signature: [const] QVideoFrame_FieldType fieldType

Description: Method QVideoFrame::FieldType QVideoFrame::fieldType()

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

fieldType=

Signature: void fieldType= (const QVideoFrame_FieldType arg1)

Description: Method void QVideoFrame::setFieldType(QVideoFrame::FieldType)

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

handle

Signature: [const] variant handle

Description: Method QVariant QVideoFrame::handle()

handleType

Signature: [const] QAbstractVideoBuffer_HandleType handleType

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

height

Signature: [const] int height

Description: Method int QVideoFrame::height()

imageFormatFromPixelFormat

Signature: [static] QImage_Format imageFormatFromPixelFormat (const QVideoFrame_PixelFormat format)

Description: Static method QImage::Format QVideoFrame::imageFormatFromPixelFormat(QVideoFrame::PixelFormat format)

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

isMapped?

Signature: [const] bool isMapped?

Description: Method bool QVideoFrame::isMapped()

isReadable?

Signature: [const] bool isReadable?

Description: Method bool QVideoFrame::isReadable()

isValid?

Signature: [const] bool isValid?

Description: Method bool QVideoFrame::isValid()

isWritable?

Signature: [const] bool isWritable?

Description: Method bool QVideoFrame::isWritable()

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.

map

Signature: bool map (const QAbstractVideoBuffer_MapMode mode)

Description: Method bool QVideoFrame::map(QAbstractVideoBuffer::MapMode mode)

mapMode

Signature: [const] QAbstractVideoBuffer_MapMode mapMode

Description: Method QAbstractVideoBuffer::MapMode QVideoFrame::mapMode()

mappedBytes

Signature: [const] int mappedBytes

Description: Method int QVideoFrame::mappedBytes()

metaData

Signature: [const] variant metaData (string key)

Description: Method QVariant QVideoFrame::metaData(const QString &key)

new

(1) Signature: [static] new QVideoFrame new

Description: Constructor QVideoFrame::QVideoFrame()

This method creates an object of class QVideoFrame.

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

(2) Signature: [static] new QVideoFrame new (QAbstractVideoBuffer ptr buffer, const QSize size, const QVideoFrame_PixelFormat format)

Description: Constructor QVideoFrame::QVideoFrame(QAbstractVideoBuffer *buffer, const QSize &size, QVideoFrame::PixelFormat format)

This method creates an object of class QVideoFrame.

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

(3) Signature: [static] new QVideoFrame new (int bytes, const QSize size, int bytesPerLine, const QVideoFrame_PixelFormat format)

Description: Constructor QVideoFrame::QVideoFrame(int bytes, const QSize &size, int bytesPerLine, QVideoFrame::PixelFormat format)

This method creates an object of class QVideoFrame.

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

(4) Signature: [static] new QVideoFrame new (const QImage image)

Description: Constructor QVideoFrame::QVideoFrame(const QImage &image)

This method creates an object of class QVideoFrame.

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

(5) Signature: [static] new QVideoFrame new (const QVideoFrame other)

Description: Constructor QVideoFrame::QVideoFrame(const QVideoFrame &other)

This method creates an object of class QVideoFrame.

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

pixelFormat

Signature: [const] QVideoFrame_PixelFormat pixelFormat

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

pixelFormatFromImageFormat

Signature: [static] QVideoFrame_PixelFormat pixelFormatFromImageFormat (const QImage_Format format)

Description: Static method QVideoFrame::PixelFormat QVideoFrame::pixelFormatFromImageFormat(QImage::Format format)

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

planeCount

Signature: [const] int planeCount

Description: Method int QVideoFrame::planeCount()

setEndTime

Signature: void setEndTime (long long time)

Description: Method void QVideoFrame::setEndTime(qint64 time)

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

setFieldType

Signature: void setFieldType (const QVideoFrame_FieldType arg1)

Description: Method void QVideoFrame::setFieldType(QVideoFrame::FieldType)

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

setMetaData

Signature: void setMetaData (string key, variant value)

Description: Method void QVideoFrame::setMetaData(const QString &key, const QVariant &value)

setStartTime

Signature: void setStartTime (long long time)

Description: Method void QVideoFrame::setStartTime(qint64 time)

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

size

Signature: [const] QSize size

Description: Method QSize QVideoFrame::size()

Python specific notes:
This method is also available as 'len(object)'.

startTime

Signature: [const] long long startTime

Description: Method qint64 QVideoFrame::startTime()

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

startTime=

Signature: void startTime= (long long time)

Description: Method void QVideoFrame::setStartTime(qint64 time)

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

unmap

Signature: void unmap

Description: Method void QVideoFrame::unmap()

width

Signature: [const] int width

Description: Method int QVideoFrame::width()