QVideoSurfaceFormat¶

Synopsis¶

Functions¶

def __eq__ (format)
def __ne__ (format)
def frameHeight ()
def frameRate ()
def frameSize ()
def frameWidth ()
def handleType ()
def isValid ()
def pixelAspectRatio ()
def pixelFormat ()
def property (name)
def propertyNames ()
def scanLineDirection ()
def setFrameRate (rate)
def setFrameSize (size)
def setFrameSize (width, height)
def setPixelAspectRatio (ratio)
def setPixelAspectRatio (width, height)
def setProperty (name, value)
def setScanLineDirection (direction)
def setViewport (viewport)
def setYCbCrColorSpace (colorSpace)
def sizeHint ()
def viewport ()
def yCbCrColorSpace ()

Detailed Description¶

The PySide.QtMultimedia.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 PySide.QtMultimedia.QVideoSurfaceFormat.pixelFormat() , and the frame dimensions given by PySide.QtMultimedia.QVideoSurfaceFormat.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 PySide.QtMultimedia.QVideoSurfaceFormat.handleType() function.

The region of a frame that is actually displayed on a video surface is given by the PySide.QtMultimedia.QVideoSurfaceFormat.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 PySide.QtMultimedia.QVideoSurfaceFormat.pixelAspectRatio() , PySide.QtMultimedia.QVideoSurfaceFormat.scanLineDirection() , and PySide.QtMultimedia.QVideoSurfaceFormat.frameRate() . Additionally a stream may have some additional type specific properties which are listed by the dynamicPropertyNames() function and can be accessed using the PySide.QtMultimedia.QVideoSurfaceFormat.property() , and PySide.QtMultimedia.QVideoSurfaceFormat.setProperty() functions.

class PySide.QtMultimedia.QVideoSurfaceFormat¶

class PySide.QtMultimedia.QVideoSurfaceFormat(size, pixelFormat[, handleType=QAbstractVideoBuffer.NoHandle])

class PySide.QtMultimedia.QVideoSurfaceFormat(format)

Parameters:	size – `PySide.QtCore.QSize` format – `PySide.QtMultimedia.QVideoSurfaceFormat` pixelFormat – `PySide.QtMultimedia.QVideoFrame.PixelFormat` handleType – `PySide.QtMultimedia.QAbstractVideoBuffer.HandleType`

Constructs a null video stream format.

Constructs a copy of other .

PySide.QtMultimedia.QVideoSurfaceFormat.YCbCrColorSpace¶

Enumerates the Y’CbCr color space of video frames.

Constant	Description
QVideoSurfaceFormat.YCbCr_Undefined	No color space is specified.
QVideoSurfaceFormat.YCbCr_BT601	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.
QVideoSurfaceFormat.YCbCr_BT709	A Y’CbCr color space defined by ITU-R BT.709 with the same values range as `YCbCr_BT601` . Used for HDTV.
QVideoSurfaceFormat.YCbCr_xvYCC601	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 wider colors range.
QVideoSurfaceFormat.YCbCr_xvYCC709	The BT.709 color space with the value range extended to 0 to 255.
QVideoSurfaceFormat.YCbCr_JPEG	The full range Y’CbCr color space used in JPEG files.

PySide.QtMultimedia.QVideoSurfaceFormat.Direction¶

Enumerates the layout direction of video scan lines.

Constant	Description
QVideoSurfaceFormat.TopToBottom	Scan lines are arranged from the top of the frame to the bottom.
QVideoSurfaceFormat.BottomToTop	Scan lines are arranged from the bottom of the frame to the top.

PySide.QtMultimedia.QVideoSurfaceFormat.frameHeight()¶

Return type:	`PySide.QtCore.int`

Returns the height of frame in a video stream.

PySide.QtMultimedia.QVideoSurfaceFormat.frameRate()¶

Return type:	`PySide.QtCore.qreal`

Returns the frame rate of a video stream in frames per second.

PySide.QtMultimedia.QVideoSurfaceFormat.frameSize()¶

Return type:	`PySide.QtCore.QSize`

Returns the size of frames in a video stream.

PySide.QtMultimedia.QVideoSurfaceFormat.frameWidth()¶

Return type:	`PySide.QtCore.int`

Returns the width of frames in a video stream.

PySide.QtMultimedia.QVideoSurfaceFormat.handleType()¶

Return type:	`PySide.QtMultimedia.QAbstractVideoBuffer.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 mapped with the QAbstractVideoBuffer.ReadOnly flag. If the PySide.QtMultimedia.QVideoSurfaceFormat.handleType() is not QAbstractVideoBuffer.NoHandle then the handle type of the buffer be the same as that of the surface format.

PySide.QtMultimedia.QVideoSurfaceFormat.isValid()¶

Return type:	`PySide.QtCore.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.

PySide.QtMultimedia.QVideoSurfaceFormat.__ne__(format)¶

Parameters:	format – `PySide.QtMultimedia.QVideoSurfaceFormat`
Return type:	`PySide.QtCore.bool`

Returns true if other is different to a video format, and false if they are the same.

PySide.QtMultimedia.QVideoSurfaceFormat.__eq__(format)¶

Parameters:	format – `PySide.QtMultimedia.QVideoSurfaceFormat`
Return type:	`PySide.QtCore.bool`

Returns true if other is the same as a video format, and false if they are the different.

PySide.QtMultimedia.QVideoSurfaceFormat.pixelAspectRatio()¶

Return type:	`PySide.QtCore.QSize`

Returns a video stream’s pixel aspect ratio.

PySide.QtMultimedia.QVideoSurfaceFormat.pixelFormat()¶

Return type:	`PySide.QtMultimedia.QVideoFrame.PixelFormat`

Returns the pixel format of frames in a video stream.

PySide.QtMultimedia.QVideoSurfaceFormat.property(name)¶

Parameters:	name – str
Return type:	object

Returns the value of the video format’s name property.

PySide.QtMultimedia.QVideoSurfaceFormat.propertyNames()¶

Return type:

Returns a list of video format dynamic property names.

PySide.QtMultimedia.QVideoSurfaceFormat.scanLineDirection()¶

Return type:	`PySide.QtMultimedia.QVideoSurfaceFormat.Direction`

Returns the direction of scan lines.

PySide.QtMultimedia.QVideoSurfaceFormat.setFrameRate(rate)¶

Parameters:	rate – `PySide.QtCore.qreal`

Sets the frame rate of a video stream in frames per second.

PySide.QtMultimedia.QVideoSurfaceFormat.setFrameSize(width, height)¶

Parameters:	width – `PySide.QtCore.int` height – `PySide.QtCore.int`

This is an overloaded function.

Sets the width and height of frames in a video stream.

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

PySide.QtMultimedia.QVideoSurfaceFormat.setFrameSize(size)

Parameters:	size – `PySide.QtCore.QSize`

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

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

PySide.QtMultimedia.QVideoSurfaceFormat.setPixelAspectRatio(ratio)¶

Parameters:	ratio – `PySide.QtCore.QSize`

Sets a video stream’s pixel aspect ratio .

PySide.QtMultimedia.QVideoSurfaceFormat.setPixelAspectRatio(width, height)

Parameters:	width – `PySide.QtCore.int` height – `PySide.QtCore.int`

This is an overloaded function.

Sets the horizontal and vertical elements of a video stream’s pixel aspect ratio.

PySide.QtMultimedia.QVideoSurfaceFormat.setProperty(name, value)¶

Parameters:	name – str value – object

Sets the video format’s name property to value .

PySide.QtMultimedia.QVideoSurfaceFormat.setScanLineDirection(direction)¶

Parameters:	direction – `PySide.QtMultimedia.QVideoSurfaceFormat.Direction`

Sets the direction of scan lines.

PySide.QtMultimedia.QVideoSurfaceFormat.setViewport(viewport)¶

Parameters:	viewport – `PySide.QtCore.QRect`

Sets the viewport of a video stream to viewport .

PySide.QtMultimedia.QVideoSurfaceFormat.setYCbCrColorSpace(colorSpace)¶

Parameters:	colorSpace – `PySide.QtMultimedia.QVideoSurfaceFormat.YCbCrColorSpace`

Sets the Y’CbCr color space of a video stream. It is only used with raw YUV frame types.

PySide.QtMultimedia.QVideoSurfaceFormat.sizeHint()¶

Return type:	`PySide.QtCore.QSize`

Returns a suggested size in pixels for the video stream.

This is the size of the viewport scaled according to the pixel aspect ratio.

PySide.QtMultimedia.QVideoSurfaceFormat.viewport()¶

Return type:	`PySide.QtCore.QRect`

Returns the viewport of a video stream.

The viewport is the region of a video frame that is actually displayed.

By default the viewport covers an entire frame.

PySide.QtMultimedia.QVideoSurfaceFormat.yCbCrColorSpace()¶

Return type:	`PySide.QtMultimedia.QVideoSurfaceFormat.YCbCrColorSpace`

Returns the Y’CbCr color space of a video stream.

Table Of Contents

Previous topic

Next topic

QVideoSurfaceFormat¶

Synopsis¶

Functions¶

Detailed Description¶

Table Of Contents

Previous topic

Next topic

Quick search

QVideoSurfaceFormat¶

Synopsis¶

Functions¶

Detailed Description¶