PySide6.QtMultimedia.QImageCapture

class QImageCapture

The QImageCapture class is used for the recording of media content. More…

Synopsis

Properties

• errorᅟ

• errorStringᅟ

• fileFormatᅟ - Image format

• metaDataᅟ - Meta data that will get embedded into the image

• qualityᅟ - Image encoding quality

• readyForCaptureᅟ

Methods

• def __init__()

• def addMetaData()

• def captureSession()

• def error()

• def errorString()

• def fileFormat()

• def isAvailable()

• def isReadyForCapture()

• def metaData()

• def quality()

• def resolution()

• def setFileFormat()

• def setMetaData()

• def setQuality()

• def setResolution()

Slots

• def capture()

• def captureToFile()

Signals

• def errorChanged()

• def errorOccurred()

• def fileFormatChanged()

• def imageAvailable()

• def imageCaptured()

• def imageExposed()

• def imageMetadataAvailable()

• def imageSaved()

• def metaDataChanged()

• def qualityChanged()

• def readyForCaptureChanged()

• def resolutionChanged()

Static functions

• def fileFormatDescription()

• def fileFormatName()

• def supportedFormats()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

The QImageCapture class is a high level images recording class. It’s not intended to be used alone but for accessing the media recording functions of other media objects, like QCamera .

captureSession = QMediaCaptureSession()
camera = QCamera()
captureSession.setCamera(camera)
viewfinder = QVideoWidget()
viewfinder.show()
captureSession.setVideoOutput(viewfinder)
imageCapture = QImageCapture(camera)
captureSession.setImageCapture(imageCapture)
camera.start()
#on shutter button pressed
imageCapture.capture()

See also

QCamera

class Error

Constant	Description
QImageCapture.Error.NoError	No Errors.
QImageCapture.Error.NotReadyError	The service is not ready for capture yet.
QImageCapture.Error.ResourceError	Device is not ready or not available.
QImageCapture.Error.OutOfSpaceError	No space left on device.
QImageCapture.Error.NotSupportedFeatureError	Device does not support stillimages capture.
QImageCapture.Error.FormatError	Current format is not supported.

class Quality

Enumerates quality encoding levels.

Constant	Description
QImageCapture.Quality.VeryLowQuality
QImageCapture.Quality.LowQuality
QImageCapture.Quality.NormalQuality
QImageCapture.Quality.HighQuality
QImageCapture.Quality.VeryHighQuality

class FileFormat

Choose one of the following image formats:

Constant	Description
QImageCapture.FileFormat.UnspecifiedFormat	No format specified
QImageCapture.FileFormat.JPEG	.jpg or .jpeg format
QImageCapture.FileFormat.PNG	.png format
QImageCapture.FileFormat.WebP	.webp format
QImageCapture.FileFormat.Tiff	.tiff format

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property errorᅟ: QImageCapture.Error

Returns the current error state.

See also

errorString()

Access functions:

• error()

• Signal errorChanged()

property errorStringᅟ: str

Returns a string describing the current error state.

See also

error()

Access functions:

• errorString()

• Signal errorChanged()

property fileFormatᅟ: QImageCapture.FileFormat

This property holds The image format..

Access functions:

• fileFormat()

• setFileFormat()

• Signal fileFormatChanged()

property metaDataᅟ: QMediaMetaData

This property holds The meta data that will get embedded into the image..

Note

Additional fields such as a time stamp or location may get added by the camera back end.

Access functions:

• metaData()

• setMetaData()

• Signal metaDataChanged()

property qualityᅟ: QImageCapture.Quality

This property holds The image encoding quality..

Access functions:

• quality()

• setQuality()

• Signal qualityChanged()

property readyForCaptureᅟ: bool

Holds true if the camera is ready to capture an image immediately. Calling capture() while readyForCapture is false is not permitted and results in an error.

Access functions:

• isReadyForCapture()

• Signal readyForCaptureChanged()

__init__([parent=None])

Parameters:

parent – QObject

Constructs a image capture object, from a parent, that can capture individual still images produced by a camera.

You must connect both an image capture object and a QCamera to a capture session to capture images.

addMetaData(metaData)

Parameters:

metaData – QMediaMetaData

Adds additional metaData to any existing meta data, that is embedded into the captured image.

capture()

Return type:

int

Capture the image and make it available as a QImage. This operation is asynchronous in majority of cases, followed by signals imageExposed() , imageCaptured() or error() .

QImageCapture::capture returns the capture Id parameter, used with imageExposed() , imageCaptured() and imageSaved() signals.

See also

isReadyForCapture()

captureSession()

Return type:

QMediaCaptureSession

Returns the capture session this camera is connected to, or a nullptr if the camera is not connected to a capture session.

Use setImageCapture() to connect the image capture to a session.

captureToFile([location=""])

Parameters:

location – str

Return type:

int

Capture the image and save it to file. This operation is asynchronous in majority of cases, followed by signals imageExposed() , imageCaptured() , imageSaved() or error() .

If an empty file is passed, the camera back end chooses the default location and naming scheme for photos on the system, if only file name without full path is specified, the image will be saved to the default directory, with a full path reported with imageCaptured() and imageSaved() signals.

QCamera saves all the capture parameters like exposure settings or image processing parameters, so changes to camera parameters after capture() is called do not affect previous capture requests.

capture returns the capture Id parameter, used with imageExposed() , imageCaptured() and imageSaved() signals.

See also

isReadyForCapture()

error()

Return type:

Error

Getter of property errorᅟ .

errorChanged()

Notification signal of property errorᅟ .

errorOccurred(id, error, errorString)

Parameters:

• id – int

• error – Error

• errorString – str

Signals that the capture request id has failed with an error and errorString description.

errorString()

Return type:

str

Getter of property errorStringᅟ .

fileFormat()

Return type:

FileFormat

See also

setFileFormat()

Getter of property fileFormatᅟ .

fileFormatChanged()

Notification signal of property fileFormatᅟ .

static fileFormatDescription(c)

Parameters:

c – FileFormat

Return type:

str

Returns the description of the given file format, f.

static fileFormatName(c)

Parameters:

c – FileFormat

Return type:

str

Returns the name of the given format, f.

imageAvailable(id, frame)

Parameters:

• id – int

• frame – QVideoFrame

Signal emitted when the frame with request id is available.

imageCaptured(id, preview)

Parameters:

• id – int

• preview – QImage

Signal emitted when the frame with request id was captured, but not processed and saved yet. Frame preview can be displayed to user.

imageExposed(id)

Parameters:

id – int

Signal emitted when the frame with request id was exposed.

imageMetadataAvailable(id, metaData)

Parameters:

• id – int

• metaData – QMediaMetaData

Signals that an image identified by id has metaData.

imageSaved(id, fileName)

Parameters:

• id – int

• fileName – str

Signal emitted when QImageCapture::CaptureToFile is set and the frame with request id was saved to fileName.

isAvailable()

Return type:

bool

Returns true if the images capture service ready to use.

isReadyForCapture()

Return type:

bool

Getter of property readyForCaptureᅟ .

metaData()

Return type:

QMediaMetaData

See also

setMetaData()

Getter of property metaDataᅟ .

metaDataChanged()

Notification signal of property metaDataᅟ .

quality()

Return type:

Quality

See also

setQuality()

Getter of property qualityᅟ .

qualityChanged()

Notification signal of property qualityᅟ .

readyForCaptureChanged(ready)

Parameters:

ready – bool

Signals that a camera’s ready for capture state has changed.

Notification signal of property readyForCaptureᅟ .

resolution()

Return type:

QSize

Returns the resolution of the encoded image.

See also

setResolution()

resolutionChanged()

Signals when the image resolution changes.

setFileFormat(format)

Parameters:

format – FileFormat

Sets the image format.

Assigning an unsupported FileFormat has no effect.

See also

fileFormat() supportedFormats

Setter of property fileFormatᅟ .

setMetaData(metaData)

Parameters:

metaData – QMediaMetaData

Replaces any existing meta data, to be embedded into the captured image, with a set of metaData.

See also

metaData()

Setter of property metaDataᅟ .

setQuality(quality)

Parameters:

quality – Quality

Sets the image encoding quality.

See also

quality()

Setter of property qualityᅟ .

setResolution(resolution)

Parameters:

resolution – QSize

Sets the resolution of the encoded image.

An empty QSize indicates the encoder should make an optimal choice based on what is available from the image source and the limitations of the codec.

See also

resolution()

setResolution(width, height)

Parameters:

• width – int

• height – int

Sets the width and height of the resolution of the encoded image.

This is an overloaded function.

static supportedFormats()

Return type:

.list of QImageCapture.FileFormat

Returns a list of supported file formats.

See also

FileFormat