DocumentScannerCameraConfiguration class
Configuration of the camera behavior.
Constructors
- DocumentScannerCameraConfiguration.new({CameraModule cameraModule = CameraModule.BACK, double defaultZoomFactor = 1.0, bool autoCropOnManualSnap = true, bool flashEnabled = false, bool minFocusDistanceLock = false, bool touchToFocusEnabled = false, bool pinchToZoomEnabled = true, CameraPreviewMode cameraPreviewMode = CameraPreviewMode.FILL_IN, CapturePhotoQualityPrioritization captureQualityPrioritization = CapturePhotoQualityPrioritization.BALANCED, double autoSnappingSensitivity = 0.66, int autoSnappingDelay = 200, bool autoSnappingEnabled = true, bool captureWithHardwareButtonsEnabled = true})
-
DocumentScannerCameraConfiguration.fromJson(Map<
String, dynamic> json) -
factory
Properties
- autoCropOnManualSnap ↔ bool
-
Determines whether the document should be cropped automatically after a manual snap or not.
getter/setter pair
- autoSnappingDelay ↔ int
-
After a page has been snapped, the delay in milliseconds before auto snapping resumes for the next page.
getter/setter pair
- autoSnappingEnabled ↔ bool
-
Determines if auto snapping is enabled or not.
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 (2 seconds).
getter/setter pair
- cameraModule ↔ CameraModule
-
Determines which camera module to use on start-up.
getter/setter pair
- cameraPreviewMode ↔ CameraPreviewMode
-
Determines which camera preview mode to use.
getter/setter pair
- captureQualityPrioritization ↔ CapturePhotoQualityPrioritization
-
Determines the prioritization of still image quality and capturing speed.
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.
getter/setter pair
- defaultZoomFactor ↔ double
-
The default zoom factor on start-up.
getter/setter pair
- flashEnabled ↔ bool
-
Determines whether the flashlight is enabled or not on start-up.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- minFocusDistanceLock ↔ bool
-
Determines whether locking the focus at the minimum possible distance is enabled or not (device-specific).
getter/setter pair
- pinchToZoomEnabled ↔ bool
-
Determines whether pinch-to-zoom is enabled or not.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- touchToFocusEnabled ↔ bool
-
Determines whether touch-to-focus is enabled or not. Android only.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
{ToJsonConfiguration? config}) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited