Public Member Functions | |
| 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 criteria are met before a picture is taken. The threshold parameters in this class are not set on the image capture view directly.
Constructor & Destructor Documentation
◆ CaptureExperienceCriteriaHolder()
Member Function Documentation
◆ getPitchThreshold()
| 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
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
◆ getRollThreshold()
| int getRollThreshold | ( | ) |
Valid values are in the range [0, 45]. The default value is 15. A value of 45 disables level checking for roll.
- Returns
- int The roll threshold value which needs to be met before taking a picture
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
◆ getStabilityThreshold()
| int getStabilityThreshold | ( | ) |
If enabled the stability threshold is checked before taking a picture. The default value is 15.
- Returns
- The stability value which needs to be met before taking a picture
- See also
- setStabilityThreshold(int)
- setStabilityThresholdEnabled(boolean)
- isStabilityThresholdEnabled()
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
◆ isFocusEnabled()
| boolean isFocusEnabled | ( | ) |
- Returns
- boolean Whether the Focus constraint is enabled or not. The default value is true.
- See also
- setFocusEnabled(boolean)
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
◆ isOrientationEnabled()
| boolean isOrientationEnabled | ( | ) |
Checks if orientation constraint is enabled.
- Returns
- Whether the orientation constraint is enabled or not.
- See also
- setOrientationEnabled(boolean)
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder, and FixedAspectRatioExperienceCriteriaHolder.
◆ isPitchThresholdEnabled()
| boolean isPitchThresholdEnabled | ( | ) |
- Returns
- boolean Whether the pitch threshold is enabled or not
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
◆ isRefocusBeforeCaptureEnabled()
| boolean isRefocusBeforeCaptureEnabled | ( | ) |
Checks if refocusing is made before taking a picture. This indicates whether the camera needs to be refocused just before taking a picture when all other capture criteria are met. Default: true
- Returns
- Whether to refocus before taking a picture or not.
- See also
- setRefocusEnabled(boolean)
◆ isRollThresholdEnabled()
| boolean isRollThresholdEnabled | ( | ) |
- Returns
- boolean Whether the Roll threshold is enabled or not. Default is enabled.
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
◆ isStabilityThresholdEnabled()
| boolean isStabilityThresholdEnabled | ( | ) |
- Returns
- boolean Whether the stability threshold is enabled or not. Default is enabled.
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
◆ setFocusEnabled()
| 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()
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
◆ setOrientationEnabled()
| void setOrientationEnabled | ( | boolean | enabled | ) |
Enables or disables 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()
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder, and FixedAspectRatioExperienceCriteriaHolder.
◆ setPitchThreshold()
| 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
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
◆ setPitchThresholdEnabled()
| 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
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
◆ setRefocusEnabled()
| void setRefocusEnabled | ( | boolean | enabled | ) |
Enables or disables refocusing before taking a picture. This indicates whether the camera needs to be refocused just before taking a picture when all other capture criteria are met. Default: true
- Parameters
-
enabled Whether to refocus before taking a picture or not.
- See also
- isRefocusBeforeCaptureEnabled()
◆ setRollThreshold()
| 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
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
◆ setRollThresholdEnabled()
| 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
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
◆ setStabilityThreshold()
| 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
- Exceptions
-
KmcRuntimeException
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
◆ setStabilityThresholdEnabled()
| 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
Reimplemented in DocumentBaseCaptureExperienceCriteriaHolder.
The documentation for this class was generated from the following file: