Kofax Mobile SDK API Reference
Public Member Functions | List of all members
FixedAspectRatioExperienceCriteriaHolder Class Reference
Inheritance diagram for FixedAspectRatioExperienceCriteriaHolder:
DocumentBaseCaptureExperienceCriteriaHolder CaptureExperienceCriteriaHolder

Public Member Functions

 FixedAspectRatioExperienceCriteriaHolder ()
 
void setDetectionSettings (FixedAspectRatioDetectionSettings detectionSettings)
 
FixedAspectRatioDetectionSettings getDetectionSettings ()
 
boolean isOrientationEnabled ()
 
void setOrientationEnabled (boolean enabled)
 
- 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 ()
 
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.

Constructor & Destructor Documentation

Member Function Documentation

FixedAspectRatioDetectionSettings getDetectionSettings ( )

Returns the Fixed Aspect Ratio detection settings.

Returns
the Fixed Aspect Ratio detection settings
boolean isOrientationEnabled ( )

Not supported. Setting this property do nothing.

Returns
Returns
true
whatever was set.
See also
setOrientationEnabled(boolean)
void setDetectionSettings ( FixedAspectRatioDetectionSettings  detectionSettings)

Sets the Fixed Aspect Ratio detection settings.

Parameters
detectionSettingsthe Fixed Aspect Ratio detection settings
void setOrientationEnabled ( boolean  enabled)

Not supported. Setting this property do nothing.

Parameters
enabledtrue to enable and false to disable.
See also
isOrientationEnabled()

The documentation for this class was generated from the following file:
Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.