Public Member Functions | |
| PassportCaptureExperienceCriteriaHolder () | |
| PassportCaptureExperienceCriteriaHolder (PassportCaptureExperienceCriteriaHolder criteria) | |
| void | setDetectionSettings (PassportDetectionSettings detectionSettings) |
| PassportDetectionSettings | getPassportDetectionSettings () |
| boolean | isGlareDetectionEnabled () |
| void | setGlareDetectionEnabled (boolean enabled) |
| void | setLaunchGlareRemoverExperience (boolean launchGlareRemoverExperience) |
| boolean | isLaunchGlareRemoverExperience () |
| int | getGlareTiltAngle () |
| void | setGlareTiltAngle (int angle) |
| void | setGlareThreshold (double glareThreshold) |
| double | getGlareThreshold () |
 Public Member Functions inherited from DocumentBaseCaptureExperienceCriteriaHolder | |
| DocumentBaseCaptureExperienceCriteriaHolder () | |
| boolean | isStabilityThresholdEnabled () |
| void | setStabilityThresholdEnabled (boolean stabilityThresholdEnabled) |
| int | getStabilityThreshold () |
| void | setStabilityThreshold (int stabilityThreshold) |
| boolean | isPitchThresholdEnabled () |
| void | setPitchThresholdEnabled (boolean pitchThresholdEnabled) |
| int | getPitchThreshold () |
| void | setPitchThreshold (int pitchThreshold) |
| boolean | isRollThresholdEnabled () |
| void | setRollThresholdEnabled (boolean rollThresholdEnabled) |
| int | getRollThreshold () |
| void | setRollThreshold (int rollThreshold) |
| boolean | isFocusEnabled () |
| void | setFocusEnabled (boolean focusEnabled) |
| boolean | isOrientationEnabled () |
| void | setOrientationEnabled (boolean enabled) |
| void | setHoldSteadyDelay (double seconds) |
| Sets the minimum duration in seconds the hold steady message should be shown before taking a picture. More... | |
| double | getHoldSteadyDelay () |
| Returns the minimum duration in seconds the hold steady message should be shown before taking a picture. More... | |
| void | setPageDetectionEnabled (boolean enabled) |
| Manages page detection constraint. More... | |
| boolean | isPageDetectionEnabled () |
| void | setGlareDetectionEnabled (boolean enabled) |
| boolean | isGlareDetectionEnabled () |
| void | setLaunchGlareRemoverExperience (boolean launchGlareRemoverExperience) |
| Whether glare experience should be launched. More... | |
| boolean | isLaunchGlareRemoverExperience () |
| void | setGlareTiltAngle (int angle) |
| int | getGlareTiltAngle () |
| void | setGlareThreshold (double glareThreshold) |
| double | getGlareThreshold () |
| double | getDefaultGlareThreshold () |
| Public Member Functions inherited from CaptureExperienceCriteriaHolder | |
| CaptureExperienceCriteriaHolder () | |
| boolean | isStabilityThresholdEnabled () |
| void | setStabilityThresholdEnabled (boolean stabilityThresholdEnabled) |
| int | getStabilityThreshold () |
| void | setStabilityThreshold (int stabilityThreshold) |
| boolean | isPitchThresholdEnabled () |
| void | setPitchThresholdEnabled (boolean pitchThresholdEnabled) |
| int | getPitchThreshold () |
| void | setPitchThreshold (int pitchThreshold) |
| boolean | isRollThresholdEnabled () |
| void | setRollThresholdEnabled (boolean rollThresholdEnabled) |
| int | getRollThreshold () |
| void | setRollThreshold (int rollThreshold) |
| boolean | isFocusEnabled () |
| void | setFocusEnabled (boolean focusEnabled) |
| boolean | isOrientationEnabled () |
| void | setOrientationEnabled (boolean enabled) |
| void | setRefocusEnabled (boolean enabled) |
| boolean | isRefocusBeforeCaptureEnabled () |
Detailed Description
This class allows all of the capture related parameters to be configured.
Constructor & Destructor Documentation
Member Function Documentation
| double getGlareThreshold | ( | ) |
Not supported. Returns the default value.
Returns the GlareThreshold
- See also
- setGlareThreshold(double)
| int getGlareTiltAngle | ( | ) |
| PassportDetectionSettings getPassportDetectionSettings | ( | ) |
- Returns
- the passport detection settings
| boolean isGlareDetectionEnabled | ( | ) |
Not supported. Returns the default value false
Returns a boolean whether the glare detection is enabled or not.
| boolean isLaunchGlareRemoverExperience | ( | ) |
Not supported. Returns the default value
Returns a boolean whether the launch glare experience is enabled or not.
| void setDetectionSettings | ( | PassportDetectionSettings | detectionSettings | ) |
Sets the passport detection settings.
- Parameters
-
detectionSettings the document detection settings
| void setGlareDetectionEnabled | ( | boolean | enabled | ) |
Not supported. Setting this property do nothing.
A boolean that indicates whether the glare detection is enabled. If enabled,
This criteria is checked after taking a picture and user would be asked to do one more capture by tilting the device if a glare is detected. User can use "takePicture" on capture experience to capture glare free image. And also can use "takePictureContinuously" to capture glare free images continuously. Default value is NO.
- See also
- isGlareDetectionEnabled()
| void setGlareThreshold | ( | double | glareThreshold | ) |
Not supported. Setting this property do nothing.
The reference threshold that indicates how much glare fraction should be configured on the captured Image. Configuring the Glare Threshold value will control the launch of second capture experience(Tilt capture) when setGlareDetectionEnabled(boolean) is set to true. The default value is 0.018, we recommend setting this threshold to 0.012 for ID Card's on the below Build.MODEL for better identification of glare fraction.
LG-H815
Moto G (5S) Plus
ONEPLUS A6000
MotoG3
LG-E975
Valid values are in the range [0, 1].
- See also
- getGlareThreshold()
| void setGlareTiltAngle | ( | int | angle | ) |
Not supported. Setting this property do nothing.
The reference angle that indicates how much should the device be tilted for the second capture A property to get or set an angle in degrees that will be used to determine the device tiltness for the second capture. The default value is 12. A positive value indicates that the top of the device should be higher than the bottom for the device to be considered level. Valid values are in the range [-20, 20].
- See also
- getGlareTiltAngle()
| void setLaunchGlareRemoverExperience | ( | boolean | launchGlareRemoverExperience | ) |
Not supported. Setting this property do nothing.
A boolean that indicates whether the glare experience is enabled. If enabled, user would be guided to capture two images of the document at different tilt angles. User can use "takePicture" on capture experience to capture glare free image. And also can use "takePictureContinuously" to capture glare free images continuously. Default value is false.
- See also
- isLaunchGlareRemoverExperience()
The documentation for this class was generated from the following file: