API Reference#

QtVideo.

Functions#

qtvideo.converters.ndarray_to_qimage(np_frame, *, with_ctypes=True)[source]#

_summary_.

Parameters

np_frame (ndarray[Any, dtype[uint8]]) – _description_
with_ctypes (bool) – _description_. Defaults to True.

Raises

RuntimeError – _description_

Return type

QImage

Returns

_description_

qtvideo.converters.ndarray_to_qvideoframe(np_frame, *, with_ctypes=True)[source]#

_summary_.

Parameters

np_frame (ndarray[Any, dtype[uint8]]) – _description_
with_ctypes (bool) – _description_. Defaults to True.

Raises

RuntimeError – _description_

Return type

QVideoFrame

Returns

_description_

qtvideo.converters.qimage_to_ndarray(qimage)[source]#

_summary_.

Parameters: qimage (QImage) – _description_
Raises: RuntimeError – _description_
Return type: ndarray[Any, dtype[uint8]]
Returns: _description_

qtvideo.converters.qimage_to_qvideoframe(qimage)[source]#

_summary_.

Example

>>> from qtpy.QtGui import QImage
>>> from qtvideo.constants import DEFAULT_IMAGE_FORMAT
>>> qimage = QImage(600, 600, DEFAULT_IMAGE_FORMAT)
>>> assert not qimage.isNull()
>>> qvideoframe = qimage_to_qvideoframe(qimage)
>>> assert qvideoframe.isValid()

Parameters: qimage (QImage) – _description_
Raises: RuntimeError – _description_
Return type: QVideoFrame
Returns: _description_

qtvideo.converters.qvideoframe_to_ndarray(qvideoframe)[source]#

_summary_.

Parameters: qvideoframe (QVideoFrame) – _description_
Raises: RuntimeError – _description_
Return type: ndarray[Any, dtype[uint8]]
Returns: _description_

qtvideo.converters.qvideoframe_to_qimage(qvideoframe)[source]#

_summary_.

Parameters: qvideoframe (QVideoFrame) – _description_
Raises: RuntimeError – _description_
Return type: QImage
Returns: _description_

Classes#

class qtvideo.providers.FrameProvider(parent=None)[source]#

Bases: QObject

FrameProvider.

Parameters: parent (Optional[QObject]) – _description_. Defaults to None.

property video_sink: QVideoSink | None#

_summary_.

Return type: QVideoSink | None
Returns: _description_

write_frame(frame=None)[source]#

_summary_.

Parameters: frame (Union[ndarray[Any, dtype[uint8]], QImage, QVideoFrame, None]) – _description_. Defaults to None.
Return type: bool
Returns: _description_

Constants#

qtvideo.constants.DEFAULT_VIDEOFRAME_PLANE: int = 0#: The default plane.

qtvideo.constants.DEFAULT_VIDEOFRAME_FORMAT: PixelFormat = PixelFormat.Format_BGRA8888#: The default video format.

qtvideo.constants.DEFAULT_IMAGE_FORMAT: Format = Format.Format_ARGB32#: The default image format.