Atalasoft MobileImage API Reference
Public Member Functions | List of all members
com.kofax.kmc.ken.engines.ImageProcessor.AnalysisCompleteEvent Class Reference

An event that indicates that image quick analysis results are available. More...

Inheritance diagram for com.kofax.kmc.ken.engines.ImageProcessor.AnalysisCompleteEvent:

Public Member Functions

 AnalysisCompleteEvent (Object sender, ErrorInfo status, Image image)
 Creates a new AnalysisCompleteEvent with the given parameters. More...
 
ErrorInfo getStatus ()
 Gets the status property for the AnalysisCompleteEvent. More...
 
Image getImage ()
 Gets the Image property for the AnalysisCompleteEvent. More...
 

Detailed Description

An event that indicates that image quick analysis results are available.

This event is raised in response to image quick analysis results being available following a call to doQuickAnalysis. The event includes status information, and optionally a new preview Image object. A new preview Image is provided on this event if returnPreviewImage was true in the corresponding call to doQuickAnalysis. The preview Image object may be null when errors are reported. The preview Image will be null if returnPreviewImage was false in the call to doQuickAnalysis.

See also
ImageProcessor::doQuickAnalysis

Constructor & Destructor Documentation

com.kofax.kmc.ken.engines.ImageProcessor.AnalysisCompleteEvent.AnalysisCompleteEvent ( Object  sender,
ErrorInfo  status,
Image  image 
)
inline

Creates a new AnalysisCompleteEvent with the given parameters.

Member Function Documentation

Image com.kofax.kmc.ken.engines.ImageProcessor.AnalysisCompleteEvent.getImage ( )
inline

Gets the Image property for the AnalysisCompleteEvent.

The Image property is the newly generated preview image.

Returns
ErrorInfo status
ErrorInfo com.kofax.kmc.ken.engines.ImageProcessor.AnalysisCompleteEvent.getStatus ( )
inline

Gets the status property for the AnalysisCompleteEvent.

The status property includes a status code and a message string.

Returns
ErrorInfo status

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.