Index

< A C D E G H I L P R S T

<

<no name provided>() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler: Continuously notified about document recognition results.

A

addResult(result) - Method in class io.scanbot.sdk.genericdocument.result.GenericDocumentResultRepository
addResultHandler(resultHandler) - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler: Registers result handler which will be notified about Generic Document results.
attach(cameraView, genericDocumentRecognizer) - Static method in class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController: Convenience method for attaching class GenericDocumentAutoSnappingController to IScanbotCameraView
attach(cameraView, frameHandler) - Static method in class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController: Convenience method for attaching class GenericDocumentAutoSnappingController to IScanbotCameraView
attach(cameraView, genericDocumentRecognizer) - Method in class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController.Companion: Convenience method for attaching class GenericDocumentAutoSnappingController to IScanbotCameraView
attach(cameraView, frameHandler) - Method in class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController.Companion: Convenience method for attaching class GenericDocumentAutoSnappingController to IScanbotCameraView
attach(cameraView, genericDocumentRecognizer, shouldRecognize) - Static method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler: Convenience method for creating new class GenericDocumentRecognizerFrameHandler and adding it as FrameHandler to given camera view.
attach(cameraView, genericDocumentRecognizer, shouldRecognize) - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler.Companion: Convenience method for creating new class GenericDocumentRecognizerFrameHandler and adding it as FrameHandler to given camera view.

C

clear() - Method in class io.scanbot.sdk.genericdocument.DefaultGenericDocumentRecognizer: Clears the result accumulation cache (for live detection)
clear() - Method in interface io.scanbot.sdk.genericdocument.GenericDocumentRecognizer: Clears the result accumulation cache (for live detection)
clear() - Method in class io.scanbot.sdk.genericdocument.result.GenericDocumentResultLruStorage
clear() - Method in class io.scanbot.sdk.genericdocument.result.GenericDocumentResultRepository
clear() - Method in class io.scanbot.sdk.genericdocument.StubGenericDocumentRecognizer: Clears the result accumulation cache (for live detection)
clearResultHandlers() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler: Unregisters all handlers. If nothing was registered before, nothing happens.
Companion - Static variable in class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController
Companion - Static variable in class io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler
Companion - Static variable in class io.scanbot.sdk.genericdocument.result.GenericDocumentResultLruStorage
component1() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController.Param: status of current frame
component1() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognitionResult: Recognition status
component2() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognitionResult: Contains cropped document image if it was detected
component3() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognitionResult: Contains a document which might be wrapped into one of io.scanbot.genericdocument.entity models
copy(status) - Method in class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController.Param: Data holder for info needed for frame validation.
copy(status, croppedImage, document) - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognitionResult: Container for results of interface GenericDocumentRecognizer

D

DefaultGenericDocumentRecognizer - Class in io.scanbot.sdk.genericdocument: Default implementation for interface GenericDocumentRecognizer
DefaultGenericDocumentRecognizer(blobManager) - Constructor for class io.scanbot.sdk.genericdocument.DefaultGenericDocumentRecognizer: Default implementation for interface GenericDocumentRecognizer
detach() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController

E

equals(p) - Method in class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController.Param
equals(p) - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognitionResult

G

GenericDocumentAutoSnappingController - Class in io.scanbot.sdk.genericdocument: Controls auto-snapping for generic document scanning.
GenericDocumentAutoSnappingController(cameraView, genericDocumentRecognizerFrameHandler, needDetachFromView) - Constructor for class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController: Controls auto-snapping for generic document scanning.
GenericDocumentAutoSnappingController(cameraView, frameHandler) - Constructor for class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController
GenericDocumentAutoSnappingController.Companion - Class in io.scanbot.sdk.genericdocument
GenericDocumentAutoSnappingController.Param - Class in io.scanbot.sdk.genericdocument: Data holder for info needed for frame validation.
GenericDocumentRecognitionResult - Class in io.scanbot.sdk.genericdocument: Container for results of interface GenericDocumentRecognizer
GenericDocumentRecognitionResult(status, croppedImage, document) - Constructor for class io.scanbot.sdk.genericdocument.GenericDocumentRecognitionResult: Container for results of interface GenericDocumentRecognizer
GenericDocumentRecognitionResult.RecognitionStatus - Enum in io.scanbot.sdk.genericdocument: Enumerated result status of the recognition
GenericDocumentRecognizer - Interface in io.scanbot.sdk.genericdocument: Component to scan image, detect different documents of known types, perform image optimization, cropping and (optionally) fields detection and fields' data recognition
GenericDocumentRecognizerFrameHandler - Class in io.scanbot.sdk.genericdocument: Performs document recognition on camera preview frames. Outputs results via interface GenericDocumentRecognizerFrameHandler.ResultHandler.
GenericDocumentRecognizerFrameHandler(genericDocumentRecognizer, shouldRecognize) - Constructor for class io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler: Performs document recognition on camera preview frames. Outputs results via interface GenericDocumentRecognizerFrameHandler.ResultHandler.
GenericDocumentRecognizerFrameHandler.Companion - Class in io.scanbot.sdk.genericdocument
GenericDocumentRecognizerFrameHandler.GenericDocumentRecognizerResultHandler - Class in io.scanbot.sdk.genericdocument: Successor-class needed for cross-platform implementation
GenericDocumentRecognizerFrameHandler.ResultHandler - Interface in io.scanbot.sdk.genericdocument
GenericDocumentRecognizerResultHandler() - Constructor for class io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler.GenericDocumentRecognizerResultHandler: Successor-class needed for cross-platform implementation
GenericDocumentResultLruStorage - Class in io.scanbot.sdk.genericdocument.result: Stores and provides access to the scanning result of the given type by ResultId This implementation uses LRU cache as a storage to keep the memory usage low even if many results will be added to the storage
GenericDocumentResultLruStorage() - Constructor for class io.scanbot.sdk.genericdocument.result.GenericDocumentResultLruStorage: Stores and provides access to the scanning result of the given type by ResultId This implementation uses LRU cache as a storage to keep the memory usage low even if many results will be added to the storage
GenericDocumentResultLruStorage.Companion - Class in io.scanbot.sdk.genericdocument.result
GenericDocumentResultRepository - Class in io.scanbot.sdk.genericdocument.result: Provides access to the scanning result of the given type by ResultId The current implementation of the repository keeps the result only in RAM and does not store anything on the persistent storage It is important to persist the data manually if it is needed to be used after the restart of the process of the application Be careful when processing the intent with ResultId in onCreate method of the Activity as it may be recreated after the termination of the process
GenericDocumentResultRepository(storage) - Constructor for class io.scanbot.sdk.genericdocument.result.GenericDocumentResultRepository: Provides access to the scanning result of the given type by ResultId The current implementation of the repository keeps the result only in RAM and does not store anything on the persistent storage It is important to persist the data manually if it is needed to be used after the restart of the process of the application Be careful when processing the intent with ResultId in onCreate method of the Activity as it may be recreated after the termination of the process
GenericDocumentResultsMappingKt - Class in io.scanbot.sdk.genericdocument
getAcceptedDocumentTypes() - Method in class io.scanbot.sdk.genericdocument.DefaultGenericDocumentRecognizer: Accepted document types. All other document types will be ignored.
getAcceptedDocumentTypes() - Method in interface io.scanbot.sdk.genericdocument.GenericDocumentRecognizer: Accepted document types. All other document types will be ignored.
getAcceptedDocumentTypes() - Method in class io.scanbot.sdk.genericdocument.StubGenericDocumentRecognizer: Accepted document types. All other document types will be ignored.
getAcceptedSharpnessScore() - Method in class io.scanbot.sdk.genericdocument.DefaultGenericDocumentRecognizer: Accepted minimal sharpness score. Images with a score less than that will be rejected with GenericDocumentRecognitionResult.RecognitionStatus.ErrorTooBlurry.
getAcceptedSharpnessScore() - Method in interface io.scanbot.sdk.genericdocument.GenericDocumentRecognizer: Accepted minimal sharpness score. Images with a score less than that will be rejected with GenericDocumentRecognitionResult.RecognitionStatus.ErrorTooBlurry.
getAcceptedSharpnessScore() - Method in class io.scanbot.sdk.genericdocument.StubGenericDocumentRecognizer: Accepted minimal sharpness score. Images with a score less than that will be rejected with GenericDocumentRecognitionResult.RecognitionStatus.ErrorTooBlurry.
getAcceptedType() - Method in class io.scanbot.sdk.genericdocument.result.GenericDocumentResultRepository
getCroppedImage() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognitionResult: Contains cropped document image if it was detected
getDocument() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognitionResult: Contains a document which might be wrapped into one of io.scanbot.genericdocument.entity models
getResult(resultId) - Method in class io.scanbot.sdk.genericdocument.result.GenericDocumentResultLruStorage
getResult(resultId) - Method in class io.scanbot.sdk.genericdocument.result.GenericDocumentResultRepository
getResultAndErase(resultId) - Method in class io.scanbot.sdk.genericdocument.result.GenericDocumentResultRepository
getStatus() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController.Param: status of current frame
getStatus() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognitionResult: Recognition status
getStorage() - Method in class io.scanbot.sdk.genericdocument.result.GenericDocumentResultRepository

H

handleFrame(previewFrame) - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler
hashCode() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController.Param
hashCode() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognitionResult

I

io.scanbot.sdk.genericdocument - package io.scanbot.sdk.genericdocument
io.scanbot.sdk.genericdocument.result - package io.scanbot.sdk.genericdocument.result
isEnabled() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler: Parameter determines if document detection is enabled. In case of false value incoming frames are skipped.

L

LRU_CACHE_SIZE - Static variable in class io.scanbot.sdk.genericdocument.result.GenericDocumentResultLruStorage: The size of the LRU Cache. Currently is 32 Mb

P

Param(status) - Constructor for class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController.Param: Data holder for info needed for frame validation.
putResult(resultId, result) - Method in class io.scanbot.sdk.genericdocument.result.GenericDocumentResultLruStorage

R

removeResult(resultId) - Method in class io.scanbot.sdk.genericdocument.result.GenericDocumentResultLruStorage
removeResult(resultId) - Method in class io.scanbot.sdk.genericdocument.result.GenericDocumentResultRepository
removeResultHandler(resultHandler) - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognizerFrameHandler: Unregisters handler.
runPredicates(param) - Method in class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController

S

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

T

toString() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentAutoSnappingController.Param
toString() - Method in class io.scanbot.sdk.genericdocument.GenericDocumentRecognitionResult

< A C D E G H I L P R S T