Android Scanbot SDK API reference

7.1.0

Android Scanbot SDK API reference/io.scanbot.sdk.ui.view.textpattern.entity/TextPatternScannerStep

TextPatternScannerStep

data class TextPatternScannerStep(val stepTag: String, val title: String, val guidanceText: String, val pattern: String? = null, val shouldMatchSubstring: Boolean = false, val validationCallback: TextPatternScannerStep.TextPatternScanningValidationCallback? = null, val cleanRecognitionResultCallback: TextPatternScannerStep.CleanScanningResultCallback? = null, val preferredZoom: Float = 1.4f, val aspectRatio: AspectRatio = AspectRatio(4.0, 1.0), val unzoomedFinderHeight: Float = DEFAULT_FINDER_HEIGHT, val allowedSymbols: Set<Char> = setOf(), val significantShakeDelay: Long = SIGNIFICANT_DELAY_DEFAULT)

Defines a single step of the data scanning flow.

Constructors

TextPatternScannerStep

constructor(stepTag: String, title: String, guidanceText: String, pattern: String? = null, shouldMatchSubstring: Boolean = false, validationCallback: TextPatternScannerStep.TextPatternScanningValidationCallback? = null, cleanRecognitionResultCallback: TextPatternScannerStep.CleanScanningResultCallback? = null, preferredZoom: Float = 1.4f, aspectRatio: AspectRatio = AspectRatio(4.0, 1.0), unzoomedFinderHeight: Float = DEFAULT_FINDER_HEIGHT, allowedSymbols: Set<Char> = setOf(), significantShakeDelay: Long = SIGNIFICANT_DELAY_DEFAULT)

Types

CleanScanningResultCallback

interface CleanScanningResultCallback

Optional callback to clean scanned string prior to validation. Allows to increase the quality and speed of the scanning.

object Companion

TextPatternScanningValidationCallback

interface TextPatternScanningValidationCallback

Callback for the scanned text validation.

Properties

val allowedSymbols: Set<Char>

Allowed symbols to be detected.

val aspectRatio: AspectRatio

Aspect ratio for the step.

cleanRecognitionResultCallback

val cleanRecognitionResultCallback: TextPatternScannerStep.CleanScanningResultCallback? = null

Callback to clean scanned string prior to validation.

val guidanceText: String

User guidance for the step.

val pattern: String? = null

Sets a validation pattern. Supports ? - any character and # - any digit, all other characters represent themselves.

val preferredZoom: Float = 1.4f

Zoom level required for this step.

shouldMatchSubstring

val shouldMatchSubstring: Boolean = false

Find and match only part of the whole string if the pattern is used.

significantShakeDelay

val significantShakeDelay: Long

Detection will be paused after significant movement. 0 by default.

val stepTag: String

The tag of the scanning step to make. It will be indicated in the result.

val title: String

Title for a value.

unzoomedFinderHeight

val unzoomedFinderHeight: Float

Height of the finder when view "unzoomed" (for zoom-level 1.0). Defaults to 40.

validationCallback

val validationCallback: TextPatternScannerStep.TextPatternScanningValidationCallback? = null

Callback for text validation.

Functions

fun TextPatternScannerStep.toJson(): JsonTextDataScannerStep

Creates a JSON object from screen configuration object.