Atalasoft MobileImage API Reference
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience Class Referenceabstract

This class is a base class for the DocumentCaptureExperience and CheckCaptureExperience. More...

Inheritance diagram for com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience:
com.kofax.kmc.kui.uicontrols.StabilityDelayListener com.kofax.kmc.kui.uicontrols.LevelnessListener com.kofax.kmc.kui.uicontrols.AutoFocusResultListener com.kofax.kmc.kui.uicontrols.ImageCapturedListener com.kofax.kmc.kui.uicontrols.captureanimations.DocumentBaseCaptureExperience com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperience com.kofax.kmc.kui.uicontrols.captureanimations.DocumentCaptureExperience

Public Member Functions

void addOnImageCapturedListener (ImageCapturedListener listener)
 
void removeOnImageCapturedListener (ImageCapturedListener listener)
 
void setVibrationEnabled (boolean enable)
 
boolean isVibrationEnabled ()
 
void takePicture ()
 
void takePictureContinually ()
 
void stopCapture ()
 
void onImageCaptured (ImageCapturedEvent event)
 Invoked when the camera captures an image. More...
 
void onAutoFocus (AutoFocusResultEvent event)
 Invoked when the camera completes focusing. More...
 
void onLevelness (LevelnessEvent event)
 Invoked when the orientation of the device changes. More...
 
void onStabilityDelay (StabilityDelayEvent event)
 Invoked when stability levels change. More...
 
void destroy ()
 

Protected Member Functions

void invokeImageCapturedListeners (ImageCapturedEvent event)
 
boolean captureCriteriaMetInternal (CaptureExperienceData data)
 

Protected Attributes

CaptureExperienceData _captureExperienceData = new CaptureExperienceData()
 
final Object _lock
 
boolean _sdkCaptureRequested
 
boolean _continuousCapture
 
ImageCaptureView _imageCaptureView
 
final Handler _uiHandler = new Handler(Looper.getMainLooper())
 
boolean _continuousReset
 
float _aspectRatio
 
Set< ImageCapturedListener_imageCapturedListeners = new LinkedHashSet<ImageCapturedListener>()
 
Vibrator _vibrator
 
boolean _vibrationEnabled = false
 

Detailed Description

This class is a base class for the DocumentCaptureExperience and CheckCaptureExperience.

This class is responsible for capturing documents once the given criteria is met, except page detection

Member Function Documentation

void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.addOnImageCapturedListener ( ImageCapturedListener  listener)
inline

Invoked after the camera captures an image and when all capture messages were shown. To allow for every message to be played, this method should be used to set an ImageCapturedListener instead of the method on the ImageCaptureView class.

Parameters
listenerThe image captured listener
See also
ImageCapturedListener
boolean com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.captureCriteriaMetInternal ( CaptureExperienceData  data)
inlineprotected
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.destroy ( )
inline

Detaches from the ImageCaptureView and destroys this experience.

void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.invokeImageCapturedListeners ( ImageCapturedEvent  event)
inlineprotected
boolean com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.isVibrationEnabled ( )
inline
Returns
Whether vibration availability during capturing
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.onAutoFocus ( AutoFocusResultEvent  event)
inline

Invoked when the camera completes focusing.

Implements com.kofax.kmc.kui.uicontrols.AutoFocusResultListener.

void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.onImageCaptured ( ImageCapturedEvent  event)
inline

Invoked when the camera captures an image.

Implements com.kofax.kmc.kui.uicontrols.ImageCapturedListener.

void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.onLevelness ( LevelnessEvent  event)
inline

Invoked when the orientation of the device changes.

Implements com.kofax.kmc.kui.uicontrols.LevelnessListener.

void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.onStabilityDelay ( StabilityDelayEvent  event)
inline

Invoked when stability levels change.

Implements com.kofax.kmc.kui.uicontrols.StabilityDelayListener.

void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.removeOnImageCapturedListener ( ImageCapturedListener  listener)
inline

Remove ImageCapturedListener.

Parameters
listenerThe image captured listener
See also
ImageCapturedListener
addOnImageCapturedListener(ImageCapturedListener)
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.setVibrationEnabled ( boolean  enable)
inline

Method to manage vibration availability during capturing.

Parameters
enableWhether to vibrate during capture
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.stopCapture ( )
inline

This is the counterpart to takePicture() and takePictureContinually(). Calling this method will stop automatic image capture when the criteria are satisfied.

See also
takePicture()
takePictureContinually()
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.takePicture ( )
inline

Calling this method will start the process of monitoring the capture criteria that was configured to determine when a document that meets all the criteria can be captured. The static frame will change its color to green to indicate that a document will be captured soon.

void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience.takePictureContinually ( )
inline

Calling this method will start the continuous capture of images. Images will automatically be captured when criteria are satisfied. Between each image capture event, the device must be tilted away from its set device declination. This signals the device to capture a new image when criteria are again satisfied.

Member Data Documentation

float com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience._aspectRatio
protected
CaptureExperienceData com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience._captureExperienceData = new CaptureExperienceData()
protected
boolean com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience._continuousCapture
protected
boolean com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience._continuousReset
protected
Set<ImageCapturedListener> com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience._imageCapturedListeners = new LinkedHashSet<ImageCapturedListener>()
protected
ImageCaptureView com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience._imageCaptureView
protected
final Object com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience._lock
protected
boolean com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience._sdkCaptureRequested
protected
final Handler com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience._uiHandler = new Handler(Looper.getMainLooper())
protected
boolean com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience._vibrationEnabled = false
protected
Vibrator com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience._vibrator
protected

The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.