Kofax Mobile SDK API Reference
|
Go to the documentation of this file.
9 #import <UIKit/UIKit.h>
75 #define KMC_MIN_DPI 25
76 #define DEFAULT_ORIENTATION 0 // Right
171 @property (readonly,atomic) NSString *
imageID;
181 @property (readonly,atomic) NSString *friendID;
851 - (int) specifyImageBitmap: (UIImage*) image;
959 - (int) specifyImageCreateDateAndtime: (NSString*) dateString;
972 - (int) specifyFilePath: (NSString*) fullFilePath;
999 - (NSString*) getFriendID;
1084 +(NSString*)simpleDateTimeString:(NSDate*)date;
1091 +(NSDate*)dateFromSimpleDateString:(NSString*)s;
1160 - (id)initWithImage:(UIImage*)image;
NSString * imageMetaData
Image metadata created by the image processing process.
Definition: kfxKEDImage.h:209
Definition: kfxKEDImage.h:25
float imageGPSLat
Global latitude of the location where the original photo was taken.
Definition: kfxKEDImage.h:240
NSString * getImageSourceID()
Get the image ID of the input source image.
NSString * getImageID()
Get the image ID of the image.
kedImageRep
Image Representation enumeration.
Definition: kfxKEDImage.h:24
Definition: kfxKEDImage.h:29
Definition: kfxKEDImage.h:54
id init()
Initialize an object allocated for use.
CGRect targetFrame
Target frame used for taking a picture.
Definition: kfxKEDImage.h:525
Definition: kfxKEDImage.h:55
NSString * imageSourceID
Identifies the source image used to generate this image.
Definition: kfxKEDImage.h:192
Definition: kfxKEDImage.h:28
int clearFileBuffer()
Clear the buffered file image.
NSString * imageTag
App defined tag name to associate with this image.
Definition: kfxKEDImage.h:416
Definition: kfxKEDImage.h:27
NSString * imageID
Uniquely identifies this image using a unique ID.
Definition: kfxKEDImage.h:171
int imageDPI
Image Dots per Inch.
Definition: kfxKEDImage.h:427
bool isValidDateTime()
Check date time string validity.
float getAttitudeRoll()
Get the roll attitude of the camera when the picture was taken.
float getImageGPSLon()
Get the GPS longitude associated with this image.
int imageWriteToFile()
Write the image contained in the UIImage to the file path specified in the object.
const char * getImageFileBuffer()
Get a reference to the image file buffer.
KEDOutputColor
Definition: kfxKEDBasicSettingsProfile.h:24
float attitudeRoll
Image Attitude for the roll when the image was taken.
Definition: kfxKEDImage.h:401
int imageFileBufferSize
Defines how large the file buffer is in bytes.
Definition: kfxKEDImage.h:343
NSString * ISO8601DateTime()
Generate a compliant date-time string for use in this object.
FILE_RESTRICTION
File Format restriction.
Definition: kfxKEDImage.h:67
float imageGPSLon
Global longitude of the location where the original photo was taken.
Definition: kfxKEDImage.h:261
int jpegQuality
jpeg Quality setting
Definition: kfxKEDImage.h:438
kfxKEDQuickAnalysisFeedback * getImageQuickAnalysisFeedback()
Get the quick analysis feedback object from the last quick analysis.
int imageWidth
Image Width in pixels for the image bitmap.
Definition: kfxKEDImage.h:377
kedImageMimetype
Image Mimetype enumeration.
Definition: kfxKEDImage.h:36
Quick Analysis Results Feedback Class.
Definition: kfxKEDQuickAnalysisFeedback.h:39
enum kedImageMimetype KEDImageMimeType
Image Mimetype enumeration.
int deleteFile()
Delete the file specified in the file path contained in this object.
float getAttitudePitch()
Get the pitch attitude of the camera when the picture was taken.
KEDImageMimeType imageMimeType
Indicates the file storage configuration.
Definition: kfxKEDImage.h:473
bool isAttitudeValid
Boolean to indicate if the attitude is valid.
Definition: kfxKEDImage.h:516
Definition: kfxKEDImage.h:26
KEDImageRepresentation imageRepresentation
Defines how the image is represented in this object.
Definition: kfxKEDImage.h:319
kedFileImageRep
File storage method.
Definition: kfxKEDImage.h:52
Definition: kfxKEDImage.h:53
enum kedImageRep KEDImageRepresentation
Image Representation enumeration.
Definition: kfxKEDImage.h:41
UIImage * getImageBitmap()
Get the current bitmap image.
NSMutableArray * imageBarCodes
Array of image barcodes found by processing.
Definition: kfxKEDImage.h:493
int imageReadFromFileBuffer()
Read an image from the file buffer into the UIImage imageBitmap property.
Definition: kfxKEDImage.h:37
Definition: kfxKEDImage.h:70
bool isPositionValid
Boolean to indicate if the GPS data is valid.
Definition: kfxKEDImage.h:483
Definition: kfxKEDImage.h:56
Definition: kfxKEDImage.h:40
Definition: kfxKEDImage.h:69
int imageReadFromFile()
Initialize the imageBitmap property with the image contained in a file.
Definition: kfxKEDImage.h:39
An Image object contains an image and associated data.
Definition: kfxKEDImage.h:157
enum kedFileImageRep KEDFileRepresentation
File storage method.
float getImageGPSLat()
Get the GPS latitude associated with this image.
NSString * imageCreateDateTime
Object creation date-time string.
Definition: kfxKEDImage.h:461
KEDOutputColor imageFileOutputColor
Image File Output Color.
Definition: kfxKEDImage.h:450
kfxKEDBasicSettingsProfile * DEPRECATED_ATTRIBUTE()
Get the basic settings profile used in the last image processing operation.
int imageWriteToFileBuffer()
Write the UIImage object in this kfxKEDImage object to file buffer.
kfxKEDQuickAnalysisFeedback * imageQuickAnalysisFeedback
Image Quick Analysis feedback stores quick analysis results.
Definition: kfxKEDImage.h:353
NSString * imageMicrData
MICR data extracted from the image metadata.
Definition: kfxKEDImage.h:218
float attitudePitch
Image Attitude for the pitch when the image was taken.
Definition: kfxKEDImage.h:389
NSString * getImageMetaData()
Get the image metadata string.
long getImageSize()
Get the current image size.
NSString * getFilePath()
Get the current file path.
Definition: kfxKEDImage.h:38
KEDFileRepresentation fileRepresentation
Defines how the file is represented.
Definition: kfxKEDImage.h:331
int clearImageBitmap()
Clear the bitmap image.
int imageHeight
Image Height in pixels for the image bitmap.
Definition: kfxKEDImage.h:365
Untitled Document
© 2021 Kofax, Inc. All rights reserved. Use is subject to license terms.