OnyxOptions class - onyx library

Constructors

OnyxOptions.new()

Properties

captureFingersText ↔ String: Specify the name of the text that is displayed on screen to indicate to the user that they should hold their fingers steady, or keep them still during the capture. You can also use the Translations Editor to override the translations for the strings. See the Onyx Android Demo project for more information.
getter/setter pair
captureQualityThreshold ↔ double: Specify a double value between 0.0 - 1.0 to set the threshold for QualityNet to capture. Higher values mean higher image quality.
getter/setter pair
captureThumbText ↔ String: Specify the name of the text that is displayed on screen to indicate to the user that they should hold their thumb steady, or keep it still during the capture. You can also use the Translations Editor to override the translations for the strings. See the Onyx Android Demo project for more information.
getter/setter pair
computeNfiqMetrics ↔ bool: Specify to compute NFIQ metrics
getter/setter pair
cropFactor ↔ double: Specify the crop factor for the capture image. This has a built in scaling factor and this crop factor should be adjusted until you get an image that looks close to images that are known to match against whatever biometric system you are attempting to match against.
getter/setter pair
cropSizeHeight ↔ double: Specify the crop height for the capture image. This will determine the image dimensions in length and width for the resulting images. This should be set to whatever is required for the matching algorithm that is going to be used.
getter/setter pair
cropSizeWidth ↔ double: Specify the crop width for the capture image. This will determine the image dimensions in length and width for the resulting images. This should be set to whatever is required for the matching algorithm that is going to be used.
getter/setter pair
fingerDetectionTimeout ↔ int: Finger detection timeout in seconds (default is 60 seconds). This configuration option describes how long to wait before stopping the detection state machine. After waiting the specified time, the detection state machine will throw a NO_FINGERS_DETECTED OnyxError to the caller.
getter/setter pair
fingersNotInFocusText ↔ String: Specify the name of the text that is displayed on screen to indicate to the user that they should move their fingers until they are in focus. You can also use the Translations Editor to override the translations for the strings. See the Onyx Android Demo project for more information.
getter/setter pair
fullFrameMaxImageHeight ↔ double: Specify the maximum height for the FullFrame image to be returned, so for example, if you want a 1920 height image returned, pass in 1920.0f for the value. It will a full frame image resized to 1920 for the maximum height. To get the original height of the full frame, to get full resolution, pass in a value of 1.0f.
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
licenseKey ↔ String?: Specify the ONYX license key. @param licenseKey (required) the Onyx license key
getter/setter pair
manualCaptureText ↔ String: Specify the manual capture text that is displayed on screen.
getter/setter pair
reticleOrientation ↔ ReticleOrientation: Specify the orientation of the reticle Reticle.Orientation
getter/setter pair
returnEnhancedImage ↔ bool: Specify whether or not to return the enhanced image. This is a special image that works better with certain matching algorithms, but needs special testing to make sure it will match. Returned in the OnyxResult
getter/setter pair
returnFingerprintTemplate ↔ FingerprintTemplateType: Specify whether or not the capture task will return the specified com.dft.onyxcamera.config.OnyxConfiguration.FingerprintTemplateType in the OnyxResult The ISO template is the ISO/IEC 19794-4 standard minutiae based template The INNOVATRICS template is a proprietary fingerprint template that is highly scale tolerant and useful for touchless matching
getter/setter pair
returnFullFrameImage ↔ bool: Specify whether to return a FullFrame image. This returns an image that is suitable for finger detection in a full frame. Returned in the OnyxResult
getter/setter pair
returnOnyxErrorOnLowQuality ↔ bool: Specify to return OnyxError on low quality imagery
getter/setter pair
returnProcessedImage ↔ bool: Specify whether or not to return the processed image. This would be the most common image type to use for conversion to WSQ or for matching. Returned in the OnyxResult
getter/setter pair
returnRawImage ↔ bool: Specify whether or not to return the raw image. Returned in the OnyxResult
getter/setter pair
returnSlapImage ↔ bool: Specify whether or not to return a slap image. This contains all fingers captured within a single image as specified in the FBI EBTS format. Returned in the {@link OnyxResult}
getter/setter pair
returnSlapWSQ ↔ bool: Specify whether or not to return a slap WSQ. This contains all fingers captured within a single WSQ as specified in the FBI EBTS
getter/setter pair
returnWSQ ↔ bool: Specify whether or not to return the WSQ image. This will tell the SDK to return a WSQ image suitable for use in matching and other applications.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
shouldBinarizeProcessedImage ↔ bool: Specify whether or not to return the binarized processed fingerprint image in the OnyxResult
getter/setter pair
showLoadingSpinner ↔ bool: Specify that the spinner should be shown during OnyxConfiguration and during image processing.
getter/setter pair
subjectId ↔ String?: Specify the subject id
getter/setter pair
targetPixelsPerInch ↔ double: Specify target pixels per inch
getter/setter pair
thumbNotInFocusText ↔ String: Specify the name of the text that is displayed on screen to indicate to the user that they should move their thumb until it is in focus. You can also use the Translations Editor to override the translations for the strings. See the Onyx Android Demo project for more information.
getter/setter pair
uploadMetrics ↔ bool: For future use. Not currently implemented. Specify whether to upload capture metrics result. This will be used to improve ONYX capture and quality performance in the future.
getter/setter pair
useFlash ↔ bool: Specify to use the flash
getter/setter pair
useManualCapture ↔ bool: Specify the method of capture to be a manual capture of the fingerprint.
getter/setter pair
useOnyxLive ↔ bool: Specify to use ONYX LIVE_FINGER liveness detection as part of the configuration. This will take additional processing time.
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