ScanbotSdkConfig class
Scanbot SDK initialization config parameters.
- Annotations
-
- @JsonSerializable(createFactory: false, includeIfNull: false, explicitToJson: true)
Constructors
- ScanbotSdkConfig({String? licenseKey, int? imageQuality, ImageFormat? imageFormat, bool? loggingEnabled, String? storageBaseDirectory, dynamic licenseErrorHandler(Status, SdkFeature?, String)?, EncryptionParameters? encryptionParameters, DocumentDetectorMode? documentDetectorMode, bool? useCameraX, bool? allowGpuAcceleration, bool? allowXnnpackAcceleration})
Properties
- allowGpuAcceleration ↔ bool?
-
If set to false, GPU Acceleration will be disabled for Barcode Scanner, Document Scanner and Generic Document Recognizer (Android only).
Default is true.
getter/setter pair
- allowXnnpackAcceleration ↔ bool?
-
If set to false, disables XNN pack optimizations (Android only).
Default is true.
getter/setter pair
- documentDetectorMode ↔ DocumentDetectorMode?
-
Optional document detector mode:
EDGE_BASED - default implementation, based on classical edge detection approach
ML_BASED - new Machine Learning based approach (requires iOS 11.2+)
getter/setter pair
- encryptionParameters ↔ EncryptionParameters?
-
Configuration object that helps to enable encryption inside sdk storage
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- imageFormat ↔ ImageFormat?
-
Optional image format value in which format all pages will be stored.
getter/setter pair
- imageQuality ↔ int?
-
Optional image quality value. Defines the quality factor of JPEG images.
The value must be between 1 and 100, where 100 means maximum quality and
largest file size. The default value is 80 which is a good compromise
between image file size and document legibility.
getter/setter pair
- licenseErrorHandler ↔ (dynamic Function(Status, SdkFeature?, String)?)
-
Callback function to get info about problems with license key
or concrete feature that is not available for usage
getter/setter pair
- licenseKey ↔ String?
-
Your license key for the Scanbot SDK.
getter/setter pair
- loggingEnabled ↔ bool?
-
Optional logging flag. While it may be useful for development,
consider switching logging OFF in production builds for security and performance reasons!
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- storageBaseDirectory ↔ String?
-
Optional custom storage base directory. Can be nil.
getter/setter pair
- useCameraX ↔ bool?
-
If set to true, CameraX will be used for the RTU-UI components (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