Kofax Mobile SDK API Reference
|
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 () |
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.
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
int getRollThreshold | ( | ) |
Valid values are in the range [0, 45]. The default value is 15. A value of 45 disables level checking for roll.
int getStabilityThreshold | ( | ) |
If enabled the stability threshold is checked before taking a picture. The default value is 15.
boolean isFocusEnabled | ( | ) |
boolean isOrientationEnabled | ( | ) |
Checks if orientation constraint is enabled.
boolean isPitchThresholdEnabled | ( | ) |
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
boolean isRollThresholdEnabled | ( | ) |
boolean isStabilityThresholdEnabled | ( | ) |
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.
focusEnabled | Whether the Focus constraint is enabled or not |
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.
enabled | true to enable and false to disable. |
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.
pitchThreshold | The pitch threshold value which needs to be met before taking a picture |
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.
pitchThresholdEnabled | Whether the pitch threshold is enabled or not |
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
enabled | Whether to refocus before taking a picture 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.
rollThreshold | The level threshold value for roll which needs to be met before taking a picture |
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.
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.
stabilityThreshold | The stability value which needs to be met before taking a picture |
KmcRuntimeException |
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.
stabilityThresholdEnabled | Whether the stability threshold is enabled or not |