Skip to main content

TakePhotoOptions

Properties​

enableAutoDistortionCorrection​

• Optional enableAutoDistortionCorrection: boolean

Specifies whether the photo output should use content aware distortion correction on this photo request (at its discretion).

Default

false

Defined in​

PhotoFile.ts:39

enableAutoRedEyeReduction​

• Optional enableAutoRedEyeReduction: boolean

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

Default

false

Defined in​

PhotoFile.ts:27

enableAutoStabilization​

• Optional enableAutoStabilization: boolean

Indicates whether still image stabilization will be employed when capturing the photo

Default

false

Defined in​

PhotoFile.ts:33

flash​

• Optional flash: "off" | "auto" | "on"

Whether the Flash should be enabled or disabled

Default

"auto"

Defined in​

PhotoFile.ts:21

photoCodec​

• Optional photoCodec: CameraPhotoCodec

Specifies the photo codec to use for this capture. The provided photo codec has to be supported by the session.

Defined in​

PhotoFile.ts:43

qualityPrioritization​

• Optional qualityPrioritization: "quality" | "balanced" | "speed"

Indicates how photo quality should be prioritized against speed.

  • "quality" Indicates that photo quality is paramount, even at the expense of shot-to-shot time
  • "balanced" Indicates that photo quality and speed of delivery are balanced in priority
  • "speed" Indicates that speed of photo delivery is most important, even at the expense of quality

Platform

iOS 13.0+

Default

"balanced"

Defined in​

PhotoFile.ts:15

skipMetadata​

• Optional skipMetadata: boolean

When set to true, metadata reading and mapping will be skipped. (metadata will be null)

This might result in a faster capture, as metadata reading and mapping requires File IO.

Default

false

Platform

Android

Defined in​

PhotoFile.ts:53