Inheritance diagram for CheckCaptureExperienceCriteriaHolder:

Public Member Functions
	CheckCaptureExperienceCriteriaHolder ()

void	setCheckDetectionSettings (CheckDetectionSettings detectionSettings)

CheckDetectionSettings	getCheckDetectionSettings ()

boolean	isGlareDetectionEnabled ()

void	setGlareDetectionEnabled (boolean enabled)

void	setLaunchGlareRemoverExperience (boolean launchGlareRemoverExperience)

boolean	isLaunchGlareRemoverExperience ()

int	getGlareTiltAngle ()

void	setGlareTiltAngle (int angle)

void	setGlareThreshold (double glareThreshold)

double	getGlareThreshold ()

double	getDefaultGlareThreshold ()

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

Public Member Functions inherited from CaptureExperienceCriteriaHolder
	CaptureExperienceCriteriaHolder ()

void	setRefocusEnabled (boolean enabled)

boolean	isRefocusBeforeCaptureEnabled ()

Detailed Description

This class allows all of the capture related parameters to be configured.

Constructor & Destructor Documentation

◆ CheckCaptureExperienceCriteriaHolder()

CheckCaptureExperienceCriteriaHolder ( )

Member Function Documentation

◆ getCheckDetectionSettings()

CheckDetectionSettings getCheckDetectionSettings ( )

Returns: The settings for controlling the detector object

See also: CheckDetectionSettings

◆ getDefaultGlareThreshold()

double getDefaultGlareThreshold ( )

Not supported. Returns the default value.

Always returns the SDK default GlareThreshold

Reimplemented from DocumentBaseCaptureExperienceCriteriaHolder.

◆ getGlareThreshold()

double getGlareThreshold ( )

Not supported. Returns the default value.

Returns the GlareThreshold which was set by user.

See also: setGlareThreshold(double)

Reimplemented from DocumentBaseCaptureExperienceCriteriaHolder.

◆ getGlareTiltAngle()

int getGlareTiltAngle ( )

Not supported. Returns the default value

Returns the Tilt angle

See also: setGlareTiltAngle(int)

Reimplemented from DocumentBaseCaptureExperienceCriteriaHolder.

◆ isGlareDetectionEnabled()

boolean isGlareDetectionEnabled ( )

Not supported. Returns the default value false

Returns a boolean whether the glare detection is enabled or not.

See also: setGlareDetectionEnabled(boolean)

Reimplemented from DocumentBaseCaptureExperienceCriteriaHolder.

◆ isLaunchGlareRemoverExperience()

boolean isLaunchGlareRemoverExperience ( )

Not supported. Returns the default value

Returns a boolean whether the launch glare experience is enabled or not.

See also: setLaunchGlareRemoverExperience(boolean)

Reimplemented from DocumentBaseCaptureExperienceCriteriaHolder.

◆ setCheckDetectionSettings()

void setCheckDetectionSettings ( CheckDetectionSettings detectionSettings )

Parameters

detectionSettings The settings for controlling the detector object

See also: CheckDetectionSettings

◆ setGlareDetectionEnabled()

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

Reimplemented from DocumentBaseCaptureExperienceCriteriaHolder.

◆ setGlareThreshold()

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.

See also: getDefaultGlareThreshold(); getGlareThreshold()

Reimplemented from DocumentBaseCaptureExperienceCriteriaHolder.

◆ setGlareTiltAngle()

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

Reimplemented from DocumentBaseCaptureExperienceCriteriaHolder.

◆ setLaunchGlareRemoverExperience()

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.