CapturePhotoSettings

interface CapturePhotoSettings

Configuration options for a capturePhoto(...) call.

See

CameraPhotoOutput

Properties

enableCameraCalibrationDataDelivery?

optional enableCameraCalibrationDataDelivery: boolean

Specifies whether the capture pipeline should deliver Camera calibration data.

A Photo's calibration data can be accessed via Photo.calibrationData.

Default

false

enableDepthData?

optional enableDepthData: boolean

Enables or disables depth data delivery in the resulting Photo.

Depth data will be embedded in the Photo and can be accessed via Photo.depth.

enableDepthData can only be enabled if the CameraPhotoOutput supports depth data - see CameraPhotoOutput.supportsDepthDataDelivery.

Default

false

enableDistortionCorrection?

optional enableDistortionCorrection: boolean

Specifies whether the capture pipeline should automatically correct lens distortion.

Default

false

enableRedEyeReduction?

optional enableRedEyeReduction: boolean

Specifies whether red-eye reduction should be applied automatically on flash captures.

When flashMode is 'off', red eye reduction is automataically disabled.

Default

true

enableShutterSound?

optional enableShutterSound: boolean

Enables or disables the system shutter sound. The shutter sound is fired exactly when a photo will be captured.

Default

true

enableVirtualDeviceFusion?

optional enableVirtualDeviceFusion: boolean

Enables or disables virtual device image fusion.

If enabled, the Camera pipeline may capture photos from multiple constituent physical Camera devices at once (if using a Camera device that has multiple physical devices) to improve still image quality.

When capturing RAW photos, this is disabled.

Default

true

flashMode?

optional flashMode: FlashMode

Configures the FlashMode for this Photo capture.

Default

'off'

location?

optional location: Location

Sets the given Location to be embedded into the EXIF data of the captured Photo.

Default

undefined