QCameraImageCapture

PyQt5.QtMultimedia.QCameraImageCapture

Inherits from QObject, QMediaBindableInterface.

Description

The QCameraImageCapture class is used for the recording of media content.

The QCameraImageCapture 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.

#     camera = new QCamera;

#     viewfinder = new QCameraViewfinder();
#     viewfinder->show();

#     camera->setViewfinder(viewfinder);

#     imageCapture = new QCameraImageCapture(camera);

#     camera->setCaptureMode(QCamera::CaptureStillImage);
#     camera->start();

#     //on half pressed shutter button
#     camera->searchAndLock();

#     //on shutter button pressed
#     imageCapture->capture();

#     //on shutter button released
#     camera->unlock();

See also

QCamera.

Classes

CaptureDestinations

Enums

CaptureDestination

Member	Value	Description
CaptureToBuffer	0x02	Capture the image to a buffer for further processing.
CaptureToFile	0x01	Capture the image to a file.

---

DriveMode

Member	Value	Description
SingleImageCapture	0	Drive mode is capturing a single picture.

---

Error

Member	Value	Description
FormatError	5	Current format is not supported.
NoError	0	No Errors.
NotReadyError	1	The service is not ready for capture yet.
NotSupportedFeatureError	4	Device does not support stillimages capture.
OutOfSpaceError	3	No space left on device.
ResourceError	2	Device is not ready or not available.

Methods

__init__(QMediaObject, parent: QObject = None)

TODO

---

availability() → AvailabilityStatus

Returns the availability of this functionality.

---

bufferFormat() → PixelFormat

Returns the buffer image capture format being used.

See also

supportedBufferFormats(), setBufferFormat().

---

cancelCapture()

Cancel incomplete capture requests. Already captured and queused for proicessing images may be discarded.

---

capture(file: str = '') → 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 backend choses 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 is called do not affect previous capture requests.

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

See also

isReadyForCapture().

---

captureDestination() → CaptureDestinations

Returns the image capture destination being used.

See also

isCaptureDestinationSupported(), setCaptureDestination().

---

encodingSettings() → QImageEncoderSettings

Returns the image encoder settings being used.

See also

setEncodingSettings().

---

error() → Error

Returns the current error state.

See also

errorString().

---

errorString() → str

Returns a string describing the current error state.

See also

error.

---

imageCodecDescription(str) → str

Returns a description of an image codec.

---

isAvailable() → bool

Returns true if the images capture service ready to use.

---

isCaptureDestinationSupported(Union[CaptureDestinations, CaptureDestination]) → bool

Returns true if the image capture destination is supported; otherwise returns false.

See also

captureDestination(), setCaptureDestination().

---

isReadyForCapture() → bool

TODO

---

mediaObject() → QMediaObject

TODO

---

setBufferFormat(PixelFormat)

Sets the buffer image capture format to be used.

See also

bufferFormat(), supportedBufferFormats(), captureDestination().

---

setCaptureDestination(Union[CaptureDestinations, CaptureDestination])

Sets the capture destination to be used.

See also

isCaptureDestinationSupported(), captureDestination().

---

setEncodingSettings(QImageEncoderSettings)

Sets the image encoding settings.

If some parameters are not specified, or null settings are passed, the encoder choose the default encoding parameters.

See also

encodingSettings().

---

setMediaObject(QMediaObject) → bool

TODO

---

supportedBufferFormats() → List[PixelFormat]

Returns the list of supported buffer image capture formats.

See also

bufferFormat(), setBufferFormat().

---

supportedImageCodecs() → List[str]

Returns a list of supported image codecs.

---

supportedResolutions(settings: QImageEncoderSettings = QImageEncoderSettings()) → (List[QSize], bool)

Returns a list of resolutions images can be encoded at.

If non null image settings parameter is passed, the returned list is reduced to resolution supported with partial settings like image codec or quality applied.

If the encoder supports arbitrary resolutions within the supported range, *continuous is set to true, otherwise *continuous is set to false.

See also

resolution().

Signals

bufferFormatChanged(PixelFormat)

TODO

---

captureDestinationChanged(Union[CaptureDestinations, CaptureDestination])

TODO

---

error()

Returns the current error state.

See also

errorString().

---

error(int, Error, str)

TODO

---

imageAvailable(int, QVideoFrame)

TODO

---

imageCaptured(int, QImage)

TODO

---

imageExposed(int)

TODO

---

imageMetadataAvailable(int, str, Any)

TODO

---

imageSaved(int, str)

TODO

---

readyForCaptureChanged(bool)

TODO