Kofax Mobile SDK API Reference
Properties | List of all members
kfxProcessingParameters Class Reference

The image processing parameters class. More...

#import <kfxProcessingParameters.h>

Inheritance diagram for kfxProcessingParameters:

Properties

kfxProcessingType processingType
 A processing type value. More...
 
NSString * operations
 An image processing operation string. More...
 
BOOL useMRZPageDetection
 Specify image processor to use MRZ page detection for cropping process or not. More...
 
BOOL useTargetFrameCrop
 Specify image processor to run target frame cropping prior to page detection. More...
 

Detailed Description

The image processing parameters class.

The parameters object allows the user to customize image processing functionality. The behavior and default values for some parameters could vary across capture view controllers, and details are specified in target document capture view controller parameters class.

See also
kfxIParameters

Property Documentation

- (NSString*) operations
readwritenonatomiccopy

An image processing operation string.

App specific definition of the encoded imaged processing (IP) options desired. The string is composed of a concatenation of individual IP tokens, each of which enables an option. Please refer to the developers guide for a list of IP tokens. To use the default processing string, set this property to nil. The default string used depends on the target capture view controller. The default value is nil.

- (kfxProcessingType) processingType
readwritenonatomicassign

A processing type value.

The supported modes are: kfxProcessingType_Off: processing is disabled. kfxProcessingType_OnDevice: processing is performed on device. If extraction is enabled, this must be on. Processing is required if extraction is enabled.

The default value is kfxProcessingType_OnDevice.

See also
kfxExtractionParameters
- (BOOL) useMRZPageDetection
readwritenonatomicassign

Specify image processor to use MRZ page detection for cropping process or not.

Set the property to YES to enable MRZ page detection during document processing. The default value is NO.

- (BOOL) useTargetFrameCrop
readwritenonatomicassign

Specify image processor to run target frame cropping prior to page detection.

Set the property to YES to enable target frame cropping during document processing. The default value is NO.


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.