react-native-vision-camera/docs/docs/api/interfaces/index.takephotooptions.md
Marc Rousavy 0b7b4d50b5
Automatically build API documentation (#11)
* Automatically build API documentation using Typedoc and Docusaurus
* Move MD and move to MDX for Docusaurus Guides
2021-03-03 12:37:43 +01:00

3.5 KiB

id title sidebar_label custom_edit_url hide_title
index.takephotooptions Interface: TakePhotoOptions index.TakePhotoOptions null true

Interface: TakePhotoOptions

index.TakePhotoOptions

Properties

enableAutoDistortionCorrection

Optional enableAutoDistortionCorrection: undefined | boolean

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

default false

Defined in: src/PhotoFile.ts:52


enableAutoRedEyeReduction

Optional enableAutoRedEyeReduction: undefined | boolean

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

default false

Defined in: src/PhotoFile.ts:33


enableAutoStabilization

Optional enableAutoStabilization: undefined | boolean

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

default false

Defined in: src/PhotoFile.ts:46


enableVirtualDeviceFusion

Optional enableVirtualDeviceFusion: undefined | boolean

Specifies whether a virtual multi-cam device should capture images from all containing physical cameras to create a combined, higher quality image.

see isAutoVirtualDeviceFusionEnabled

Defined in: src/PhotoFile.ts:40


flash

Optional flash: undefined | off | auto | on

Whether the Flash should be enabled or disabled

default "auto"

Defined in: src/PhotoFile.ts:27


photoCodec

Optional photoCodec: undefined | hevc | hevc-alpha | jpeg

Specify the photo codec to use. To get a list of available photo codecs use the getAvailablePhotoCodecs() function.

default undefined

Defined in: src/PhotoFile.ts:10


qualityPrioritization

Optional qualityPrioritization: undefined | quality | balanced | speed

Indicates how photo quality should be prioritized against speed.

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

platform iOS 13.0+

default "balanced"

Defined in: src/PhotoFile.ts:21


skipMetadata

Optional skipMetadata: undefined | boolean

When set to true, metadata reading and mapping will be skipped. (PhotoFile.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: src/PhotoFile.ts:62