BarcodeScannerConfiguration

Class which is used to configure io.scanbot.sdk.ui.view.barcode.BarcodeScannerActivity. Contains settings indicating views Behaviour, Texts and Appearance.

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Functions

Link copied to clipboard

Sets additional configuration for BarcodeScanner to further tweak it's logic.

Link copied to clipboard

Sets auto close timer in seconds. 0 = disabled and it is the default value.

Link copied to clipboard
fun setBarcodeFilter(barcodeFilter: IBarcodeFilter)

Additional filter to reject or accept barcode scanner results. The default value is an instance of BarcodeFilter.

Link copied to clipboard

A list of barcodes that the scanner should recognize. Anything not on the list will not trigger a successful scan.

Link copied to clipboard
fun setCameraModule(cameraModule: CameraModule)

Set supported camera module: CameraModule.BACK, CameraModule.FRONT. The default value 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: CameraPreviewMode.FILL_IN or CameraPreviewMode.FIT_IN. The default value is CameraPreviewMode.FILL_IN.

Link copied to clipboard

Set custom camera zoom range. Min value is 0.5f and max - 100f (if supported by device). Default value is ZoomRange(0.5x, 100x).

Link copied to clipboard
fun setCameraZoomRatio(zoomFactor: Float)

Set current zoom ratio from 0.5x up to 100x (if supported). The default value is 1x.

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

Controls the state of the Barcode confirmation dialog. Disabled by default.

Link copied to clipboard

Delay that camera will took before snap on auto focus complete called from camera core in ms. For some devices this callback could call even before real auto focus completed, so we need to take some delay before snapping. Usually you can set 500ms. By default it is set to 20ms.

Link copied to clipboard
fun setDelayAfterScanMs(milliseconds: Long)

Sets delay after scan in ms. 0 = disabled and it is the default value

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

Allows to set custom BarcodeScannerEngineMode for the barcode scanning. BarcodeScannerEngineMode.NEXT_GEN is used by default.

Link copied to clipboard

A list of document formats that the scanner should recognize. Anything not on the list will not trigger a successful scan.

Link copied to clipboard
fun setFinderAspectRatio(finderAspectRatio: AspectRatio)

Aspect ratio of the finder window.

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 setFinderTextHint(finderTextHint: String)

Text hint shown under the finder window.

Link copied to clipboard
fun setFinderTextHintColor(finderTextHintColor: Int)

Color of the text hint under the finder window.

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
fun setInitialScanDelayMs(milliseconds: Long)

Sets initial scan delay in ms. 0 = disabled and it is the default value

Link copied to clipboard

Locks the minimal supported focus distance and disables a continuous focus. The default value is false.

Link copied to clipboard
fun setOrientationLockMode(cameraOrientationMode: CameraOrientationMode)

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

Link copied to clipboard

Controls the state of the Barcode selection overlay. Disabled by default.

Link copied to clipboard
fun setSuccessBeepEnabled(successBeepEnabled: Boolean)

Controls whether to play a beep sound after a successful scanning. Default value is true.

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)

The color of the inactive flash button in the 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
fun setViewFinderEnabled(viewFinderEnabled: Boolean)

Set true to enable showing the area of interest on camera preview. Enabled by default.