DocumentOverlaySettings class
Class for setting up document overlay. Document overlay is best suited for recognizers that perform ID document scanning.
- Inheritance
-
- Object
- OverlaySettings
- DocumentOverlaySettings
- Annotations
-
- @JsonSerializable()
Constructors
- DocumentOverlaySettings()
-
DocumentOverlaySettings.fromJson(Map<
String, dynamic> json) -
factory
Properties
- country ↔ String?
-
(optional) to be used with language variable, it defines the country locale
example: "US" to use "en_US" on Android and en-US on iOS
getter/setter pairinherited
- enableBeep ↔ bool
-
whether beep sound will be played on successful scan
false by default
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- language ↔ String?
-
(optional) if default overlay contains textual information, text will be localized to this language. Otherwise device langauge will be used
example: "en"
getter/setter pairinherited
- overlaySettingsType ↔ String?
-
type of the overlay settings object
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- useFrontCamera ↔ bool
-
whether front camera should be used instead of the default camera
false by default
getter/setter pairinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited