Android Scanbot SDK API reference/io.scanbot.sdk.textpattern

Package-level declarations

Types

ContentValidationCallback

interface ContentValidationCallback : Serializable

Content validation callback.

ContentValidator

sealed class ContentValidator : Parcelable

Base class for content validators.

CustomContentValidator

data class CustomContentValidator(var allowedCharacters: String = "", var callback: ContentValidationCallback? = null) : ContentValidator, Parcelable

Custom content validator.

DefaultContentValidator

data class DefaultContentValidator(var allowedCharacters: String = "") : ContentValidator, Parcelable

Default content validator. Accepts only non-empty strings.

DefaultTextPatternScanner

class DefaultTextPatternScanner : TextPatternScanner

Default implementation for TextPatternScanner.

PatternContentValidator

data class PatternContentValidator(var allowedCharacters: String = "", var pattern: String, var matchSubstring: Boolean = false, var patternGrammar: PatternGrammar = PatternGrammar.WILDCARD) : ContentValidator, Parcelable

Pattern content validator.

PatternGrammar

enum PatternGrammar : Enum<PatternGrammar>

Grammar of pattern matching.

SymbolBox

data class SymbolBox(val symbol: String, val boundingRect: Rect, val recognitionConfidence: Double) : Parcelable

Structure containing recognized symbol text and bounds.

TextPatternScanner

interface TextPatternScanner

Component to scan image, recognize text on it and validate the recognized text.

TextPatternScannerConfiguration

data class TextPatternScannerConfiguration(var ocrResolutionLimit: Int = 0, var maximumNumberOfAccumulatedFrames: Int = 3, var minimumNumberOfRequiredFramesWithEqualScanningResult: Int = 2, var validator: ContentValidator = DefaultContentValidator( )) : Parcelable

Configuration for the text pattern scanner.

TextPatternScannerFrameHandler

class TextPatternScannerFrameHandler(textPatternScanner: TextPatternScanner) : FrameHandler

Performs pattern text scanning on camera preview frames. Outputs results via TextPatternScannerFrameHandler.ResultHandler.

TextPatternScannerResult

data class TextPatternScannerResult(val rawText: String, val wordBoxes: List<WordBox>, val symbolBoxes: List<SymbolBox>, val confidence: Double = 0.0, val validationSuccessful: Boolean = false) : Parcelable

The result of the text line recognition.

WordBox

data class WordBox(val text: String, val boundingRect: Rect, val recognitionConfidence: Double = 0.0) : Parcelable

Structure containing recognized word text and bounds.