QVideoSurfaceFormat¶

PyQt5.QtMultimedia.QVideoSurfaceFormat

Description¶

The QVideoSurfaceFormat class specifies the stream format of a video presentation surface.

A video surface presents a stream of video frames. The surface’s format describes the type of the frames and determines how they should be presented.

The core properties of a video stream required to setup a video surface are the pixel format given by pixelFormat(), and the frame dimensions given by frameSize().

If the surface is to present frames using a frame’s handle a surface format will also include a handle type which is given by the handleType() function.

The region of a frame that is actually displayed on a video surface is given by the viewport(). A stream may have a viewport less than the entire region of a frame to allow for videos smaller than the nearest optimal size of a video frame. For example the width of a frame may be extended so that the start of each scan line is eight byte aligned.

Other common properties are the pixelAspectRatio(), scanLineDirection(), and frameRate(). Additionally a stream may have some additional type specific properties which are listed by the dynamicPropertyNames() function and can be accessed using the property(), and setProperty() functions.

Enums¶

Direction

Enumerates the layout direction of video scan lines.

Member	Value	Description
BottomToTop	1	Scan lines are arranged from the bottom of the frame to the top.
TopToBottom	0	Scan lines are arranged from the top of the frame to the bottom.

YCbCrColorSpace

Enumerates the Y’CbCr color space of video frames.

Member	Value	Description
YCbCr_BT601	1	A Y’CbCr color space defined by ITU-R recommendation BT.601 with Y value range from 16 to 235, and Cb/Cr range from 16 to 240. Used in standard definition video.
YCbCr_BT709	2	A Y’CbCr color space defined by ITU-R BT.709 with the same values range as . Used for HDTV.
YCbCr_JPEG	5	The full range Y’CbCr color space used in JPEG files.
YCbCr_Undefined	0	No color space is specified.
YCbCr_xvYCC601	3	The BT.601 color space with the value range extended to 0 to 255. It is backward compatibile with BT.601 and uses values outside BT.601 range to represent a wider range of colors.
YCbCr_xvYCC709	4	The BT.709 color space with the value range extended to 0 to 255.

Methods¶

__init__(): Constructs a null video stream format.

__init__(QVideoSurfaceFormat): Constructs a copy of other.

__init__(QSize, PixelFormat, type: HandleType = NoHandle): Contructs a description of stream which receives stream of type buffers with given frame size and pixel format.

__eq__(QVideoSurfaceFormat) → bool: TODO

frameHeight() → int: Returns the height of frame in a video stream.

frameRate() → float: Returns the frame rate of a video stream in frames per second.

See also

setFrameRate().

frameSize() → QSize: Returns the dimensions of frames in a video stream.

See also

setFrameSize(), frameWidth(), frameHeight().

frameWidth() → int: Returns the width of frames in a video stream.

See also

frameSize(), frameHeight().

handleType() → HandleType

Returns the type of handle the surface uses to present the frame data.

If the handle type is QAbstractVideoBuffer::NoHandle, buffers with any handle type are valid provided they can be map() with the ReadOnly flag. If the is not NoHandle then the handle type of the buffer must be the same as that of the surface format.

isMirrored() → bool: TODO

isValid() → bool

Identifies if a video surface format has a valid pixel format and frame size.

Returns true if the format is valid, and false otherwise.

__ne__(QVideoSurfaceFormat) → bool: TODO

pixelAspectRatio() → QSize: Returns a video stream’s pixel aspect ratio.

See also

setPixelAspectRatio().

pixelFormat() → PixelFormat: Returns the pixel format of frames in a video stream.

property(str) → Any: Returns the value of the video format’s name property.

See also

setProperty().

propertyNames() → List[QByteArray]: Returns a list of video format dynamic property names.

scanLineDirection() → Direction: Returns the direction of scan lines.

See also

setScanLineDirection().

setFrameRate(float): Sets the frame rate of a video stream in frames per second.

See also

frameRate().

setFrameSize(QSize)

Sets the size of frames in a video stream to size.

This will reset the viewport() to fill the entire frame.