Skip navigation links
< A C D E F G H I P R S T 

<

<no name provided>() - Method in class io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler
Continuously notified about ID card scanner results.

A

addResultHandler(resultHandler) - Method in class io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler
Registers result handler which will be notified about ID card detection results.
attach(cameraView, idCardScanner) - Static method in class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController
Convenience method for attaching class IdCardAutoSnappingController to IScanbotCameraView
attach(cameraView, frameHandler) - Static method in class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController
Convenience method for attaching class IdCardAutoSnappingController to IScanbotCameraView
attach(cameraView, idCardScanner) - Method in class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController.Companion
Convenience method for attaching class IdCardAutoSnappingController to IScanbotCameraView
attach(cameraView, frameHandler) - Method in class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController.Companion
Convenience method for attaching class IdCardAutoSnappingController to IScanbotCameraView
attach(cameraView, idCardScanner, shouldRecognize) - Static method in class io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler
Convenience method for creating new class IdCardScannerFrameHandler and adding it as FrameHandler to given camera view.
attach(cameraView, idCardScanner, shouldRecognize) - Method in class io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler.Companion
Convenience method for creating new class IdCardScannerFrameHandler and adding it as FrameHandler to given camera view.

C

cleanupIdCardImagesDirectory() - Method in class io.scanbot.sdk.persistance.IdCardFileStorage
Cleans a directory with all stored id card images stored
clearResultHandlers() - Method in class io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler
Unregisters all handlers. If nothing was registered before, nothing happens.
Companion - Static variable in class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController
 
Companion - Static variable in class io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler
 
Companion - Static variable in enum io.scanbot.sdk.idcardscanner.IdScanResult.DocumentType
 
Companion - Static variable in class io.scanbot.sdk.persistance.IdCardFileStorage
 
component1() - Method in class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController.Param
status of current frame
component1() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
Recognition status
component1() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult.Field
Type of field
component2() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
Type of detected document
component2() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult.Field
Cropped image part for given field
component3() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
Contains list of
component3() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult.Field
Recognized text
component4() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
Contains list of
component4() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult.Field
Recognition confidence
component5() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
Contains list of
component6() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
Contains cropped IdCard image if it was detected
copy(status) - Method in class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController.Param
Data holder for info needed for frame validation.
copy(status, documentType, fields, mrzFields, mrzCheckDigits, croppedImage) - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
Container for results of interface IdCardScanner
copy(type, visualSource, text, textConfidence) - Method in class io.scanbot.sdk.idcardscanner.IdScanResult.Field
Container for detected field data

D

DefaultIdCardScanner - Class in io.scanbot.sdk.idcardscanner
Default implementation for interface IdCardScanner
DefaultIdCardScanner(blobManager) - Constructor for class io.scanbot.sdk.idcardscanner.DefaultIdCardScanner
Default implementation for interface IdCardScanner
detach() - Method in class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController
 
DocumentType.Companion - Class in io.scanbot.sdk.idcardscanner
 

E

equals(p) - Method in class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController.Param
 
equals(p) - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
 
equals(p) - Method in class io.scanbot.sdk.idcardscanner.IdScanResult.Field
 

F

Field(type, visualSource, text, textConfidence) - Constructor for class io.scanbot.sdk.idcardscanner.IdScanResult.Field
Container for detected field data
Field.Type - Enum in io.scanbot.sdk.idcardscanner
Possible ID card fields enumerated

G

getAcceptedDocumentTypes() - Method in class io.scanbot.sdk.idcardscanner.DefaultIdCardScanner
Accepted document types. All other document types will be ignored.
getAcceptedDocumentTypes() - Method in interface io.scanbot.sdk.idcardscanner.IdCardScanner
Deprecated.
Accepted document types. All other document types will be ignored.
getAcceptedDocumentTypes() - Method in class io.scanbot.sdk.idcardscanner.StubIdCardScanner
Accepted document types. All other document types will be ignored.
getAcceptedSharpnessScore() - Method in class io.scanbot.sdk.idcardscanner.DefaultIdCardScanner
Accepted minimal sharpness score. Images with a score less than that will be rejected with RecognitionStatus::ErrorTooBlurry.
getAcceptedSharpnessScore() - Method in interface io.scanbot.sdk.idcardscanner.IdCardScanner
Deprecated.
Accepted minimal sharpness score. Images with a score less than that will be rejected with RecognitionStatus::ErrorTooBlurry.
getAcceptedSharpnessScore() - Method in class io.scanbot.sdk.idcardscanner.StubIdCardScanner
Accepted minimal sharpness score. Images with a score less than that will be rejected with RecognitionStatus::ErrorTooBlurry.
getCroppedImage() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
Contains cropped IdCard image if it was detected
getDEFAULT_TYPES() - Method in class io.scanbot.sdk.idcardscanner.DocumentType.Companion
Default document types supported by IdCardScanner
getDEFAULT_TYPES() - Static method in enum io.scanbot.sdk.idcardscanner.IdScanResult.DocumentType
Default document types supported by IdCardScanner
getDocumentType() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
Type of detected document
getFields() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
Contains list of
getIdCardImagesDirectory() - Method in class io.scanbot.sdk.persistance.IdCardFileStorage
Provides directory which store all id card images images
getMrzCheckDigits() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
Contains list of
getMrzFields() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
Contains list of
getStatus() - Method in class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController.Param
status of current frame
getStatus() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
Recognition status
getText() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult.Field
Recognized text
getTextConfidence() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult.Field
Recognition confidence
getType() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult.Field
Type of field
getVisualSource() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult.Field
Cropped image part for given field

H

handleFrame(previewFrame) - Method in class io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler
 
hashCode() - Method in class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController.Param
 
hashCode() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult.Field
 
hashCode() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
 

I

IdCardAutoSnappingController - Class in io.scanbot.sdk.idcardscanner
Controls auto-snapping for id card scanning.
IdCardAutoSnappingController(cameraView, idCardScannerFrameHandler, needDetachFromView) - Constructor for class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController
Controls auto-snapping for id card scanning.
IdCardAutoSnappingController(cameraView, idCardScannerFrameHandler) - Constructor for class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController
 
IdCardAutoSnappingController.Companion - Class in io.scanbot.sdk.idcardscanner
 
IdCardAutoSnappingController.Param - Class in io.scanbot.sdk.idcardscanner
Data holder for info needed for frame validation.
IdCardFileStorage - Class in io.scanbot.sdk.persistance
File storage for Id Card scan images
IdCardFileStorage(application) - Constructor for class io.scanbot.sdk.persistance.IdCardFileStorage
File storage for Id Card scan images
IdCardFileStorage.Companion - Class in io.scanbot.sdk.persistance
 
IdCardResultsMappingKt - Class in io.scanbot.sdk.idcardscanner
 
IdCardScanner - Interface in io.scanbot.sdk.idcardscanner
Deprecated. 
IdCardScannerFrameHandler - Class in io.scanbot.sdk.idcardscanner
Performs ID card data detection on camera preview frames. Outputs results via interface IdCardScannerFrameHandler.ResultHandler.
IdCardScannerFrameHandler(idCardScanner, shouldRecognize) - Constructor for class io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler
Performs ID card data detection on camera preview frames. Outputs results via interface IdCardScannerFrameHandler.ResultHandler.
IdCardScannerFrameHandler.Companion - Class in io.scanbot.sdk.idcardscanner
 
IdCardScannerFrameHandler.IdCardScannerResultHandler - Class in io.scanbot.sdk.idcardscanner
Successor-class needed for cross-platform implementation
IdCardScannerFrameHandler.ResultHandler - Interface in io.scanbot.sdk.idcardscanner
 
IdCardScannerResultHandler() - Constructor for class io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler.IdCardScannerResultHandler
Successor-class needed for cross-platform implementation
IdScanResult - Class in io.scanbot.sdk.idcardscanner
Container for results of interface IdCardScanner
IdScanResult(status, documentType, fields, mrzFields, mrzCheckDigits, croppedImage) - Constructor for class io.scanbot.sdk.idcardscanner.IdScanResult
Container for results of interface IdCardScanner
IdScanResult.DocumentType - Enum in io.scanbot.sdk.idcardscanner
Type of detected document
IdScanResult.Field - Class in io.scanbot.sdk.idcardscanner
Container for detected field data
IdScanResult.RecognitionStatus - Enum in io.scanbot.sdk.idcardscanner
Enumerated ID card scan attempt result status
io.scanbot.sdk.idcardscanner - package io.scanbot.sdk.idcardscanner
 
io.scanbot.sdk.persistance - package io.scanbot.sdk.persistance
 
isEnabled() - Method in class io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler
Parameter determines if ID card detection is enabled. In case of false value incoming frames are skipped.

P

Param(status) - Constructor for class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController.Param
Data holder for info needed for frame validation.

R

removeResultHandler(resultHandler) - Method in class io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler
Unregisters handler.
runPredicates(param) - Method in class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController
 

S

scanBitmap(bitmap, shouldRecognize, orientation) - Method in class io.scanbot.sdk.idcardscanner.DefaultIdCardScanner
Scan image to detect ID card and data on it
scanBitmap(bitmap, shouldRecognize, orientation) - Method in interface io.scanbot.sdk.idcardscanner.IdCardScanner
Deprecated.
Scan image to detect ID card and data on it
scanBitmap(bitmap, shouldRecognize, orientation) - Method in class io.scanbot.sdk.idcardscanner.StubIdCardScanner
Scan image to detect ID card and data on it
scanJpeg(jpeg, shouldRecognize, orientation) - Method in class io.scanbot.sdk.idcardscanner.DefaultIdCardScanner
Scan image to detect ID card and data on it
scanJpeg(jpeg, shouldRecognize, orientation) - Method in interface io.scanbot.sdk.idcardscanner.IdCardScanner
Deprecated.
Scan image to detect ID card and data on it
scanJpeg(jpeg, shouldRecognize, orientation) - Method in class io.scanbot.sdk.idcardscanner.StubIdCardScanner
Scan image to detect ID card and data on it
scanNv21(nv21, width, height, orientation, finderRect, shouldRecognize) - Method in class io.scanbot.sdk.idcardscanner.DefaultIdCardScanner
Scan image to detect ID card and data on it
scanNv21(nv21, width, height, orientation, finderRect, shouldRecognize) - Method in interface io.scanbot.sdk.idcardscanner.IdCardScanner
Deprecated.
Scan image to detect ID card and data on it
scanNv21(nv21, width, height, orientation, finderRect, shouldRecognize) - Method in class io.scanbot.sdk.idcardscanner.StubIdCardScanner
Scan image to detect ID card and data on it
setAcceptedDocumentTypes(value) - Method in class io.scanbot.sdk.idcardscanner.DefaultIdCardScanner
Accepted document types. All other document types will be ignored.
setAcceptedDocumentTypes(p) - Method in interface io.scanbot.sdk.idcardscanner.IdCardScanner
Deprecated.
Accepted document types. All other document types will be ignored.
setAcceptedDocumentTypes(p) - Method in class io.scanbot.sdk.idcardscanner.StubIdCardScanner
Accepted document types. All other document types will be ignored.
setAcceptedSharpnessScore(value) - Method in class io.scanbot.sdk.idcardscanner.DefaultIdCardScanner
Accepted minimal sharpness score. Images with a score less than that will be rejected with RecognitionStatus::ErrorTooBlurry.
setAcceptedSharpnessScore(p) - Method in interface io.scanbot.sdk.idcardscanner.IdCardScanner
Deprecated.
Accepted minimal sharpness score. Images with a score less than that will be rejected with RecognitionStatus::ErrorTooBlurry.
setAcceptedSharpnessScore(p) - Method in class io.scanbot.sdk.idcardscanner.StubIdCardScanner
Accepted minimal sharpness score. Images with a score less than that will be rejected with RecognitionStatus::ErrorTooBlurry.
setEnabled(p) - Method in class io.scanbot.sdk.idcardscanner.IdCardScannerFrameHandler
Parameter determines if ID card detection is enabled. In case of false value incoming frames are skipped.
StubIdCardScanner - Class in io.scanbot.sdk.idcardscanner
Stub implementation of interface IdCardScanner - returns null's for all calls
StubIdCardScanner() - Constructor for class io.scanbot.sdk.idcardscanner.StubIdCardScanner
Stub implementation of interface IdCardScanner - returns null's for all calls

T

toString() - Method in class io.scanbot.sdk.idcardscanner.IdCardAutoSnappingController.Param
 
toString() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult.Field
 
toString() - Method in class io.scanbot.sdk.idcardscanner.IdScanResult
 
< A C D E F G H I P R S T 
Skip navigation links