PhotoOutputOptions

interface PhotoOutputOptions

Configuration options for a CameraPhotoOutput.

See

• CameraPhotoOutput
• usePhotoOutput(...)

Properties

containerFormat

containerFormat: TargetPhotoContainerFormat

Specifies the TargetPhotoContainerFormat to shoot the Photo in.

The TargetPhotoContainerFormat must be one of the formats of the currently selected CameraFormat's supportedPhotoContainerFormats.

enableHDR

enableHDR: boolean

Specifies whether to use Photo HDR for capture.

The currently selected CameraFormat must support Photo HDR (see supportsPhotoHDR), otherwise an error will be thrown.

previewImageTargetSize?

optional previewImageTargetSize: Size

When this is set to a specific Size, a ready to display Image will be delivered just before the resulting Photo is available.

Preview Image delivery requires additional processing, so this is disabled by default.

If this is undefined (the default), no preview Image will be supplied.

It is recommended to set this to a Size that is as low as possible to avoid unnecessary overhead.

See

CapturePhotoCallbacks.onPreviewImageAvailable

Default

undefined

quality

quality: number

Defines the compression quality for processed photo formats.

The value must be within the normalized range from 0.0 to 1.0, where 1.0 is the highest quality and 0.0 is the strongest compression.

RAW photo formats such as 'dng' ignore this option.

Default

0.9 in usePhotoOutput(...)

qualityPrioritization

qualityPrioritization: QualityPrioritization

Specifies the balance between speed or image quality for the photo capture pipeline.

The currently selected CameraDevice must support QualityPrioritization 'speed' (see supportsSpeedQualityPrioritization), otherwise an error will be thrown.