OnyxOptions class
the settings for the onyx plugin
Constructors
- OnyxOptions([String? licenseKey = "", bool isRawImageReturned = true, bool isUseFlash = true, double cropFactor = 1.0, double cropSizeHeight = 512, double cropSizeWidth = 300, bool isProcessedImageReturned = true, bool isEnhancedImageReturned = true, bool isWSQImageReturned = true, bool isFingerprintTemplateImageReturned = true, bool isLoadingSpinnerShown = false, bool isImageThreshold = false, bool isThumbCapture = false, bool isManualCapture = false, bool isOnyxLive = false, bool isNFIQMetrics = false, bool isPGMFormatByteArrayReturned = false, bool isConvertToISOTemplate = false, int imageRotation = 0, bool isFullFrameImageReturned = false, LayoutPreference layoutPreference = LayoutPreference.FULL, ReticleOrientations reticleOrientation = ReticleOrientations.LEFT, bool isFourFingerReticleUsed = true, bool isPerformQualityCheckMatch = false, bool isUploadMetrics = false, bool isOnlyHighQualityImageReturned = false, bool isErrorOnNFIQ5Score = false, bool isShutterSoundEnabled = false, bool isCamera2PreviewStreamingUsed = false])
Properties
- cropFactor ↔ double
-
The crop factor for the image.
getter/setter pair
- cropSizeHeight ↔ double
-
The height to crop the image by.
getter/setter pair
- cropSizeWidth ↔ double
-
The width to crop the image by.
getter/setter pair
- fullFrameScaleFactor ↔ double?
-
The scale factor of the full frame image.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- imageRotation ↔ int
-
The number to rotate the image by.
getter/setter pair
- isCamera2PreviewStreamingUsed ↔ bool
-
if the 2nd device camera should be used for preview streaming.
getter/setter pair
- isConvertToISOTemplate ↔ bool
-
Flag determines if the results should be converted to an ISO template.
getter/setter pair
- isEnhancedImageReturned ↔ bool
-
If the enhanced image is to be returned.
getter/setter pair
- isErrorOnNFIQ5Score ↔ bool
-
flag determines if an error should be raised for low nfiq5 scores.
getter/setter pair
- isFingerprintTemplateImageReturned ↔ bool
-
If the fingerprint template image should be returned.
getter/setter pair
- isFourFingerReticleUsed ↔ bool
-
Flag determines if the 4 finger reticle should be used.
getter/setter pair
- isFullFrameImageReturned ↔ bool
-
if the full frame image should be returned.
getter/setter pair
- isImageThreshold ↔ bool
-
If the image threshold should be set.
getter/setter pair
- isLoadingSpinnerShown ↔ bool
-
If the loading spinner should be shown.
getter/setter pair
- isManualCapture ↔ bool
-
If it's a manual capture.
getter/setter pair
- isNFIQMetrics ↔ bool
-
If NFIQ metrics are needed.
getter/setter pair
- isOnlyHighQualityImageReturned ↔ bool
-
flag determines if only high quality images should be returned.
getter/setter pair
- isOnyxLive ↔ bool
-
If onyx is live.
getter/setter pair
- isPerformQualityCheckMatch ↔ bool
-
Flag determines if a quality check match should be performed.
getter/setter pair
- isPGMFormatByteArrayReturned ↔ bool
-
The Pgm Format Byte Array flag
getter/setter pair
- isProcessedImageReturned ↔ bool
-
If the processed image is to be returned.
getter/setter pair
- isRawImageReturned ↔ bool
-
If the raw image is to be returned.
getter/setter pair
- isShutterSoundEnabled ↔ bool
-
if the shutter sound should be enabled.
getter/setter pair
- isThumbCapture ↔ bool
-
If the thumb is captured
getter/setter pair
- isUploadMetrics ↔ bool
-
Determines if the metrics should be uploaded.
getter/setter pair
- isUseFlash ↔ bool
-
flag detrmines if the flash should be on by default.
getter/setter pair
- isWSQImageReturned ↔ bool
-
If the WSQ image should be returned.
getter/setter pair
- layoutPreference ↔ LayoutPreference
-
the onyx layout preferences.
getter/setter pair
- lensFocusDistanceCamera2 ↔ double?
-
the lense focus distance for the 2nd camera.
getter/setter pair
- licenseKey ↔ String?
-
The onyx lisense key
getter/setter pair
- reticleAngle ↔ double?
-
The reticle angle.
This property overrides the value set by the reticleOrientation property.
getter/setter pair
- reticleOrientation ↔ ReticleOrientations
-
The reticle orientation.
This property is overridden by the reticleAngle property when it's set.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- targetPPI ↔ double?
-
The targeted pixels per inch.
Suggested values are around 500.0.
getter/setter pair
- thumbScaleFactor ↔ double?
-
the thumb scale factor.
getter/setter pair
- uniqueUserId ↔ String?
-
the unique id of the user. (null if not avaliable)
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toParams(
) → dynamic - returns the options as a serialized list.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited