Kofax Mobile SDK API Reference
Properties | List of all members
KFXFixedAspectRatioCaptureExperienceCriteriaHolder Class Reference

This class allows the Fixed Aspect Ratio detection related criteria to be configured. More...

#import <KFXFixedAspectRatioCaptureExperienceCriteriaHolder.h>

Inheritance diagram for KFXFixedAspectRatioCaptureExperienceCriteriaHolder:
kfxKUIDocumentBaseCaptureExperienceCriteriaHolder kfxKUICaptureExperienceCriteriaHolder

Properties

KFXFixedAspectRatioDetectionSettingsfarDetectionSettings
 Fixed Aspect Ratio detection settings object. More...
 
BOOL pitchThresholdEnabled
 Whether the Pitch threshold is enabled. More...
 
BOOL rollThresholdEnabled
 Whether the Roll threshold is enabled. More...
 
BOOL pageOrientationEnabled
 Whether to detect if the orientation of page results in optimum overlap of page and ImageCaptureControl. More...
 
- Properties inherited from kfxKUICaptureExperienceCriteriaHolder
BOOL stabilityThresholdEnabled
 Whether the stability threshold is enabled. More...
 
int stabilityThreshold
 The stability threshold value. More...
 
BOOL pitchThresholdEnabled
 Whether the Pitch threshold is enabled. More...
 
int pitchThreshold
 The Pitch threshold value. More...
 
BOOL rollThresholdEnabled
 Whether the Roll threshold is enabled. More...
 
int rollThreshold
 The Roll threshold value. More...
 
BOOL glareDetectionEnabled
 
BOOL launchGlareRemoverExperience
 Whether glare experience should be launched. More...
 
int tiltAngle
 The reference angle that indicates how much should the device be tilted for the second capture. More...
 
double glareThreshold
 The reference threshold that indicates how much glare fraction should be configured on the captured Image. More...
 
double defaultGlareThreshold
 The default threshold for the glareThreshold property. More...
 
BOOL focusConstraintEnabled
 Whether the Focus constraint is enabled. More...
 
BOOL pageOrientationEnabled
 Whether to detect if the orientaion of page results in optimum overlap of page and Imagecapturecontrol. More...
 
BOOL refocusBeforeCaptureEnabled
 Whether to refocus before taking a picture. More...
 
NSTimeInterval holdSteadyDelay
 The delay for how long hold steady message should be shown before starting the capture. More...
 
BOOL pageDetectionEnabled
 Whether the page detection constraint is enabled. More...
 

Detailed Description

This class allows the Fixed Aspect Ratio detection related criteria to be configured.

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

Property Documentation

- (KFXFixedAspectRatioDetectionSettings*) farDetectionSettings
readwritenonatomicstrong

Fixed Aspect Ratio detection settings object.

A collection of values that control the behavior of Fixed Aspect Ratio capture experience. Pass nil for the experience of default setting.

- (BOOL) pageOrientationEnabled
readwritenonatomicassign

Whether to detect if the orientation of page results in optimum overlap of page and ImageCaptureControl.

Not supported. Setting this property do nothing. Returns NO whatever is set.

- (BOOL) pitchThresholdEnabled
readwritenonatomicassign

Whether the Pitch threshold is enabled.

A boolean that indicates whether the Pitch threshold is enabled. If enabled this criteria is checked before taking a picture. By default is OFF.

- (BOOL) rollThresholdEnabled
readwritenonatomicassign

Whether the Roll threshold is enabled.

A boolean that indicates whether the Roll threshold is enabled. If enabled this criteria is checked before taking a picture. By default is OFF.


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.