Atalasoft MobileImage API Reference
Instance Methods | List of all members
<kfxKIPDelegate> Protocol Reference

Image Processing Protocol. More...

#import <kfxKIPDelegate.h>

Inheritance diagram for <kfxKIPDelegate>:

Instance Methods

(void) - imageOut:withMsg:andOutputImage:
 Image Out Delegate. More...
 
(void) - processProgress:withMsg:imageID:andProgress:
 Image processing progress Delegate. More...
 
(void) - analysisComplete:withMsg:andOutputImage:
 Analysis Complete Delegate. More...
 
(void) - analysisProgress:withMsg:imageID:andProgress:
 Image analysis progress Delegate. More...
 

Detailed Description

Image Processing Protocol.

The kfxKIPDelegate defines the protocol for all the delegates the Image Processsing Engine calls during image processing. There is a pair for quick analysis, and a pair for process image. Each pair consists of a progress event to inform you of the completion precentage and an operation complete event after the final image processing ends. The library uses these delegates during processing because they are completed in background.

Method Documentation

- (void) analysisComplete: (int)  status
withMsg: (NSString *)  errorMsg
andOutputImage: (kfxKEDImage *)  kfxImage 
required

Analysis Complete Delegate.

The Engine calls this method after the engine completes the quick analysis.
This is a required delegate. The output kfxImage is the original input image given for analysis. The results of the quick analysis are stored in this input kfxImage regardless if you requested an output image or not. If you did request a quick analysis image, then the UIImage image is stored in the quickAnalysisFeedback element of the input kfxImage.

Parameters
status: Set to KMC_SUCCESS if no error occurred, otherwise an error code.
errorMsg: A description of the error that occurred.
kfxImage: A reference to the input image, regardless of if an error was generated.
- (void) analysisProgress: (int)  status
withMsg: (NSString *)  errorMsg
imageID: (NSString *)  imageID
andProgress: (int)  percent 
required

Image analysis progress Delegate.

The Engine calls this method multiple times during processing to indicate progress in percent, from 1-100.
This is a required delegate. You should make no decisions about the image processing until the library calls the analysis complete delegate.

Parameters
statusSet to KMC_SUCCESS if no error occurred, otherwise an error code.
errorMsgA description of the error that occurred.
imageIDThe ID of the original input image
percentThe percentage of completion, 1-100
- (void) imageOut: (int)  status
withMsg: (NSString *)  errorMsg
andOutputImage: (kfxKEDImage *)  kfxImage 
required

Image Out Delegate.

The Engine calls this method after an image is generated by image processing.
This is a required delegate. The output image contains the processed image if no error was detected.

Parameters
status: Set to KMC_SUCCESS if no error occurred, otherwise an error code.
errorMsg: A description of the error that occurred.
kfxImage: An output image reference when image processing completed without error.
- (void) processProgress: (int)  status
withMsg: (NSString *)  errorMsg
imageID: (NSString *)  imageID
andProgress: (int)  percent 
required

Image processing progress Delegate.

The Engine calls this method multiple times during processing to indicate progress in percent, from 1-100.
This is a required delegate. You should make no decisions about the image processing until the library calls the image out delegate.

Parameters
statusSet to KMC_SUCCESS if no error occurred, otherwise an error code.
errorMsgA description of the error that occurred.
imageIDThe ID of the original input image
percentThe percentage of completion, 1-100

The documentation for this protocol 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.