Atalasoft MobileImage API Reference
Classes | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
com.kofax.kmc.kui.uicontrols.ImageCaptureView Class Reference
Inheritance diagram for com.kofax.kmc.kui.uicontrols.ImageCaptureView:
com.kofax.kmc.kui.uicontrols.BarCodeCaptureView

Public Member Functions

 ImageCaptureView (Context context)
 
 ImageCaptureView (Context context, AttributeSet set)
 
 ImageCaptureView (Context context, AttributeSet set, int defStyle)
 
final void takePicture ()
 
final ImageCaptureFrame getImageCaptureFrame ()
 
final void setImageCaptureFrame (ImageCaptureFrame imageCaptureFrame)
 
final int getImagePreviewWidth ()
 
final int getImagePreviewHeight ()
 
final int getStabilityDelay ()
 
final void setStabilityDelay (int stabilityDelay)
 
final PageDetectMode getPageDetectMode ()
 
final void setPageDetectMode (PageDetectMode mode)
 
ViewGroup getViewGroup ()
 
final int getPageAreaForDetection ()
 
final void setPageAreaForDetection (int threshold)
 
final Flash getFlash ()
 
final void setFlash (Flash flash)
 
final boolean isFlashSupported (Flash flash)
 
final GpsUsageLimits getGpsUsage ()
 
final void setGpsUsage (GpsUsageLimits limits)
 
final int getLevelThresholdPitch ()
 
final void setLevelThresholdPitch (int threshold)
 
final int getLevelThresholdRoll ()
 
final void setLevelThresholdRoll (int threshold)
 
final void setImageResolution (android.hardware.Camera.Size resolution)
 
final List< android.hardware.Camera.Size > getAllowableResolutions ()
 
final List< Rect > getFocusAreas ()
 
final void setFocusAreas (List< Rect > focusAreas) throws KmcRuntimeException
 
final int getMaxFocusAreas ()
 
final boolean getUseVideoFrame ()
 
final void setUseVideoFrame (boolean useVideo)
 
final int getDeviceDeclinationPitch ()
 
final void setDeviceDeclinationPitch (int angle)
 
final int getDeviceDeclinationRoll ()
 
final void setDeviceDeclinationRoll (int angle)
 
final int getLuminanceThreshold ()
 
final void setLuminanceThreshold (int luminanceThreshold)
 
final int getTorchDelay ()
 
final void setTorchDelay (int torchDelay)
 
final void muteAutoTorch ()
 
final void unmuteAutoTorch ()
 
final void forceTakePicture ()
 
final void forceTakePicture (boolean focusAgain)
 
final void doContinuousMode (boolean start)
 
final synchronized void sessionCreate ()
 
final synchronized void sessionDismiss ()
 
final void addOnAutoFocusResultListener (AutoFocusResultListener listener)
 
final void removeOnAutoFocusResultListener (AutoFocusResultListener listener)
 
final void addOnImageCapturedListener (ImageCapturedListener listener)
 
final void removeOnImageCapturedListener (ImageCapturedListener listener)
 
final void addStabilityDelayListener (StabilityDelayListener listener)
 
final void removeStabilityDelayListener (StabilityDelayListener listener)
 
final void addLevelnessListener (LevelnessListener listener)
 
final void removeLevelnessListener (LevelnessListener listener)
 
final void addPageDetectionListener (PageDetectionListener listener)
 
final void removePageDetectionListener (PageDetectionListener listener)
 
final void addCameraInitializationListener (CameraInitializationListener listener)
 
final void removeCameraInitializationListener (CameraInitializationListener listener)
 
final void addCameraInitializationFailedListener (CameraInitializationFailedListener listener)
 
final void removeCameraInitializationFailedListener (CameraInitializationFailedListener listener)
 
final void addPreviewCallbackListener (PreviewCallbackListener listener)
 
final void removePreviewCallbackListener (PreviewCallbackListener listener)
 
final void addTorchLuminanceListener (TorchLuminanceListener listener)
 
final void removeTorchLuminanceListener (TorchLuminanceListener listener)
 
void removeAllViews ()
 
void surfaceChanged (SurfaceHolder holder, int format, int width, int height)
 
void surfaceCreated (SurfaceHolder holder)
 
void surfaceDestroyed (SurfaceHolder holder)
 

Static Public Attributes

static final int DEFAULT_LUMINANCE_THRESHOLD = 100
 
static final int DEFAULT_STABILITY_DELAY_THRESHOLD = 75
 
static final int DEFAULT_TORCH_DELAY = 3
 

Protected Member Functions

void checkLicense ()
 
void onLayout (boolean changed, int l, int t, int r, int b)
 
void onDetachedFromWindow ()
 
void onAttachedToWindow ()
 

Protected Attributes

IBus _bus
 

Detailed Description

This class is responsible for rendering the camera preview.

Constructor & Destructor Documentation

com.kofax.kmc.kui.uicontrols.ImageCaptureView.ImageCaptureView ( Context  context)
inline
com.kofax.kmc.kui.uicontrols.ImageCaptureView.ImageCaptureView ( Context  context,
AttributeSet  set 
)
inline
com.kofax.kmc.kui.uicontrols.ImageCaptureView.ImageCaptureView ( Context  context,
AttributeSet  set,
int  defStyle 
)
inline

Member Function Documentation

final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.addCameraInitializationFailedListener ( CameraInitializationFailedListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.addCameraInitializationListener ( CameraInitializationListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.addLevelnessListener ( LevelnessListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.addOnAutoFocusResultListener ( AutoFocusResultListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.addOnImageCapturedListener ( ImageCapturedListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.addPageDetectionListener ( PageDetectionListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.addPreviewCallbackListener ( PreviewCallbackListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.addStabilityDelayListener ( StabilityDelayListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.addTorchLuminanceListener ( TorchLuminanceListener  listener)
inline
void com.kofax.kmc.kui.uicontrols.ImageCaptureView.checkLicense ( )
inlineprotected
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.doContinuousMode ( boolean  start)
inline

Description: Calling this method will start or stop the continuous capture of images. Images will be automatically captured when levelness and stability 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 levelness and stability criteria are again satisfied. It is possible to call this method to enable or disable continuous mode at any time before or after surface creation. If continuous mode is disabled, a call to takePicture() is required before this view will request a photo from the camera.

Defaults to false.

Parameters
startWhen true, continuous mode will be enabled.
See also
takePicture()
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.forceTakePicture ( )
inline

Description: Forces capturing an image. Calling this method will ignore other capture constraints. This is equivalent to calling forceTakePicture(false);

NOTE: Capture will not take place while an autofocus cycle is running, but will happen once it completes, whether the camera is in focus or not.

See also
takePicture()
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.forceTakePicture ( boolean  focusAgain)
inline

Description: Forces capturing an image after an optional additional autofocus cycle. Calling this method will ignore other capture constraints.

NOTE: Capture will not take place while an autofocus cycle is running, but will happen once it completes, whether the camera is in focus or not.

See also
takePicture()
final List<android.hardware.Camera.Size> com.kofax.kmc.kui.uicontrols.ImageCaptureView.getAllowableResolutions ( )
inline

Returns a list of supported resolutions for image capture.

The list of resolutions returned may differ depending on the value of getUseVideoFrame()

Note: This list may be different from that returned by getSupportedPictureSizes() or getSupportedPreviewSizes()

Note: There can be resolutions returned that cannot be used if the value of getUseVideoFrame() is changed

This method should not be called until after the CameraInitializationEvent is fired.

Returns
All allowable image capture resolutions.
See also
android.hardware.Camera.getParameters().getSupportedPictureSizes()
android.hardware.Camera.getParameters().getSupportedPreviewSizes()
setImageResolution(android.hardware.Camera.Size)
setUseVideoFrame(boolean)
getUseVideoFrame()
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.getDeviceDeclinationPitch ( )
inline

Description: Returns the pitch angle that the Capture Control considers to be level.

Returns
An integer between -180 and 180
See also
setLevelThresholdPitch(int)
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.getDeviceDeclinationRoll ( )
inline

Description: Returns the roll angle that the Capture Control considers to be level.

Returns
An integer between -180 and 180
See also
setLevelThresholdRoll(int)
final Flash com.kofax.kmc.kui.uicontrols.ImageCaptureView.getFlash ( )
inline

This method should not be called until after the CameraInitializationEvent is fired.

Returns
A Flash value
See also
setFlash(Flash)
final List<Rect> com.kofax.kmc.kui.uicontrols.ImageCaptureView.getFocusAreas ( )
inline

Gets the current focus areas

Before using this API or setFocusAreas, apps should first call getMaxFocusAreas to know the maximum number of focus areas. If the value returned is 0, focus areas is not supported.

Focus area weight is set to 1000.

This method should not be called until after the CameraInitializationEvent is fired.

Returns
The set list of FocusAreas
See also
setFocusAreas
final GpsUsageLimits com.kofax.kmc.kui.uicontrols.ImageCaptureView.getGpsUsage ( )
inline
final ImageCaptureFrame com.kofax.kmc.kui.uicontrols.ImageCaptureView.getImageCaptureFrame ( )
inline

Description: Returns the ImageCaptureFrame object

Returns
The ImageCapturedFrame object to be rendered
See also
setImageCaptureFrame(ImageCaptureFrame)
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.getImagePreviewHeight ( )
inline

Description: Returns the height of the camera preview resolution. This property is read-only, and is automatically set to the resolution that will best fit the width and height of the ImageCaptureControl.

This method should not be called until after the CameraInitializationEvent is fired.

Returns
Camera resolution height
See also
getImagePreviewHeight()
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.getImagePreviewWidth ( )
inline

Description: Returns the width of the camera preview resolution. This property is read-only, and is automatically set to the resolution that will best fit the width and height of the ImageCaptureControl.

This method should not be called until after the CameraInitializationEvent is fired.

Returns
Camera resolution width
See also
getImagePreviewWidth()
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.getLevelThresholdPitch ( )
inline

Description: Returns the pitch threshold that the Capture Control considers to be level.

Returns
An integer between 0 and 45. By default, it is 7.
See also
getDeviceDeclinationPitch()
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.getLevelThresholdRoll ( )
inline

Description: Returns the roll threshold that the Capture Control considers to be level.

Returns
An integer between 0 and 45. By default, it is 7.
See also
setDeviceDeclinationRoll(int)
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.getLuminanceThreshold ( )
inline

Returns the luminance level at which the torch activates when Flash is set to AUTOTORCH.

Android only.

Returns
The current luminance threshold
See also
setLuminanceThreshold(int)
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.getMaxFocusAreas ( )
inline

Returns the device's maximum number of focusable areas.

This method should not be called until after the CameraInitializationEvent is fired.

Returns
The maximum number of supported focus areas, or 0 if unsupported
See also
#setFocusAreas(List)
getFocusAreas()
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.getPageAreaForDetection ( )
inline

Returns the currently set minimum value for the area that a page must occupy before a page detect event is fired.

Deprecated:
as of 2.6.1. Page detection events will be removed from ImageCaptureView. Instead, use combination of PreviewCallbackListener and DocumentDetector or subscribe to capture experience's page detection events using DocumentBaseCaptureExperience#addPageDetectionListener(PageDetectionListener).
final PageDetectMode com.kofax.kmc.kui.uicontrols.ImageCaptureView.getPageDetectMode ( )
inline
Returns
The current page detect mode.
See also
setPageDetectMode(PageDetectMode)
Deprecated:
as of 2.6.1. Page detection events will be removed from ImageCaptureView. As alternative you can use combination of PreviewCallbackListener and DocumentDetector or subscribe to capture experience's page detection events using DocumentBaseCaptureExperience#addPageDetectionListener(PageDetectionListener).
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.getStabilityDelay ( )
inline

This method returns the current stability delay. If not set, it defaults to 75.

Returns
An int from 0 to 100.
See also
setStabilityDelay(int)
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.getTorchDelay ( )
inline

Returns the delay that controls when the torch activates when Flash is set to AUTOTORCH. This delay specifies the number of consecutive times the detected luminance must be below the configured threshold before activating the torch. The default value of this property is 3.

Android only.

Returns
The current torch delay
See also
setTorchDelay(int)
final boolean com.kofax.kmc.kui.uicontrols.ImageCaptureView.getUseVideoFrame ( )
inline

Whether the control is using the video frame as the captured image

See also
setUseVideoFrame
ViewGroup com.kofax.kmc.kui.uicontrols.ImageCaptureView.getViewGroup ( )
inline
final boolean com.kofax.kmc.kui.uicontrols.ImageCaptureView.isFlashSupported ( Flash  flash)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.muteAutoTorch ( )
inline

When Flash is set to AUTOTORCH, the app can temporarily prevent the torch from lighting by calling this method. This might be necessary if you are attempting to capture a laminated document and activating the torch creates glare. This method can also be called when the torch is lit (via AUTOTORCH) to turn torch off and prevent it from lighting again.

Android only.

See also
unmuteAutoTorch()
void com.kofax.kmc.kui.uicontrols.ImageCaptureView.onAttachedToWindow ( )
inlineprotected
void com.kofax.kmc.kui.uicontrols.ImageCaptureView.onDetachedFromWindow ( )
inlineprotected
void com.kofax.kmc.kui.uicontrols.ImageCaptureView.onLayout ( boolean  changed,
int  l,
int  t,
int  r,
int  b 
)
inlineprotected

Layout our children

void com.kofax.kmc.kui.uicontrols.ImageCaptureView.removeAllViews ( )
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.removeCameraInitializationFailedListener ( CameraInitializationFailedListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.removeCameraInitializationListener ( CameraInitializationListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.removeLevelnessListener ( LevelnessListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.removeOnAutoFocusResultListener ( AutoFocusResultListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.removeOnImageCapturedListener ( ImageCapturedListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.removePageDetectionListener ( PageDetectionListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.removePreviewCallbackListener ( PreviewCallbackListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.removeStabilityDelayListener ( StabilityDelayListener  listener)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.removeTorchLuminanceListener ( TorchLuminanceListener  listener)
inline
final synchronized void com.kofax.kmc.kui.uicontrols.ImageCaptureView.sessionCreate ( )
inline
final synchronized void com.kofax.kmc.kui.uicontrols.ImageCaptureView.sessionDismiss ( )
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setDeviceDeclinationPitch ( int  angle)
inline

Description: Sets the pitch declination of the device, which affects how far it must be tilted along the y axis of the phone in order to be considered level. By default, this is set to 0, which is considered to be the levelness of a device laying flat on its back and facing upwards.

Parameters
angleAn integer value between -180 and 180.
See also
setLevelThresholdPitch(int)
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setDeviceDeclinationRoll ( int  angle)
inline

Description: Sets the roll declination of the device, which affects how far it must be tilted along the x axis of the phone in order to be considered level. By default, this is set to 0, which is considered to be the levelness of a device laying flat on its back and facing upwards.

Parameters
angleAn integer value between -180 and 180.
See also
setLevelThresholdRoll(int)
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setFlash ( Flash  flash)
inline

This method will attempt to set the camera flash mode to the mode specified. It polls the camera for the flash modes the hardware allows; if the flash parameter given is not included in the supported flash modes, this method will throw an exception.

This method must not be called until after the CameraInitializationEvent is fired. An IllegalStateException is thrown if this method is called when the camera is not open.

Parameters
flashA Flash enum that corresponds to various flash modes
See also
getFlash()
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setFocusAreas ( List< Rect >  focusAreas) throws KmcRuntimeException
inline

Sets the focus areas for the control.

Before using this API or getFocusAreas, apps should first call getMaxFocusAreas to know the maximum number of focus areas. If the value returned is 0, focus areas is not supported.

Image capture focus area bounds have valid values (0,0) to a maximum of (viewWidth, viewHeight) which are then translated to valid Android focus area coordinates.

When a focus area is set that has bounds outside of the view bounds the focus area rectangle will be clamped to the nearest valid view bound.

The width and height of focus areas cannot be 0 or negative. Any Rect in the list passed in must follow the left < right, and top < bottom rule or a KmcRuntimeException will be thrown as this is an invalid focus area Rect.

A Rect in the list will also need to have a sufficient area to provide the underlying camera autofocus algorithm enough information to focus on that area. Creating a Rect that has width and height that is between 5-10% of the width and height of the preview view size is recommended. When the Rect area is too small it is likely, but this is highly device dependent, that the camera will use the entire view as the focus area.

This method should not be called until after the CameraInitializationEvent is fired.

Parameters
focusAreasA list of Rect objects representing the desired focus areas
Exceptions
KmcRuntimeExceptionIf invalid Rect
See also
getFocusAreas
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setGpsUsage ( GpsUsageLimits  limits)
inline

Description: Calling this with a value of GpsUsageLimits#ALWAYS_USE_IF_ENABLED will cause the control to embed GPS coordinates in the captured image if Location Services are enabled. A value of GpsUsageLimits#NEVER_USE will prevent the inclusion of GPS coordinates in captured images, regardless of the availability of Location Services.

Defaults to GpsUsageLimits#ALWAYS_USE_IF_ENABLED.

See also
getGpsUsage()
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setImageCaptureFrame ( ImageCaptureFrame  imageCaptureFrame)
inline

Description: Sets the ImageCaptureFrame object to be rendered.

Parameters
imageCaptureFrameThe ImageCaptureFrame object to be rendered.
See also
getImageCaptureFrame()
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setImageResolution ( android.hardware.Camera.Size  resolution)
inline

Sets the desired resolution for image capture. The actual resolution of a captured image may be reversed from what is given (e.g. a 960x1280 image may be returned for a 1280x960 request).

The resolution parameter must be one of the given resolutions returned from getAllowableResolutions()

After calling this method, the ImageCaptureView instance may resize itself.

This method should not be called until after the CameraInitializationEvent is fired.

Parameters
resolutiona Size; one of those returned by getAllowableResolutions()
See also
getAllowableResolutions()
setUseVideoFrame(boolean)
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setLevelThresholdPitch ( int  threshold)
inline

Description: One of the thresholds used to determine if the device is level. An angle in degrees used to compare the actual pitch of the device to the angle set by setDeviceDeclinationPitch(int). If the difference is less than the threshold, the device is considered level with respect to pitch. The default value is 7.

Parameters
thresholdAn integer value between 0 and 45. Values outside this range will be interpreted as 0 or 45. A value of 45 disables level checking for pitch.
See also
setDeviceDeclinationPitch(int)
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setLevelThresholdRoll ( int  threshold)
inline

Description: One of the thresholds used to determine if the device is level. An angle in degrees used to compare the actual roll of the device to the angle set by setDeviceDeclinationRoll(int). If the difference is less than the threshold, the device is considered level with respect to roll. The default value is 7.

Parameters
thresholdAn integer value between 0 and 45. Values outside this range will be interpreted as 0 or 45. A value of 45 disables level checking for roll.
See also
setDeviceDeclinationRoll(int)
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setLuminanceThreshold ( int  luminanceThreshold)
inline

This method sets the luminance level (> 0) at which the torch activates when Flash is set to AUTOTORCH.

Android only.

Parameters
luminanceThresholdAn integer that specifies the luminance threshold
See also
getLuminanceThreshold()
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setPageAreaForDetection ( int  threshold)
inline

Set the minimum value for the area that a page must occupy before a page detect is fired.

The default value is 20.

Possible range: 0 < threshold < 100

Deprecated:
as of 2.6.1. Page detection events will be removed from ImageCaptureView. Instead, use combination of PreviewCallbackListener and DocumentDetector or subscribe to capture experience's page detection events using DocumentBaseCaptureExperience#addPageDetectionListener(PageDetectionListener).
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setPageDetectMode ( PageDetectMode  mode)
inline

This property controls the page detection behavior of the control.

Page detection adds an additional constraint to image capture such that an image will not be captured until a document is detected within the viewfinder. When running, page detection will also raise events each time a page is detected if the corresponding delegate has been set. The supported modes are:

  • PageDetectMode#OFF: Turns off the page detection algorithm and its associated capture constraints.
  • PageDetectMode#AUTOMATIC: Enables page detection and applies the page detection constraint to image capture. Use of the algorithm is minimized to conserve resources, and events will not be generated until other capture constraints are satisfied. Usually, only a single event will be raised at the time an image is captured.
  • PageDetectMode#CONTINUOUS: Enables page detection and runs it continuously in the background while the control is active. The page detection constraint is applied to image capture. The control will provide events related to page detection as they become available.

When deciding to enable any of the page detection modes, consider the impacts on processing resources and battery life. The continuous mode provides more flexibility to the developer than the automatic mode, but will consume more resources as well.

Note: Using any mode other than PageDetectMode#OFF while also using CheckCaptureExperience or the com.kofax.kmc.kui.uicontrols.captureanimations.DocumentCaptureExperience or com.kofax.kmc.ken.engines.CheckDetector may crash the device. The other experiences will automatically turn the effective mode to OFF. It is the developer's responsibility not to enable PageDetection while also using the CheckDetector.

Parameters
modeThe new page detection mode.
See also
getPageDetectMode()
PageDetectMode
Deprecated:
as of 2.6.1. Page detection events will be removed from ImageCaptureView. As alternative you can use combination of PreviewCallbackListener and DocumentDetector or subscribe to capture experience's page detection events using DocumentBaseCaptureExperience#addPageDetectionListener(PageDetectionListener).
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setStabilityDelay ( int  stabilityDelay)
inline

The stability delay property is a threshold that determines how stable the device has to be before an image will captured. Valid values are in the range [0, 100], where 0 is completely unstable and 100 is completely stable. A setting of 0 will turn off stability checking, and in practice a device will rarely be stable enough to satisfy a value of 100. The default setting is 75.

Parameters
stabilityDelayAn int from 0 to 100.
See also
getStabilityDelay()
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setTorchDelay ( int  torchDelay)
inline

This method sets the delay (> 0) that controls when the torch activates when Flash is set to AUTOTORCH. This delay specifies the number of consecutive times the detected luminance must be below the configured threshold before activating the torch.

Android only.

Parameters
torchDelayAn integer that specifies the delay
See also
getTorchDelay()
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.setUseVideoFrame ( boolean  useVideo)
inline

Description: Calling this with a value of true will cause the control to return the video frame when takePicture() is called, or when requirements are met (such as when page detection is enabled). The video frame will normally be of lower resolution and may not be appropriate for image processing.

Defaults to false.

Parameters
useVideowhether to use preview frames for capture or not
See also
getUseVideoFrame()
void com.kofax.kmc.kui.uicontrols.ImageCaptureView.surfaceChanged ( SurfaceHolder  holder,
int  format,
int  width,
int  height 
)
inline
void com.kofax.kmc.kui.uicontrols.ImageCaptureView.surfaceCreated ( SurfaceHolder  holder)
inline
void com.kofax.kmc.kui.uicontrols.ImageCaptureView.surfaceDestroyed ( SurfaceHolder  holder)
inline
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.takePicture ( )
inline

Description: Calling this method will start the process of monitoring the various sensors to determine when a level, focused, and non-blurry shot of the document can be taken. The default level indicator will not be rendered unless the levelIndicator property is set to true. An ImageCapturedEvent will be raised for each captured image.

See also
forceTakePicture()
final void com.kofax.kmc.kui.uicontrols.ImageCaptureView.unmuteAutoTorch ( )
inline

When Flash is set to AUTOTORCH, the app can temporarily prevent the torch from lighting by calling muteAutoTorch(). Call this method to revert the auto torch functionality to configured behavior.

Android only.

See also
muteAutoTorch()

Member Data Documentation

IBus com.kofax.kmc.kui.uicontrols.ImageCaptureView._bus
protected
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.DEFAULT_LUMINANCE_THRESHOLD = 100
static
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.DEFAULT_STABILITY_DELAY_THRESHOLD = 75
static
final int com.kofax.kmc.kui.uicontrols.ImageCaptureView.DEFAULT_TORCH_DELAY = 3
static

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.