# DocumentScannerCameraConfiguration class

Configuration of the camera behavior.

## Constructors

DocumentScannerCameraConfiguration({CameraModule cameraModule = CameraModule.BACK, double defaultZoomFactor = 1.0, bool flashEnabled = false, bool minFocusDistanceLock = false, bool touchToFocusEnabled = false, bool pinchToZoomEnabled = true, CameraPreviewMode cameraPreviewMode = CameraPreviewMode.FILL_IN, CapturePhotoQualityPrioritization captureQualityPrioritization = CapturePhotoQualityPrioritization.BALANCED, double acceptedAngleScore = 0.75, double acceptedSizeScore = 0.75, double autoSnappingSensitivity = 0.66, int autoSnappingDelay = 200, int acceptedBrightnessThreshold = 50, bool autoSnappingEnabled = true, List<AspectRatio>? requiredAspectRatios, bool ignoreBadAspectRatio = true, bool captureWithHardwareButtonsEnabled = true})
DocumentScannerCameraConfiguration.fromJson(Map<String, dynamic> json)
  factory

## Properties

acceptedAngleScore ↔ double
  The minimum pitch/skew angle of the document to be accepted. The value must be between 0.0 and 1.0. Default is 0.75
  getter/setter pair
acceptedBrightnessThreshold ↔ int
  The minimum brightness value to accept a detected document. Default is 50
  getter/setter pair
acceptedSizeScore ↔ double
  The minimum size of the document in relation to the screen preview to be accepted. The value must be between 0.0 and 1.0. Default is 0.75
  getter/setter pair
autoSnappingDelay ↔ int
  After a page has been snapped, the delay in milliseconds before auto snapping resumes for the next page. Default is 200
  getter/setter pair
autoSnappingEnabled ↔ bool
  Determines if auto snapping is enabled or not. Default is true
  getter/setter pair
autoSnappingSensitivity ↔ double
  Controls the auto snapping speed. The sensitivity must be between 0.0 and 1.0. A value of 1.0 triggers auto snapping immediately, while a value of 0.0 delays the auto snapping by 3 seconds. The default value is 0.66 (1 second). Default is 0.66
  getter/setter pair
cameraModule ↔ CameraModule
  Determines which camera module to use on start-up. Default is BACK
  getter/setter pair
cameraPreviewMode ↔ CameraPreviewMode
  Determines which camera preview mode to use. Default is FILL_IN
  getter/setter pair
captureQualityPrioritization ↔ CapturePhotoQualityPrioritization
  Determines the prioritization of still image quality and capturing speed. Default is BALANCED
  getter/setter pair
captureWithHardwareButtonsEnabled ↔ bool
  When enabled the hardware volume up/down buttons can be used to capture an image if manual snapping is enabled. For iOS version 17.2 or later is required. On iPhones with camera control (iPhone 16 series) this also enables zooming and capturing with the camera control. Default is true
  getter/setter pair
defaultZoomFactor ↔ double
  The default zoom factor on start-up. Default is 1.0
  getter/setter pair
flashEnabled ↔ bool
  Determines whether the flashlight is enabled or not on start-up. Default is false
  getter/setter pair
hashCode → int
  The hash code for this object.
  no setter inherited
ignoreBadAspectRatio ↔ bool
  Determines whether a landscape document will be detected when the camera is in portrait mode (and vice versa) or not. This parameter will be ignored if required aspect ratios have been explicitly defined. Default is true
  getter/setter pair
minFocusDistanceLock ↔ bool
  Determines whether locking the focus at the minimum possible distance is enabled or not (device-specific). Default is false
  getter/setter pair
pinchToZoomEnabled ↔ bool
  Determines whether pinch-to-zoom is enabled or not. Default is true
  getter/setter pair
requiredAspectRatios ↔ List<AspectRatio>
  The required aspect ratios for the document to be accepted.
  getter/setter pair
runtimeType → Type
  A representation of the runtime type of the object.
  no setter inherited
touchToFocusEnabled ↔ bool
  Determines whether touch-to-focus is enabled or not. Android only. Default is false
  getter/setter pair

## Methods

noSuchMethod(Invocation invocation) → dynamic
  Invoked when a nonexistent method or property is accessed.
  inherited
toJson() → Map<String, dynamic>
toString() → String
  A string representation of this object.
  inherited

## Operators

operator ==(Object other) → bool
  The equality operator.
  inherited