Kofax Mobile SDK API Reference
|
Additional Inherited Members | |
Protected Member Functions inherited from DocumentBaseCaptureExperience | |
void | initBase (ImageCaptureView view, IDetectionAdapter adapter, DocumentBaseCaptureExperienceCriteriaHolder criteria) |
Protected Member Functions inherited from CaptureExperience | |
void | invokeImageCapturedListeners (ImageCapturedEvent event) |
boolean | captureCriteriaMetInternal (CaptureExperienceData data) |
Protected Attributes inherited from DocumentBaseCaptureExperience | |
Context | _ctx |
Protected Attributes inherited from CaptureExperience | |
CaptureExperienceData | _captureExperienceData = new CaptureExperienceData() |
final Object | _lock |
boolean | _sdkCaptureRequested |
boolean | _continuousCapture |
ImageCaptureView | _imageCaptureView |
final Handler | _uiHandler = new Handler(Looper.getMainLooper()) |
float | _aspectRatio |
Set< ImageCapturedListener > | _imageCapturedListeners = new LinkedHashSet<ImageCapturedListener>() |
Vibrator | _vibrator |
boolean | _vibrationEnabled = false |
This class is responsible for rendering an enhanced visual experience on an ImageCaptureView and provides feedback to guide the user to take a clear, legible and optimally zoomed in photo of a document. Criteria of such a document can be specified by using a setCaptureCriteria(FixedAspectRatioExperienceCriteriaHolder) method.
A photo will be taken automatically once the specified criteria are met, and takePicture() or takePictureContinually() has been called.
We recommend to use this experience for ID capture and Credit cards capture.
Note: FixedAspectRatioCaptureExperience is best used on a view that occupies the maximum possible area of its parent view.
Constructs an experience on a given ImageCaptureView.
view | The ImageCaptureView this will be drawn onto |
FixedAspectRatioCaptureExperience | ( | ImageCaptureView | view, |
FixedAspectRatioExperienceCriteriaHolder | criteria | ||
) |
Constructs an experience on a given ImageCaptureView with specific FixedAspectRatioExperienceCriteriaHolder
view | The ImageCaptureView this will be drawn onto |
criteria | The criteria used to determine if a photo should be taken |
FixedAspectRatioExperienceCriteriaHolder getCaptureCriteria | ( | ) |
Returns the criteria used to determine if a photo should be taken.
CaptureMessage getCapturedMessage | ( | ) |
Returns the attributes of the message that will be displayed when a document is captured.
Default configuration:
CaptureMessage getHoldParallelMessage | ( | ) |
Returns the attributes of the message that will be displayed when the capture experience needs to instruct the user to hold the device more level.
The levelness thresholds can be set using the CaptureExperienceCriteriaHolder#setPitchThreshold(int) and CaptureExperienceCriteriaHolder#setRollThreshold(int) methods.
Default configuration:
CaptureMessage getHoldSteadyMessage | ( | ) |
Returns the attributes of the message that is displayed on the capture control to direct the user to hold the device steady so that a clear focused image can be captured. This message is shown when all the constraints are met and ready to capture.
Default configuration:
void setCaptureCriteria | ( | FixedAspectRatioExperienceCriteriaHolder | criteria | ) |
Calling this method will cause all of the capture related parameters to be configured
criteria | The criteria used to determine if a photo should be taken |
void setCenterMessage | ( | CaptureMessage | centerMessage | ) |
This instruction is not supported, always set to invisible.
centerMessage | : CaptureMessage |
void setRotateMessage | ( | CaptureMessage | message | ) |
This instruction is not supported, always set to invisible.
message | CaptureMessage |
void setZoomInMessage | ( | CaptureMessage | zoomInMessage | ) |
This instruction is not supported, always set to invisible.
zoomInMessage | : CaptureMessage |
void setZoomOutMessage | ( | CaptureMessage | zoomOutMessage | ) |
This instruction is not supported, always set to invisible.
zoomOutMessage | : CaptureMessage |