Kofax Mobile SDK API Reference
KFXImageProcessorConfiguration.h
Go to the documentation of this file.
1 //
2 // KFXImageProcessorConfiguration.h
3 // kfxLibEngines
4 //
5 // Copyright (c) 2014-2017 Kofax. All rights reserved. Kofax Confidential.
6 // Unauthorized use, duplication, or distribution, or disclosure is strictly prohibited.
7 //
8 
9 #import <Foundation/Foundation.h>
10 #ifndef KEDIMAGEPROCESSORCONFIGURATION
11 #define KEDIMAGEPROCESSORCONFIGURATION 1
12 
14 
15 typedef enum {
22 
23 typedef enum {
24  BITONAL = 1,
25  GRAYSCALE = 8,
26  COLOR = 24,
28 
30 
36 typedef enum {
40 } KFXCropType;
41 
42 typedef enum {
47 
48 typedef enum {
52 
54 
57 @interface KFXDocumentDimensions : NSObject <NSCoding, NSCopying>
58 
60 
64 @property (assign, nonatomic) float shortEdge;
65 
67 
71 @property (assign, nonatomic) float longEdge;
72 
74 
77 - (instancetype)initWithShortEdge:(float)shortEdge andLongEdge:(float)longEdge;
78 
79 @end
80 
82 
85 @interface KFXImageProcessorConfiguration : NSObject <NSCoding, NSCopying>
86 
88 
92 @property (assign, nonatomic) KFXRotateType rotateType;
93 
95 
99 @property (assign, nonatomic) KFXColorDepth outputColorDepth;
100 
102 
106 @property (assign, nonatomic) KFXCropType cropType;
107 
109 
113 @property (assign, nonatomic) KFXTargetFrameCropType targetFrameCropType;
114 
116 
120 @property (assign, nonatomic) KFXDeskewType deskewType;
121 
123 
127 @property (strong, nonatomic) KFXDocumentDimensions* documentDimensions;
128 
130 
134 @property (assign, nonatomic) int outputDPI;
135 
137 @property (strong, nonatomic) NSString* advancedConfiguration;
139 
141 
144 @property (strong, nonatomic, readonly) NSString* ippString;
145 
146 // ==========================================================
148 
152 @property (strong, nonatomic) kfxKEDBoundingTetragon *croppingTetragon;
153 
155 
158 - (instancetype)initWithIppString:(NSString*)ippString;
159 
160 @end
161 
162 #endif
163 
KFXCropType
Cropping Options enumeration.
Definition: KFXImageProcessorConfiguration.h:36
Definition: KFXImageProcessorConfiguration.h:50
Definition: KFXImageProcessorConfiguration.h:17
Definition: KFXImageProcessorConfiguration.h:16
Definition: KFXImageProcessorConfiguration.h:20
The Dimensions of a Document.
Definition: KFXImageProcessorConfiguration.h:57
Definition: KFXImageProcessorConfiguration.h:39
float shortEdge
The Short Edge of a Document.
Definition: KFXImageProcessorConfiguration.h:64
kfxKEDBoundingTetragon * croppingTetragon
Tetragon corner points defining the image cropping limits.
Definition: kfxKEDBasicSettingsProfile.h:121
Definition: KFXImageProcessorConfiguration.h:18
Definition: KFXImageProcessorConfiguration.h:45
Definition: KFXImageProcessorConfiguration.h:43
KFXColorDepth
Definition: KFXImageProcessorConfiguration.h:23
Definition: KFXImageProcessorConfiguration.h:44
Definition: KFXImageProcessorConfiguration.h:37
float longEdge
The Long Edge of a Document.
Definition: KFXImageProcessorConfiguration.h:71
Bounding Tetragon class holds four point data.
Definition: kfxKEDBoundingTetragon.h:38
KFXRotateType
Definition: KFXImageProcessorConfiguration.h:15
int outputDPI
Desired Output image DPI.
Definition: kfxKEDBasicSettingsProfile.h:129
Definition: KFXImageProcessorConfiguration.h:24
Image Processor Configuration Specifies Image Processing Options.
Definition: KFXImageProcessorConfiguration.h:85
Definition: KFXImageProcessorConfiguration.h:38
Definition: KFXImageProcessorConfiguration.h:26
Definition: KFXImageProcessorConfiguration.h:25
Definition: KFXImageProcessorConfiguration.h:49
KFXDeskewType
Definition: KFXImageProcessorConfiguration.h:42
Definition: KFXImageProcessorConfiguration.h:19
KFXTargetFrameCropType
Definition: KFXImageProcessorConfiguration.h:48
Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.