Kofax Mobile SDK API Reference
Instance Methods | List of all members
KFXQuickExtractor Class Reference

An extractor that extracts either a barcode or MRZ data and a face image from a static source image. More...

#import <KFXQuickExtractor.h>

Inheritance diagram for KFXQuickExtractor:

Instance Methods

(instancetype) - initWithSettings:
 Initializes a new object using the specified parameters. More...
 
(void) - processImage:completionHandler:
 Runs extraction for static image. More...
 

Detailed Description

An extractor that extracts either a barcode or MRZ data and a face image from a static source image.

This extractor works with static images, see KFXQuickExtractorAgent for a version that processes preview frames during image capture.

In order to successfully extract data with QuickExtract, the identification document being captured must be in the same orientation as the QuickExtract capture experience.

See also
KFXQuickExtractorAgent

Method Documentation

- (instancetype) initWithSettings: (KFXQuickExtractionSettings *)  settings

Initializes a new object using the specified parameters.

Parameters
settingsConfiguration object.
See also
KFXQuickExtractionSettings
- (void) processImage: (kfxKEDImage *)  image
completionHandler: (void(^)(NSArray *fields, kfxKEDImage *faceImage, NSError *error))  completionBlock 

Runs extraction for static image.

Parameters
imageSource image for extraction.
completionBlockCompletion handler where fields is a NSArray that contains kfxKOEDataField objects of extracted data. faceImage is face image object. error is an error object if failure occurred or nil otherwise.
See also
kfxKOEDataField
kfxKEDImage

The documentation for this class was generated from the following file:
Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.