Skip navigation links
< A C D E G H I O P R S T U V W 

<

<no name provided>() - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Callback for text validation
<no name provided>() - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Optional callback to clean recognized string prior to validation. Allows to increase the quality and speed of the recognition
<no name provided>() - Method in class io.scanbot.sdk.generictext.GenericTextRecognizerFrameHandler
Continuously notified about generic text recognition results.

A

addResultHandler(resultHandler) - Method in class io.scanbot.sdk.generictext.GenericTextRecognizerFrameHandler
Registers result handler which will be notified about generic text recognition results.
attach(cameraView, genericTextRecognizer) - Static method in class io.scanbot.sdk.generictext.GenericTextRecognizerFrameHandler
Convenience method for creating new class GenericTextRecognizerFrameHandler and adding it as FrameHandler to given camera view.
attach(cameraView, genericTextRecognizer) - Method in class io.scanbot.sdk.generictext.GenericTextRecognizerFrameHandler.Companion
Convenience method for creating new class GenericTextRecognizerFrameHandler and adding it as FrameHandler to given camera view.

C

cleanRecognitionQueue() - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Allows to clean the accumulated frames inside the recognizer. Should be called if reusing the instance after getting the successful result
cleanRecognitionQueue() - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Allows to clean the accumulated frames inside the recognizer. Should be called if reusing the instance after getting the successful result
cleanRecognitionQueue() - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Allows to clean the accumulated frames inside the recognizer. Should be called if reusing the instance after getting the successful result
clearResultHandlers() - Method in class io.scanbot.sdk.generictext.GenericTextRecognizerFrameHandler
Unregisters all handlers. If nothing was registered before, nothing happens.
Companion - Static variable in class io.scanbot.sdk.generictext.GenericTextRecognizerFrameHandler
 
Companion - Static variable in class io.scanbot.sdk.generictext.ui.WordboxPreviewView
 
component1() - Method in class io.scanbot.sdk.generictext.GenericTextRecognitionResult
raw detected text
component1() - Method in class io.scanbot.sdk.generictext.GenericTextWordBox
detected word
component2() - Method in class io.scanbot.sdk.generictext.GenericTextRecognitionResult
confidence of the recognition
component2() - Method in class io.scanbot.sdk.generictext.GenericTextWordBox
confidence of symbol recognition
component3() - Method in class io.scanbot.sdk.generictext.GenericTextRecognitionResult
list of detected words
component3() - Method in class io.scanbot.sdk.generictext.GenericTextWordBox
rect with a character in coordinates of the picture
component4() - Method in class io.scanbot.sdk.generictext.GenericTextRecognitionResult
if the recognition and validation was successful
copy(rawText, confidenceValue, wordBoxes, validationSuccessful) - Method in class io.scanbot.sdk.generictext.GenericTextRecognitionResult
Recognition result of generic text scanner
copy(word, confidenceValue, boundingRect) - Method in class io.scanbot.sdk.generictext.GenericTextWordBox
Represents one word in detected text

D

DefaultGenericTextRecognizer - Class in io.scanbot.sdk.generictext
Default implementation for interface GenericTextRecognizer
DefaultGenericTextRecognizer(blobManager) - Constructor for class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Default implementation for interface GenericTextRecognizer

E

equals(p) - Method in class io.scanbot.sdk.generictext.GenericTextRecognitionResult
 
equals(p) - Method in class io.scanbot.sdk.generictext.GenericTextWordBox
 

G

GenericTextRecognitionResult - Class in io.scanbot.sdk.generictext
Recognition result of generic text scanner
GenericTextRecognitionResult(rawText, confidenceValue, wordBoxes, validationSuccessful) - Constructor for class io.scanbot.sdk.generictext.GenericTextRecognitionResult
Recognition result of generic text scanner
GenericTextRecognizer - Interface in io.scanbot.sdk.generictext
Component to scan image, recognize text on it and validate the recognized text
GenericTextRecognizer.CleanRecognitionResultCallback - Interface in io.scanbot.sdk.generictext
 
GenericTextRecognizer.GenericTextValidationCallback - Interface in io.scanbot.sdk.generictext
 
GenericTextRecognizerFrameHandler - Class in io.scanbot.sdk.generictext
Performs generic text recognition on camera preview frames. Outputs results via interface GenericTextRecognizerFrameHandler.ResultHandler.
GenericTextRecognizerFrameHandler(genericTextRecognizer) - Constructor for class io.scanbot.sdk.generictext.GenericTextRecognizerFrameHandler
Performs generic text recognition on camera preview frames. Outputs results via interface GenericTextRecognizerFrameHandler.ResultHandler.
GenericTextRecognizerFrameHandler.Companion - Class in io.scanbot.sdk.generictext
 
GenericTextRecognizerFrameHandler.ResultHandler - Interface in io.scanbot.sdk.generictext
 
GenericTextRecognizerFrameHandler.TextRecognitionScannerResultHandler - Class in io.scanbot.sdk.generictext
Successor-class needed for cross-platform implementation
GenericTextWordBox - Class in io.scanbot.sdk.generictext
Represents one word in detected text
GenericTextWordBox(word, confidenceValue, boundingRect) - Constructor for class io.scanbot.sdk.generictext.GenericTextWordBox
Represents one word in detected text
getAllowedSymbols() - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Allowed symbols to be detected
getAllowedSymbols() - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Allowed symbols to be detected
getAllowedSymbols() - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Allowed symbols to be detected
getBoundingRect() - Method in class io.scanbot.sdk.generictext.GenericTextWordBox
rect with a character in coordinates of the picture
getConfidenceValue() - Method in class io.scanbot.sdk.generictext.GenericTextRecognitionResult
confidence of the recognition
getConfidenceValue() - Method in class io.scanbot.sdk.generictext.GenericTextWordBox
confidence of symbol recognition
getFrameHeight() - Method in class io.scanbot.sdk.generictext.ui.WordboxPreviewView
 
getFrameOrientation() - Method in class io.scanbot.sdk.generictext.ui.WordboxPreviewView
 
getFrameWidth() - Method in class io.scanbot.sdk.generictext.ui.WordboxPreviewView
 
getMatchSubstringForPattern() - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Find and match only part of the whole string if the pattern is used
getMatchSubstringForPattern() - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Find and match only part of the whole string if the pattern is used
getMatchSubstringForPattern() - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Find and match only part of the whole string if the pattern is used
getMaximumNumberOfAccumulatedFrames() - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Maximum number of accumulated frames to inspect before actual result is returned
getMaximumNumberOfAccumulatedFrames() - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Maximum number of accumulated frames to inspect before actual result is returned
getMaximumNumberOfAccumulatedFrames() - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Maximum number of accumulated frames to inspect before actual result is returned
getMinimumNumberOfRequiredFramesWithEqualRecognitionResult() - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Minimum number of accumulated frames that have equal result
getMinimumNumberOfRequiredFramesWithEqualRecognitionResult() - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Minimum number of accumulated frames that have equal result
getMinimumNumberOfRequiredFramesWithEqualRecognitionResult() - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Minimum number of accumulated frames that have equal result
getOcrResolutionLimit() - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
The image will be downscaled to the given value during the processing. If the quality of the scanning is not enough, try to increase the limit. This variable affects the performance of the scanning process. Higher the size limit - better the quality, but the recognition is slower
getOcrResolutionLimit() - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
The image will be downscaled to the given value during the processing. If the quality of the scanning is not enough, try to increase the limit. This variable affects the performance of the scanning process. Higher the size limit - better the quality, but the recognition is slower
getOcrResolutionLimit() - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
The image will be downscaled to the given value during the processing. If the quality of the scanning is not enough, try to increase the limit. This variable affects the performance of the scanning process. Higher the size limit - better the quality, but the recognition is slower
getRawText() - Method in class io.scanbot.sdk.generictext.GenericTextRecognitionResult
raw detected text
getSupportedLanguages() - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Languages on which the recognition will be run
getSupportedLanguages() - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Languages on which the recognition will be run
getSupportedLanguages() - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Languages on which the recognition will be run
getTextFilterStrategy() - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Additional parameter to set the type of the scanned object. TextFilterStrategy.Document by default
getTextFilterStrategy() - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Additional parameter to set the type of the scanned object. TextFilterStrategy.Document by default
getTextFilterStrategy() - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Additional parameter to set the type of the scanned object. TextFilterStrategy.Document by default
getValidationSuccessful() - Method in class io.scanbot.sdk.generictext.GenericTextRecognitionResult
if the recognition and validation was successful
getWord() - Method in class io.scanbot.sdk.generictext.GenericTextWordBox
detected word
getWordBoxes() - Method in class io.scanbot.sdk.generictext.GenericTextRecognitionResult
list of detected words

H

handleFrame(previewFrame) - Method in class io.scanbot.sdk.generictext.GenericTextRecognizerFrameHandler
 
hashCode() - Method in class io.scanbot.sdk.generictext.GenericTextRecognitionResult
 
hashCode() - Method in class io.scanbot.sdk.generictext.GenericTextWordBox
 

I

io.scanbot.sdk.generictext - package io.scanbot.sdk.generictext
 
io.scanbot.sdk.generictext.ui - package io.scanbot.sdk.generictext.ui
 
isEnabled() - Method in class io.scanbot.sdk.generictext.GenericTextRecognizerFrameHandler
Parameter determines if text recognition is enabled. In case of false value incoming frames are skipped.

O

onDraw(canvas) - Method in class io.scanbot.sdk.generictext.ui.WordboxPreviewView
 

P

process(rawText) - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer.CleanRecognitionResultCallback
Cleans the raw text extracted from the picture and extracts only valuable part from it

R

removeResultHandler(resultHandler) - Method in class io.scanbot.sdk.generictext.GenericTextRecognizerFrameHandler
Unregisters handler.

S

scanNv21(nv21, width, height, orientation, finderRect) - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Scan image to recognize text on it
scanNv21(nv21, width, height, orientation, finderRect) - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Scan image to recognize text on it
scanNv21(nv21, width, height, orientation, finderRect) - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Scan image to recognize text on it
setAllowedSymbols(value) - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Allowed symbols to be detected
setAllowedSymbols(p) - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Allowed symbols to be detected
setAllowedSymbols(value) - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Allowed symbols to be detected
setCleaner(callback) - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Sets the cleaner for the raw text to prepare the raw recognized string to validation. Allows to increase the quality and speed of the recognition
setCleaner(callback) - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Sets the cleaner for the raw text to prepare the raw recognized string to validation. Allows to increase the quality and speed of the recognition
setCleaner(callback) - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Sets the cleaner for the raw text to prepare the raw recognized string to validation. Allows to increase the quality and speed of the recognition
setColor(strokeColor) - Method in class io.scanbot.sdk.generictext.ui.WordboxPreviewView
Changes stroke color of the polygon.
setEnabled(p) - Method in class io.scanbot.sdk.generictext.GenericTextRecognizerFrameHandler
Parameter determines if text recognition is enabled. In case of false value incoming frames are skipped.
setFrameHeight(p) - Method in class io.scanbot.sdk.generictext.ui.WordboxPreviewView
 
setFrameOrientation(p) - Method in class io.scanbot.sdk.generictext.ui.WordboxPreviewView
 
setFrameWidth(p) - Method in class io.scanbot.sdk.generictext.ui.WordboxPreviewView
 
setMatchSubstringForPattern(value) - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Find and match only part of the whole string if the pattern is used
setMatchSubstringForPattern(p) - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Find and match only part of the whole string if the pattern is used
setMatchSubstringForPattern(value) - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Find and match only part of the whole string if the pattern is used
setMaximumNumberOfAccumulatedFrames(value) - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Maximum number of accumulated frames to inspect before actual result is returned
setMaximumNumberOfAccumulatedFrames(p) - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Maximum number of accumulated frames to inspect before actual result is returned
setMaximumNumberOfAccumulatedFrames(value) - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Maximum number of accumulated frames to inspect before actual result is returned
setMinimumNumberOfRequiredFramesWithEqualRecognitionResult(value) - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Minimum number of accumulated frames that have equal result
setMinimumNumberOfRequiredFramesWithEqualRecognitionResult(p) - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Minimum number of accumulated frames that have equal result
setMinimumNumberOfRequiredFramesWithEqualRecognitionResult(value) - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Minimum number of accumulated frames that have equal result
setOcrResolutionLimit(value) - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
The image will be downscaled to the given value during the processing. If the quality of the scanning is not enough, try to increase the limit. This variable affects the performance of the scanning process. Higher the size limit - better the quality, but the recognition is slower
setOcrResolutionLimit(p) - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
The image will be downscaled to the given value during the processing. If the quality of the scanning is not enough, try to increase the limit. This variable affects the performance of the scanning process. Higher the size limit - better the quality, but the recognition is slower
setOcrResolutionLimit(value) - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
The image will be downscaled to the given value during the processing. If the quality of the scanning is not enough, try to increase the limit. This variable affects the performance of the scanning process. Higher the size limit - better the quality, but the recognition is slower
setSupportedLanguages(value) - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Languages on which the recognition will be run
setSupportedLanguages(p) - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Languages on which the recognition will be run
setSupportedLanguages(value) - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Languages on which the recognition will be run
setTextFilterStrategy(value) - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Additional parameter to set the type of the scanned object. TextFilterStrategy.Document by default
setTextFilterStrategy(p) - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Additional parameter to set the type of the scanned object. TextFilterStrategy.Document by default
setTextFilterStrategy(value) - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Additional parameter to set the type of the scanned object. TextFilterStrategy.Document by default
setUiZoomLevel(zoomLevel) - Method in class io.scanbot.sdk.generictext.ui.WordboxPreviewView
 
setValidator(validator, callback) - Method in class io.scanbot.sdk.generictext.DefaultGenericTextRecognizer
Sets the configuration to use during the validation
setValidator(pattern, callback) - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer
Sets the configuration to use during the validation
setValidator(validator, callback) - Method in class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Sets the configuration to use during the validation
StubGenericTextRecognizer - Class in io.scanbot.sdk.generictext
Stub implementation for interface GenericTextRecognizer - returns null's for all calls
StubGenericTextRecognizer() - Constructor for class io.scanbot.sdk.generictext.StubGenericTextRecognizer
Stub implementation for interface GenericTextRecognizer - returns null's for all calls

T

TextFilterStrategy - Enum in io.scanbot.sdk.generictext
Additional parameter for interface GenericTextRecognizer to set the type of the scanned object
TextRecognitionScannerResultHandler() - Constructor for class io.scanbot.sdk.generictext.GenericTextRecognizerFrameHandler.TextRecognitionScannerResultHandler
Successor-class needed for cross-platform implementation
toString() - Method in class io.scanbot.sdk.generictext.GenericTextRecognitionResult
 
toString() - Method in class io.scanbot.sdk.generictext.GenericTextWordBox
 

U

updateCharacters(list) - Method in class io.scanbot.sdk.generictext.ui.WordboxPreviewView
Sets the list of words to highlight

V

validate(text) - Method in interface io.scanbot.sdk.generictext.GenericTextRecognizer.GenericTextValidationCallback
Validates text and returns if it matches the need of the user

W

WordboxPreviewView - Class in io.scanbot.sdk.generictext.ui
Allows to highlight the words which were recognized by interface GenericTextRecognizer
WordboxPreviewView(context) - Constructor for class io.scanbot.sdk.generictext.ui.WordboxPreviewView
 
WordboxPreviewView(context, attrs) - Constructor for class io.scanbot.sdk.generictext.ui.WordboxPreviewView
 
WordboxPreviewView.Companion - Class in io.scanbot.sdk.generictext.ui
 
< A C D E G H I O P R S T U V W 
Skip navigation links