AnalyzerSettings class
Settings for the Capture analyzer. Used for setting capture strategies and scanning parameters.
- Annotations
-
- @JsonSerializable()
Constructors
- AnalyzerSettings.new()
- Settings for the Capture analyzer. Used for setting capture strategies and scanning parameters.
-
AnalyzerSettings.fromJson(Map<
String, dynamic> json) -
factory
Properties
- adjustMinimumDocumentDpi ↔ bool?
-
Defines whether to automatically adjust minimum document dpi.
If it is enabled, the minimum dpi is adjusted to the optimal value for the provided input resolution
to enable the capture of all document groups.
getter/setter pair
- blurPolicy ↔ BlurPolicy?
-
Policy used to discard frames with blurred documents.
See BlurPolicy enum for more detailed information.
getter/setter pair
- captureSingleSide ↔ bool?
-
Defines whether to capture a single side or capture all possible sides of a
document with automatic side detection.
getter/setter pair
- captureStrategy ↔ CaptureStrategy?
-
Configures capture strategy used to select the best frame.
See CaptureStrategy enum for more detailed information.
getter/setter pair
- documentFramingMargin ↔ double?
-
Enables document capture with a margin defined as the percentage
of the dimensions of the framed document.
Both margin and document are required to be fully visible on the camera frame in order to finish capture.
getter/setter pair
- enforcedDocumentGroup ↔ EnforcedDocumentGroup?
-
Enforces a specific document group, overriding the analyzer’s document classification.
This setting impacts the number of sides scanned to match the enforced group,
and the way document image is transformed.
If set to null, the document group won't be enforced and it will be auto-detected.
getter/setter pair
- glarePolicy ↔ GlarePolicy?
-
Policy used to discard frames with glare detected on the document.
See GlarePolicy enum for more detailed information.
getter/setter pair
- handOcclusionThreshold ↔ double?
-
Defines the percentage of the document area that is allowed to be
occluded by hand.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- keepDpiOnTransformedDocumentImage ↔ bool?
-
Defines whether to preserve the captured document DPI in the transformed document image.
If disabled, the document dpi is downscaled to 400 DPI.
getter/setter pair
- keepMarginOnTransformedDocumentImage ↔ bool?
-
Defines whether to return an image of the transformed document
with applied margin used during document framing.
getter/setter pair
- lightingThresholds ↔ LightingThresholds?
-
Sets the for lighting estimation.
See LightingThresholds class for more detailed information.
getter/setter pair
- minimumDocumentDpi ↔ int?
-
Sets the required minimum DPI of the captured document on the transformed image.
Affects how close the document needs to be to the camera in order to get captured.
Allowed values are from 150 to 400 DPI.
Default:
230getter/setter pair - returnTransformedDocumentImage ↔ bool?
-
Defines whether to return an image of a cropped and perspective-corrected document.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- tiltPolicy ↔ TiltPolicy?
-
Policy used to detect tilted documents.
See TiltPolicy enum for more detailed information.
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