ImageCapture QML Type | Qt Multimedia | Qt 6.11.0
Description: An interface for capturing camera images.

- Qt 6.11
- Qt Multimedia
- QML Types
- ImageCapture
- Qt 6.11.0 Reference Documentation

# ImageCapture QML Type

An interface for capturing camera images. More...

Import Statement: | `import QtMultimedia`

- List of all members, including inherited members

## Properties

- error : enumeration
- errorString : string
- fileFormat : enumeration
- metaData : mediaMetaData
- preview : string
- quality : enumeration
- readyForCapture : bool
- supportedFormats : list<FileFormat> `(since 6.10)`

## Signals

- errorOccurred(id, error, errorString)
- imageCaptured(requestId, preview)
- imageMetadataAvailable(id, metaData)
- imageSaved(id, fileName)

## Methods

- int capture()
- int captureToFile(location)
- void saveToFile(location)

## Detailed Description

This type allows you to capture still images and be notified when they are available or saved to disk.

     Item {
         width: 640
         height: 360

         CaptureSession {
             imageCapture : ImageCapture {
                 id: imageCapture
             }
             camera: Camera {
                 id: camera
             }

             videoOutput: videoOutput
         }
         VideoOutput {
             id: videoOutput
             anchors.fill: parent

             MouseArea {
                 anchors.fill: parent;
                 onClicked: imageCapture.capture();
             }
         }

         Image {
             id: photoPreview
             source: imageCapture.preview // always shows the last captured image
         }
     }

## Property Documentation

### error : enumeration `[read-only]`

This property holds the last error type that occurred. It can be one of the following.

Constant | Description
--- | ---
`ImageCapture.NoError` | No esrrors.
`ImageCapture.NotReadyError` | The service is not ready for capture yet.
`ImageCapture.ResourceError` | Device is not ready or not available.
`ImageCapture.OutOfSpaceError` | No space left on device.
`ImageCapture.NotSupportedFeatureError` | Device does not support stillimages capture.
`ImageCapture.FormatError` | Current format is not supported.

See also errorString.

### errorString : string `[read-only]`

This property holds the last error message that occurred.

See also error.

### fileFormat : enumeration

This property holds the file format for which the image will be written. It can be one of the following.

Constant | Description
--- | ---
`UnspecifiedFormat` | No format specified
`JPEG` | `.jpg` or `.jpeg` format
`PNG` | `.png` format
`WebP` | `.webp` format
`Tiff` | `.tiff` format

### metaData : mediaMetaData

This property holds the metadata that wil be embedded into the image.

### preview : string `[read-only]`

This property holds a url to the latest captured image. It can be connected to the source property of an Image element to show the last captured image.

     CaptureSession {
         camera: Camera {}
         imageCapture: ImageCapture {
             id: capture
         }
     }
     Image {
         source: capture.preview
     }

See also saveToFile.

### quality : enumeration

This property holds the quality hint when storing the captured image. It can be one of the following values.

Constant | Description
--- | ---
`VeryLowQuality` | Very low
`LowQuality` | Low
`NormalQuality` | Normal
`HighQuality` | High
`VeryHighQuality` | Very high

### readyForCapture : bool `[read-only]`

This property holds a bool value indicating whether the camera is ready to capture photos or not.

Calling capture() or captureToFile() while ready is `false` is not permitted and results in an error.

### supportedFormats : list<FileFormat> `[read-only, since 6.10]`

Contains a list of supported file formats.

This property was introduced in Qt 6.10.

See also fileFormat.

## Signal Documentation

### errorOccurred(id, error, errorString)

This signal is emitted when an error occurs during capture with requested id. error is an enumeration of type ImageCapture::Error. A descriptive message is available in errorString.

Note: The corresponding handler is `onErrorOccurred`.

See also error and errorString.

### imageCaptured(requestId, preview)

This signal is emitted when an image with requested id requestId has been captured but not yet saved to the filesystem. The preview parameter is the captured image.

Note: The corresponding handler is `onImageCaptured`.

See also imageSaved and preview.

### imageMetadataAvailable(id, metaData)

This signal is emitted when the image with requested id has new metaData.

Note: The corresponding handler is `onImageMetadataAvailable`.

See also imageCaptured.

### imageSaved(id, fileName)

This signal is emitted after the image with requested id has been written to the filesystem. The fileName is a local file path, not a URL.

Note: The corresponding handler is `onImageSaved`.

See also imageCaptured.

## Method Documentation

### int capture()

Start image capture. The imageCaptured and imageSaved signals will be emitted when the capture is complete.

The captured image will be available through the preview property that can be used as the source for a QML Image item. The saveToFile() method can then be used save the image.

Camera 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 requestId parameter, used with imageExposed(), imageCaptured(), imageMetadataAvailable() and imageSaved() signals.

See also readyForCapture and preview.

### int captureToFile(location)

Does the same as capture() but additionally automatically saves the captured image to the specified location. Returns the capture requestId parameter.

See also capture().

### void saveToFile(location)

Saves the last captured image to location.

See also capture and preview.