DocumentClassicScannerConfiguration class

Annotations
  • @JsonSerializable(createFactory: false, includeIfNull: false, explicitToJson: true)

Constructors

DocumentClassicScannerConfiguration({bool? ignoreBadAspectRatio, bool? detectDocumentAfterSnap, bool autoSnapEnabled = false, double? acceptedAngleScore, double? acceptedSizeScore, List<PageAspectRatio>? requiredAspectRatios, double? autoSnapSensitivity, Size? originalImageSizeLimit, Size? documentImageSizeLimit})

Properties

acceptedAngleScore double?
The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Default is 75.0.
read / write
acceptedSizeScore double?
The minimum document width or height in percent (0 - 100) of the screen size to accept a detected document. Default is 80.0.
read / write
autoSnapEnabled bool
Whether the auto-snapping after successful document detection is enabled or not.
read / write
autoSnapSensitivity double?
Changes sensitivity of auto-snapping. That is: the more sensitive it is the faster it shoots. This parameter only works when barcodeImageGenerationType = BarcodeImageGenerationType.CAPTURED_IMAGE Sensitivity must be within (0..1) range. A value of 1.0 triggers automatic capturing immediately, a value of 0.0 delays the automatic capturing by 3 seconds.
read / write
detectDocumentAfterSnap bool?
Should detect document after snap? If true it will run document detection on Original image and will create document image Default - false
read / write
detectorType DetectorType
final
documentImageSizeLimit Size?
documentImageSizeLimit the maximum size of the cropped document image to be saved. If the image is larger than the specified size it will be downscaled. If originalImageSizeLimit is set it also limits the size of the cropped document image. By default not specified.
read / write
hashCode int
The hash code for this object.
read-onlyinherited
ignoreBadAspectRatio bool?
read / write
originalImageSizeLimit Size?
originalImageSizeLimit the maximum size of the original image to be saved. If the original image is larger than the specified size it will be downscaled. By default not specified.
read / write
requiredAspectRatios List<PageAspectRatio>?
Expected aspect ratios of the document. If the document has a different aspect ratio it will be rejected.
read / write
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited

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