|
Kofax Mobile SDK API Reference
|
Static Public Attributes | |
| static final String | PREPROCESS_STRING = "_DeviceType_2_Do90DegreeRotation_4_DoCropCorrection__DoScaleImageToDPI_500_DoSkewCorrectionPage__DocDimLarge_3.375_DocDimSmall_2.125_LoadSetting_<Property Name=\"CSkewDetect.correct_illumination.Bool\" Value=\"0\" />" |
| static final String | PREPROCESS_PASSPORT_STRING = "_DeviceType_2_DoCropCorrection__DoSkewCorrectionAlt__Do90DegreeRotation_4_DoScaleImageToDPI_500_DocDimSmall_3.465_DocDimLarge_4.921_" |
| static final String | PREPROCESS_ID2_STRING = "_DeviceType_2_Do90DegreeRotation_4_DoCropCorrection__DoScaleImageToDPI_500_DoSkewCorrectionPage__DocDimLarge_4.134_DocDimSmall_2.913_LoadSetting_<Property Name=\"CSkewDetect.correct_illumination.Bool\" Value=\"0\" />" |
Parameter holder object for on-device extraction.
Any Image(s) may be pre-processed for de-skew and crop prior to sending it for extraction.
One or both images, or a barcode string is required.
| IdExtractionParameters | ( | IdRegion | region, |
| IdType | idType, | ||
| Image | frontImage, | ||
| List< BarCodeResult > | frontBarcodes, | ||
| Image | backImage, | ||
| List< BarCodeResult > | backBarcodes, | ||
| boolean | isProcessed, | ||
| IIdExtractionListener | listener | ||
| ) |
Construct a new IdExtractionParameters object.
At least one of the frontImage, backImage, frontBarcode, backBarcode parameters is required. If using either image, any of the other parameters is optional. When using barcode strings, one or both of the image parameters is required.
| region | The region of the image(s) (cannot be null) |
| idType | The type of the document (cannot be null) |
| frontImage | Pass the front-side image (optional) |
| frontBarcodes | Pass the front-side barcode strings and types (optional) |
| backImage | Pass the back-side image (optional) |
| backBarcodes | Pass the back-side barcode strings and types (optional) |
| isProcessed | Whether the images passed are pre-processed or not. If true, the SDK will not pre-process both images before extraction. Otherwise, any processing required will be handled internally by the SDK. |
| listener | A callback that will be called with results and errors (cannot be null) |
| IllegalArgumentException | When IdRegion or Listener is null, or if both the front image and barcode string are null |
| IdExtractionParameters | ( | String | projectName, |
| IdType | idType, | ||
| Image | frontImage, | ||
| List< BarCodeResult > | frontBarcodes, | ||
| Image | backImage, | ||
| List< BarCodeResult > | backBarcodes, | ||
| boolean | isProcessed, | ||
| IIdExtractionListener | listener | ||
| ) |
Construct a new IdExtractionParameters object.
At least one of the frontImage, backImage, frontBarcodes, backBarcodes parameters is required. If using either image, any of the other parameters is optional. When using barcodes, one or both of the image parameters is required for regions other than US and Canada.
| projectName | The region of the image(s) (cannot be null) |
| idType | The type of the document (cannot be null) |
| frontImage | Pass the front-side image (optional) |
| frontBarcodes | Pass the front-side barcode strings and types (optional) |
| backImage | Pass the back-side image (optional) |
| backBarcodes | Pass the back-side barcode strings and types (optional) |
| isProcessed | Whether the images passed are pre-processed or not. If true, the SDK will not pre-process both images before extraction. Otherwise, any processing required will be handled internally by the SDK. |
| listener | A callback that will be called with results and errors (cannot be null) |
| IllegalArgumentException | When projectName or idType or listener is null. |
| KmcRuntimeException | (KMC_GN_ILLEGAL_ARGUMENT_EXCEPTION) When both images and barcode lists are null. |
| IdExtractionParameters | ( | String | projectName, |
| IdType | idType, | ||
| Image | frontImage, | ||
| List< BarCodeResult > | frontBarcodes, | ||
| Image | backImage, | ||
| List< BarCodeResult > | backBarcodes, | ||
| boolean | isProcessed, | ||
| boolean | extractFaceImage, | ||
| boolean | extractSignatureImage, | ||
| IIdExtractionListener | extractionListener, | ||
| IIdImageProcessingListener | imageProcessingListener | ||
| ) |
Construct a new IdExtractionParameters object.
At least one of the frontImage, backImage, frontBarcodes, backBarcodes parameters is required. If using either image, any of the other parameters is optional. When using barcodes, one or both of the image parameters is required for regions other than US and Canada.
| projectName | The region of the image(s) (cannot be null) |
| idType | The type of the document (cannot be null) |
| frontImage | Pass the front-side image (optional) |
| frontBarcodes | Pass the front-side barcode strings and types (optional) |
| backImage | Pass the back-side image (optional) |
| backBarcodes | Pass the back-side barcode strings and types (optional) |
| isProcessed | Whether the images passed are pre-processed or not. If true, the SDK will not pre-process both images before extraction. Otherwise, any processing required will be handled internally by the SDK. |
| extractFaceImage | Whether or not identification photo extraction will be attempted. Disabled by default. |
| extractSignatureImage | Whether or not signature image extraction will be attempted. Disabled by default. |
| extractionListener | A callback that will be called with results and errors (cannot be null) |
| imageProcessingListener | A callback that will be called with the front and back processed images (optional)
|
| IllegalArgumentException | When projectName or idType or extractionListener is null. |
| KmcRuntimeException | (KMC_GN_ILLEGAL_ARGUMENT_EXCEPTION) When both images and barcode lists are null. |
| List<BarCodeResult> getBackBarcodes | ( | ) |
| Image getBackImage | ( | ) |
| boolean getExtractFaceImage | ( | ) |
| IIdExtractionListener getExtractionListener | ( | ) |
| boolean getExtractSignatureImage | ( | ) |
| List<BarCodeResult> getFrontBarcodes | ( | ) |
| Image getFrontImage | ( | ) |
| IdType getIdType | ( | ) |
| IIdImageProcessingListener getImageProcessingListener | ( | ) |
| IIdExtractionListener getListener | ( | ) |
Returns the extraction listener.
| String getProjectName | ( | ) |
| IdRegion getRegion | ( | ) |
| boolean isProcessed | ( | ) |
|
static |
|
static |
|
static |