TextPatternScannerConfiguration

class TextPatternScannerConfiguration(val config: TextPatternScannerJsonConfiguration, val nativeConfig: TextPatternScannerNativeConfiguration = TextPatternScannerNativeConfiguration())

Class which is used to configure TextPatternScannerActivity Contains settings indicating view's behaviour, texts and appearance.

Constructors

Link copied to clipboard
constructor(step: TextPatternScannerStep)
constructor(config: TextPatternScannerJsonConfiguration, nativeConfig: TextPatternScannerNativeConfiguration = TextPatternScannerNativeConfiguration())

Types

Link copied to clipboard
object Companion

Properties

Functions

Link copied to clipboard
fun setCameraModule(cameraModule: CameraModule)

Set supported camera module: CameraModule.BACK, CameraModule.FRONT or others. Optional. By default is CameraModule.BACK.

Link copied to clipboard
fun setCameraOverlayColor(cameraOverlayColor: Int)

Background color outside of the finder window.

Link copied to clipboard
fun setCameraPreviewMode(cameraPreviewMode: CameraPreviewMode)

Preview mode of the camera: Fit-In or Fill-In. Optional, default is Fill-In.

Link copied to clipboard
fun setCancelButtonIcon(cancelButtonIcon: Int)

Icon of the cancel button.

Link copied to clipboard
fun setCancelButtonTitle(cancelButtonTitle: String)

Title of the cancel button.

Link copied to clipboard
fun setEnableCameraButtonTitle(enableCameraButtonTitle: String)

Title of the button that opens the screen where the user can allow the usage of the camera by the app.

Link copied to clipboard
fun setEnableCameraExplanationText(enableCameraExplanationText: String)

Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.

Link copied to clipboard
fun setFinderLineColor(finderLineColor: Int)

Color of the finder window's outline.

Link copied to clipboard
fun setFinderLineWidth(finderLineWidth: Int)

Thickness of the finder window's outline in Px.

Link copied to clipboard
fun setFinderTextHintColor(finderTextHintColor: Int)

The color of the text with user guidance below the finder view.

Link copied to clipboard
fun setFlashEnabled(flashEnabled: Boolean)

Controls whether the flash should be initially enabled. The default value is FALSE.

Link copied to clipboard

Maximum number of accumulated frames to inspect before actual result is returned.

Minimum number of accumulated frames that have equal result.

Link copied to clipboard
fun setOcrResolutionLimit(ocrResolutionLimit: Int)

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

Link copied to clipboard
fun setOrientationLockMode(cameraOrientationMode: CameraOrientationMode)

Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. By default the camera orientation is not locked.

Link copied to clipboard
fun setTopBarBackgroundColor(topBarBackgroundColor: Int)

Background color of the top toolbar.

Link copied to clipboard
fun setTopBarButtonsColor(topBarButtonsColor: Int)

Color of the titles of all buttons in the top toolbar.

Link copied to clipboard
fun setTopBarButtonsInactiveColor(topBarButtonsInactiveColor: Int)

Color of the titles of all buttons in the top toolbar.

Link copied to clipboard

Controls whether the touch to focus feature should be enabled. Default is true.

Link copied to clipboard

Controls whether buttons should use all capitals style.

Link copied to clipboard

The color of the highlight of the wordboxes founded on the frame.

Link copied to clipboard

If the wordboxes should be highlighted when were found on the frame.