Inheritance diagram for CaptureExperienceCriteriaHolder:

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

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

See also: setPitchThreshold(int); setPitchThresholdEnabled(boolean); isPitchThresholdEnabled()

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

See also: setRollThreshold(int); setRollThresholdEnabled(boolean); isRollThresholdEnabled()

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()

boolean isFocusEnabled ( )

Returns: boolean Whether the Focus constraint is enabled or not. The default value is true.

See also: setFocusEnabled(boolean)

boolean isOrientationEnabled ( )

Checks if orientation constraint is enabled.

Returns: Whether the orientation constraint is enabled or not.

See also: setOrientationEnabled(boolean)

boolean isPitchThresholdEnabled ( )

Returns: boolean Whether the pitch threshold is enabled or not

See also: setPitchThresholdEnabled(boolean); setPitchThreshold(int); getPitchThreshold()

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)

boolean isRollThresholdEnabled ( )

Returns: boolean Whether the Roll threshold is enabled or not. Default is enabled.

See also: setRollThresholdEnabled(boolean); setRollThreshold(int); getRollThreshold()

boolean isStabilityThresholdEnabled ( )

Returns: boolean Whether the stability threshold is enabled or not. Default is enabled.

See also: setStabilityThresholdEnabled(boolean); setStabilityThreshold(int); getStabilityThreshold()

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 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()

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

See also: setPitchThresholdEnabled(boolean); getPitchThreshold(); isPitchThresholdEnabled()

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

See also: isPitchThresholdEnabled(); setPitchThreshold(int); getPitchThreshold()

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()

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

See also: getRollThreshold(); setRollThresholdEnabled(boolean); isRollThresholdEnabled()

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

See also: isRollThresholdEnabled(); setRollThreshold(int); getRollThreshold()

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

See also: setStabilityThresholdEnabled(boolean); isStabilityThresholdEnabled(); getStabilityThreshold()

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

See also: isStabilityThresholdEnabled(); setStabilityThreshold(int); getStabilityThreshold()

The documentation for this class was generated from the following file:

CaptureExperienceCriteriaHolder.java

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation