Kofax Mobile SDK API Reference
Classes | Macros | Typedefs | Enumerations
kfxKEDImage.h File Reference
#import <UIKit/UIKit.h>
#import "kfxKEDImagePerfectionProfile.h"
#import "kfxKEDBasicSettingsProfile.h"
#import "kfxKEDQuickAnalysisFeedback.h"
#import "kfxKUTErrorInfo.h"

Go to the source code of this file.

Classes

class  kfxKEDImage
 An Image object contains an image and associated data. More...
 

Macros

#define KMC_MIN_DPI   25
 
#define DEFAULT_ORIENTATION   0
 

Typedefs

typedef enum kedImageRep KEDImageRepresentation
 Image Representation enumeration. More...
 
typedef enum kedImageMimetype KEDImageMimeType
 Image Mimetype enumeration. More...
 
typedef enum kedFileImageRep KEDFileRepresentation
 File storage method. More...
 

Enumerations

enum  kedImageRep {
  IMAGE_REP_NONE = 0, IMAGE_REP_BITMAP, IMAGE_REP_FILE, IMAGE_REP_BOTH,
  IMAGE_REP_LAST
}
 Image Representation enumeration. More...
 
enum  kedImageMimetype {
  MIMETYPE_UNKNOWN = 0, MIMETYPE_JPG, MIMETYPE_PNG, MIMETYPE_TIF,
  MIMETYPE_LAST
}
 Image Mimetype enumeration. More...
 
enum  kedFileImageRep { FILE_REP_UNKNOWN, FILE_STORED, FILE_BUFFERED, FILE_REP_LAST }
 File storage method. More...
 
enum  FILE_RESTRICTION { RESTRICTION_NONE, RESTRICTION_ANSI_X9 }
 File Format restriction. More...
 

Macro Definition Documentation

◆ DEFAULT_ORIENTATION

#define DEFAULT_ORIENTATION   0

◆ KMC_MIN_DPI

#define KMC_MIN_DPI   25

Typedef Documentation

◆ KEDFileRepresentation

File storage method.

This enumeration indicates how the file representation is actually stored, in a file or in a buffer that represents the file contents. When the Image Representation is set to either IMAGE_REP_FILE or IMAGE_REP_BOTH, the image is stored as a file repreentation. This File Storage enum indicates how the file representation is stored:

   FILE_REP_UNKNOWN    - The image is not stored as a file representation.
   FILE_STORED         - The image is stored in a file.
   FILE_BUFFERED       - The image is stored in a buffer as a file representation

◆ KEDImageMimeType

Image Mimetype enumeration.

This enumeration indicates what type of image is represented in the object. The library supports these three format types: MIMETYPE_JPG, MIMETYPE_PNG, MIMETYPE_TIF

◆ KEDImageRepresentation

Image Representation enumeration.

This enumeration indicates how the Image object is represented. The Image object may contain a bitmap image, or be represented by an image in a file, or both. You end up with the representation set to both when you write the image to a file by name, or you read the image into the bitmap from a file name. The library manages this representation for you based on operations you perform on the Image object.

Enumeration Type Documentation

◆ FILE_RESTRICTION

File Format restriction.

This enumeration indicates if the file format (when in TIFF) is ANSI X9 compatible or not

RESTRICTION_NONE - No restriction applied. RESTRICTION_ANSI_X9 - The image is stored in ANSI X9 TIFF format.

Enumerator
RESTRICTION_NONE 
RESTRICTION_ANSI_X9 

◆ kedFileImageRep

File storage method.

This enumeration indicates how the file representation is actually stored, in a file or in a buffer that represents the file contents. When the Image Representation is set to either IMAGE_REP_FILE or IMAGE_REP_BOTH, the image is stored as a file repreentation. This File Storage enum indicates how the file representation is stored:

   FILE_REP_UNKNOWN    - The image is not stored as a file representation.
   FILE_STORED         - The image is stored in a file.
   FILE_BUFFERED       - The image is stored in a buffer as a file representation
Enumerator
FILE_REP_UNKNOWN 
FILE_STORED 
FILE_BUFFERED 
FILE_REP_LAST 

◆ kedImageMimetype

Image Mimetype enumeration.

This enumeration indicates what type of image is represented in the object. The library supports these three format types: MIMETYPE_JPG, MIMETYPE_PNG, MIMETYPE_TIF

Enumerator
MIMETYPE_UNKNOWN 
MIMETYPE_JPG 
MIMETYPE_PNG 
MIMETYPE_TIF 
MIMETYPE_LAST 

◆ kedImageRep

Image Representation enumeration.

This enumeration indicates how the Image object is represented. The Image object may contain a bitmap image, or be represented by an image in a file, or both. You end up with the representation set to both when you write the image to a file by name, or you read the image into the bitmap from a file name. The library manages this representation for you based on operations you perform on the Image object.

Enumerator
IMAGE_REP_NONE 
IMAGE_REP_BITMAP 
IMAGE_REP_FILE 
IMAGE_REP_BOTH 
IMAGE_REP_LAST 
Untitled Document © 2021 Kofax, Inc. All rights reserved. Use is subject to license terms.