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 the 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(CheckCaptureExperienceCriteriaHolder) method.
A photo will be taken automatically once the specified criteria are met, and takePicture() or takePictureContinually() has been called.
Note: CheckCaptureExperience 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 |
CheckCaptureExperience | ( | ImageCaptureView | view, |
CheckCaptureExperienceCriteriaHolder | criteria | ||
) |
Constructs an experience on a given ImageCaptureView with specific CheckCaptureExperienceCriteriaHolder
view | The ImageCaptureView this will be drawn onto |
criteria | The criteria used to determine if a photo should be taken |
CheckCaptureExperienceCriteriaHolder getCaptureCriteria | ( | ) |
Returns the criteria used to determine if a photo should be taken.
CaptureMessage getCenterMessage | ( | ) |
Returns the attributes of the message that is displayed when document is not enough centered in the target frame for capture.
Default configuration:
Bitmap getCheckSampleImage | ( | ) |
The Bitmap of a sample check that is displayed over the check frame area when the animated tutorial is enabled.
CaptureMessage getUserInstructionMessage | ( | ) |
Returns the attributes of the instruction message that is displayed on the capture control while the user is trying to capture. This instruction will be displayed during periods where other guidance is not available to correct a user. This may happen in particular when the user is holding a device far away from a document, preventing detection.
The following CaptureMessage property methods are not supported for this message: getMessageIcons() / setMessageIcons(Bitmap[]).
Default configuration:
void setCaptureCriteria | ( | CheckCaptureExperienceCriteriaHolder | 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 will be displayed when document is not centered in the target frame
centerMessage | The center message |
void setCheckSampleImage | ( | Bitmap | checkSampleImage | ) |
The specified Bitmap of a sample check is displayed over the check frame area when the animated tutorial is enabled. The sample check image is stretched if necessary to fill the entire check frame area. While the tutorial is running, MICR and guidance animation are superimposed over the image. A default check sample image is used if this is not set by the app.
checkSampleImage | The sample check image |
void setUserInstructionMessage | ( | CaptureMessage | userInstructionsMessage | ) |
A property to configure the attributes of the instruction message that is displayed on the capture control while user is trying to capture.
userInstructionsMessage | : CaptureMessage |