|  | Home · All Classes · Modules

# QAbstractVideoSurface Class Reference
[QtMultimedia module]

The QAbstractVideoSurface class is a base class for video presentation surfaces. More...

Inherits QObject.

### Types

- enum Error { NoError, UnsupportedFormatError, IncorrectFormatError, StoppedError, ResourceError }

### Methods

- __init__ (self, QObject parent = None)
- Error error (self)
- bool isActive (self)
- bool isFormatSupported (self, QVideoSurfaceFormat format)
- QVideoSurfaceFormat nearestFormat (self, QVideoSurfaceFormat format)
- bool present (self, QVideoFrame frame)
- setError (self, Error error)
- bool start (self, QVideoSurfaceFormat format)
- stop (self)
- list-of-QVideoFrame.PixelFormat supportedPixelFormats (self, QAbstractVideoBuffer.HandleType type = QAbstractVideoBuffer.NoHandle)
- QVideoSurfaceFormat surfaceFormat (self)

### Qt Signals

- void activeChanged (bool)
- void supportedFormatsChanged ()
- void surfaceFormatChanged (const QVideoSurfaceFormat&)

## Detailed Description

The QAbstractVideoSurface class is a base class for video presentation surfaces.

The QAbstractVideoSurface class defines the standard interface that video producers use to inter-operate with video presentation surfaces. It is not supposed to be instantiated directly. Instead, you should subclass it to create new video surfaces.

A video surface presents a continuous stream of identically formatted frames, where the format of each frame is compatible with a stream format supplied when starting a presentation.

A list of pixel formats a surface can present is given by the supportedPixelFormats() function, and the isFormatSupported() function will test if a video surface format is supported. If a format is not supported the nearestFormat() function may be able to suggest a similar format. For example if a surface supports fixed set of resolutions it may suggest the smallest supported resolution that contains the proposed resolution.

The start() function takes a supported format and enables a video surface. Once started a surface will begin displaying the frames it receives in the present() function. Surfaces may hold a reference to the buffer of a presented video frame until a new frame is presented or streaming is stopped. The stop() function will disable a surface and a release any video buffers it holds references to.

## Type Documentation

### QAbstractVideoSurface.Error

This enum describes the errors that may be returned by the error() function.

Constant | Value | Description
--- | --- | ---
`QAbstractVideoSurface.NoError` | `0` | No error occurred.
`QAbstractVideoSurface.UnsupportedFormatError` | `1` | A video format was not supported.
`QAbstractVideoSurface.IncorrectFormatError` | `2` | A video frame was not compatible with the format of the surface.
`QAbstractVideoSurface.StoppedError` | `3` | The surface has not been started.
`QAbstractVideoSurface.ResourceError` | `4` | The surface could not allocate some resource.

## Method Documentation

### QAbstractVideoSurface.__init__ (self, QObject parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs a video surface with the given parent.

### Error QAbstractVideoSurface.error (self)

Returns the last error that occurred.

If a surface fails to start(), or stops unexpectedly this function can be called to discover what error occurred.

See also setError().

### bool QAbstractVideoSurface.isActive (self)

Indicates whether a video surface has been started.

Returns true if the surface has been started, and false otherwise.

### bool QAbstractVideoSurface.isFormatSupported (self, QVideoSurfaceFormat format)

Tests a video surface format to determine if a surface can accept it.

Returns true if the format is supported by the surface, and false otherwise.

### QVideoSurfaceFormat QAbstractVideoSurface.nearestFormat (self, QVideoSurfaceFormat format)

Returns a supported video surface format that is similar to format.

A similar surface format is one that has the same pixel format and handle type but differs in some of the other properties. For example if there are restrictions on the frame sizes a video surface can accept it may suggest a format with a larger frame size and a viewport the size of the original frame size.

If the format is already supported it will be returned unchanged, or if there is no similar supported format an invalid format will be returned.

### bool QAbstractVideoSurface.present (self, QVideoFrame frame)

This method is abstract and should be reimplemented in any sub-class.

Presents a video frame.

Returns true if the frame was presented, and false if an error occurred.

Not all surfaces will block until the presentation of a frame has completed. Calling present() on a non-blocking surface may fail if called before the presentation of a previous frame has completed. In such cases the surface may not return to a ready state until it's had an opportunity to process events.

If present() fails for any other reason the surface will immediately enter the stopped state and an error() value will be set.

A video surface must be in the started state for present() to succeed, and the format of the video frame must be compatible with the current video surface format.

See also error().

### QAbstractVideoSurface.setError (self, Error error)

Sets the value of error() to error.

See also error().

### bool QAbstractVideoSurface.start (self, QVideoSurfaceFormat format)

Starts a video surface presenting format frames.

Returns true if the surface was started, and false if an error occurred.

See also isActive() and stop().

### QAbstractVideoSurface.stop (self)

Stops a video surface presenting frames and releases any resources acquired in start().

See also isActive() and start().

### list-of-QVideoFrame.PixelFormat QAbstractVideoSurface.supportedPixelFormats (self, QAbstractVideoBuffer.HandleType type = QAbstractVideoBuffer.NoHandle)

This method is abstract and should be reimplemented in any sub-class.

Returns a list of pixel formats a video surface can present for a given handle type.

The pixel formats returned for the QAbstractVideoBuffer.NoHandle type are valid for any buffer that can be mapped in read-only mode.

Types that are first in the list can be assumed to be faster to render.

### QVideoSurfaceFormat QAbstractVideoSurface.surfaceFormat (self)

Returns the format of a video surface.

## Qt Signal Documentation

### void activeChanged (bool)

This is the default overload of this signal.

Signals that the active state of a video surface has changed.

See also isActive(), start(), and stop().

### void supportedFormatsChanged ()

This is the default overload of this signal.

Signals that the set of formats supported by a video surface has changed.

See also supportedPixelFormats() and isFormatSupported().

### void surfaceFormatChanged (const QVideoSurfaceFormat&)

This is the default overload of this signal.

Signals that the configured format of a video surface has changed.

See also surfaceFormat() and start().