Public Member Functions | |
| 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. The threshold parameters in this class are not set on the image capture view directly.
Constructor & Destructor Documentation
Member Function Documentation
| double getDefaultGlareThreshold | ( | ) |
Returns the default GlareThreshold
| double getGlareThreshold | ( | ) |
Returns the GlareThreshold
- See also
- setGlareThreshold(double)
| int getGlareTiltAngle | ( | ) |
Returns the Tilt angle
- See also
- setGlareTiltAngle(int)
| double getHoldSteadyDelay | ( | ) |
Returns the minimum duration in seconds the hold steady message should be shown before taking a picture.
The actual hold steady duration may vary depending on capture conditions, but it should not be less than passed value.
Valid values are in the range [0.0, 3.0]. Values outside of this range are interpreted as 0.0 or 3.0.
The default value is 1.0 (1 second).
| int getPitchThreshold | ( | ) |
Valid values are in the range [0, 45]. The default value is 15. A value of 45 disables level checking for pitch even if pitch threshold is enabled
- Returns
- int The pitch threshold value which needs to be met before taking a picture
| int getRollThreshold | ( | ) |
Valid values are in the range [0, 45]. A value of 45 disables level checking for roll.
- Returns
- int The roll threshold value which needs to be met before taking a picture
| int getStabilityThreshold | ( | ) |
If enabled the stability threshold is checked before taking a picture.
- Returns
- The stability value which needs to be met before taking a picture
| boolean isFocusEnabled | ( | ) |
- Returns
- boolean Whether the Focus constraint is enabled or not
- See also
- setFocusEnabled(boolean)
| boolean isGlareDetectionEnabled | ( | ) |
Returns a boolean whether the glare detection is enabled or not.
| boolean isLaunchGlareRemoverExperience | ( | ) |
Returns a boolean whether the launch glare experience is enabled or not.
| boolean isOrientationEnabled | ( | ) |
- Returns
- boolean Whether orientation constraint is enabled or not.
- See also
- setOrientationEnabled(boolean)
| boolean isPageDetectionEnabled | ( | ) |
- Returns
- boolean Whether the page detection constraint is enabled or not.
- See also
- setPageDetectionEnabled(boolean)
| boolean isPitchThresholdEnabled | ( | ) |
- Returns
- boolean Whether the pitch threshold is enabled or not
| boolean isRollThresholdEnabled | ( | ) |
- Returns
- boolean Whether the Roll threshold is enabled or not
| boolean isStabilityThresholdEnabled | ( | ) |
- Returns
- boolean Whether the stability threshold is enabled or not
| void setFocusEnabled | ( | boolean | focusEnabled | ) |
A boolean that indicates whether the Focus constraint is enabled. If enabled, this criterion is checked before taking a picture. The default value is true. Leaving it enabled is advisable. Otherwise it is highly likely that out of focus images are captured.
- Parameters
-
focusEnabled whether the Focus constraint is enabled or not
- See also
- isFocusEnabled()
| void setGlareDetectionEnabled | ( | boolean | enabled | ) |
Whether Glare Detection is enabled when using the capture experience.
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 | ) |
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 | ) |
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 angle of tilt for the second capture. The default value is 12, which indicates that the device's edge that is away from the user should stand higher than the device's edge that is closer to the user. Valid values are in the range [-20, 20].
- See also
- getGlareTiltAngle()
| void setHoldSteadyDelay | ( | double | seconds | ) |
Sets the minimum duration in seconds the hold steady message should be shown before taking a picture.
The actual hold steady duration may vary depending on capture conditions, but it should not be less than passed value.
Valid values are in the range [0.0, 3.0]. Values outside of this range are interpreted as 0.0 or 3.0.
The default value is 1.0 (1 second).
| void setLaunchGlareRemoverExperience | ( | boolean | launchGlareRemoverExperience | ) |
Whether glare experience should be launched.
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()
| void setOrientationEnabled | ( | boolean | enabled | ) |
Manages orientation constraint.
This constraint checks that the orientation of the document matches the orientation of the target frame.
Enabled by default.
- Parameters
-
enabled true to enable and false to disable.
- See also
- isOrientationEnabled()
| void setPageDetectionEnabled | ( | boolean | enabled | ) |
Manages page detection constraint.
This constraint checks that page is detected while capturing and it matches the target frame. It is responsible for the following guidances: center, zoomIn, zoomOut, rotate.
Enabled by default
- Parameters
-
enabled
- See also
- isPageDetectionEnabled()
| void setPitchThreshold | ( | int | pitchThreshold | ) |
If the pitch threshold constraint is enabled, and the device pitch is greater than the specified threshold, a picture will not be taken. Valid values are in the range [0, 45]. Values outside this range will throw KmcRuntimeException. The default value is 15. A value of 45 disables level checking for pitch.
- Parameters
-
pitchThreshold The pitch threshold value which needs to be met before taking a picture
- Exceptions
-
KmcRuntimeException
| void setPitchThresholdEnabled | ( | boolean | pitchThresholdEnabled | ) |
A boolean that specifies whether the level threshold for pitch enabled. If enabled, this criterion is checked before taking a picture. Default is enabled.
- Parameters
-
pitchThresholdEnabled Whether the pitch threshold is enabled or not
| void setRollThreshold | ( | int | rollThreshold | ) |
If the roll threshold constraint is enabled, and the device roll is greater than the specified threshold, a picture will not be taken. Valid values are in the range [0, 45]. Values outside this range will throw KmcRuntimeException. The default value is 15. A value of 45 disables level checking for roll.
- Parameters
-
rollThreshold The level threshold value for roll which needs to be met before taking a picture
- Exceptions
-
KmcRuntimeException
| void setRollThresholdEnabled | ( | boolean | rollThresholdEnabled | ) |
A boolean that specifies whether the level threshold for roll is enabled. If enabled, this criterion is checked before taking a picture. Default is enabled.
- Parameters
-
rollThresholdEnabled Whether the Roll threshold is enabled or not
| void setStabilityThreshold | ( | int | stabilityThreshold | ) |
If the stability threshold constraint is enabled, and the device stability is less than the specified threshold, a picture will not be taken. Valid values are in the range [0, 100], where 100 indicates that the device must be perfectly still to take a picture and 0 indicates that stability checking is turned off. Values outside this range will throw KmcRuntimeException. The default value is 15.
- Parameters
-
stabilityThreshold The stability value which needs to be met before taking a picture
| void setStabilityThresholdEnabled | ( | boolean | stabilityThresholdEnabled | ) |
A boolean that specifies whether the stability threshold is enabled. If enabled, this criterion is checked before taking a picture. Default is enabled.
- Parameters
-
stabilityThresholdEnabled Whether the stability threshold is enabled or not
The documentation for this class was generated from the following file: