Android Scanbot SDK API reference

7.1.0

Android Scanbot SDK API reference/io.scanbot.sdk.ui.configuration.json

Package-level declarations

Types

object GsonHelper

Helper to prepare a GSON object able to process the JSON configuration string.

JsonAspectRatio

data class JsonAspectRatio(var width: Double, var height: Double) : Parcelable

Finder aspect ratio

JsonAustraliaPostCustomerFormat

enum JsonAustraliaPostCustomerFormat : Enum<JsonAustraliaPostCustomerFormat>

The customer format used in AUSTRALIA_POST codes. Only relevant for format codes 59 and 62.

JsonBarcodeDialogFormat

enum JsonBarcodeDialogFormat : Enum<JsonBarcodeDialogFormat>

The barcode text format dialog.

JsonBarcodeDocumentFormat

enum JsonBarcodeDocumentFormat : Enum<JsonBarcodeDocumentFormat>

Barcode document format

JsonBarcodeFormat

enum JsonBarcodeFormat : Enum<JsonBarcodeFormat>

Barcode document format

JsonBarcodeImageGenerationType

enum JsonBarcodeImageGenerationType : Enum<JsonBarcodeImageGenerationType>

Defines the possible barcode image sources.

JsonBarcodeOverlayTextFormat

enum JsonBarcodeOverlayTextFormat : Enum<JsonBarcodeOverlayTextFormat>

Barcode scanner engine mode

JsonBarcodesExtensionFilter

enum JsonBarcodesExtensionFilter : Enum<JsonBarcodesExtensionFilter>

A filter for extended EAN and UPC barcodes.

enum JsonBlurEffect : Enum<JsonBlurEffect>

The blur effect style. iOS only.

JsonCameraModule

enum JsonCameraModule : Enum<JsonCameraModule>

Camera module to use

JsonCameraPreviewMode

enum JsonCameraPreviewMode : Enum<JsonCameraPreviewMode>

Represents camera preview modes

JsonCapturePhotoQualityPrioritization

enum JsonCapturePhotoQualityPrioritization : Enum<JsonCapturePhotoQualityPrioritization>

The prioritization of still image quality and capturing speed. Has no effect on devices prior to iOS 13.0. iOS only.

data class JsonColor(val hexString: String) : Parcelable

JSON-compatible class for Color

JsonConfirmationDialogConfiguration

data class JsonConfirmationDialogConfiguration(var resultWithConfirmationEnabled: Boolean?, var dialogTextFormat: JsonBarcodeDialogFormat?, var confirmationDialogStyle: JsonDialogStyle?, var confirmButtonTitle: String?, var confirmationDialogConfirmButtonStyle: JsonDialogButtonStyle?, var retryButtonTitle: String?, var confirmationDialogRetryButtonStyle: JsonDialogButtonStyle?, var dialogTitle: String?, var dialogMessage: String?, var dialogButtonsAccentColor: JsonColor?, var confirmButtonFilled: Boolean?, var confirmButtonFilledTextColor: JsonColor?) : Parcelable

Confirmation Dialog configuration

JsonDialogButtonStyle

data class JsonDialogButtonStyle(var font: JsonFont?, var textColor: JsonColor?, var highlightedTextColor: JsonColor?, var backgroundColor: JsonColor?, var highlightedBackgroundColor: JsonColor?) : Parcelable

Configuration for the dialogs/alerts OK button style.

JsonDialogStyle

data class JsonDialogStyle(var screenBackgroundColor: JsonColor, var dialogBackgroundColor: JsonColor, var dialogBackgroundEffect: JsonBlurEffect, var cornerRadius: Double, var titleColor: JsonColor, var titleFont: JsonFont, var messageColor: JsonColor, var messageFont: JsonFont, var separatorColor: JsonColor, var separatorWidth: Double) : Parcelable

Configuration for the dialog/alert style

JsonDocumentScannerEngineMode

enum JsonDocumentScannerEngineMode : Enum<JsonDocumentScannerEngineMode>

Engine modes for document scanning.

enum JsonEngineMode : Enum<JsonEngineMode>

Barcode scanner engine mode

data class JsonFont(var fontName: String, var fontSize: Double) : Parcelable

The font name and size. iOS only.

JsonGs1HandlingMode

enum JsonGs1HandlingMode : Enum<JsonGs1HandlingMode>

GS1 handling mode

JsonImageFilterType

enum JsonImageFilterType : Enum<JsonImageFilterType>

The image filter types.

JsonMSIPlesseyChecksumAlgorithm

enum JsonMSIPlesseyChecksumAlgorithm : Enum<JsonMSIPlesseyChecksumAlgorithm>

MSI plessey checksum algorithm

enum JsonOcrEngine : Enum<JsonOcrEngine>

The modes of the optical character recognition engine.

JsonOrientationLockMode

enum JsonOrientationLockMode : Enum<JsonOrientationLockMode>

Applied interface orientation

JsonPageDirection

enum JsonPageDirection : Enum<JsonPageDirection>

The page orientation of the pdf document.

enum JsonPageSize : Enum<JsonPageSize>

The page size of the pdf document.

JsonSelectionOverlayConfiguration

data class JsonSelectionOverlayConfiguration(var overlayEnabled: Boolean?, var automaticSelectionEnabled: Boolean?, var textFormat: JsonBarcodeOverlayTextFormat?, var polygonColor: JsonColor?, var textColor: JsonColor?, var textContainerColor: JsonColor?, var highlightedPolygonColor: JsonColor?, var highlightedTextColor: JsonColor?, var highlightedTextContainerColor: JsonColor?) : Parcelable

Barcode Selection Overlay configuration

data class JsonSize(var width: Double, var height: Double) : Parcelable

Standard size object

data class JsonZoomRange(var minZoom: Double?, var maxZoom: Double?) : Parcelable

Defines a range for zooming

Functions

fun CameraModule.toJson(): JsonCameraModule

fun CameraPreviewMode.toJson(): JsonCameraPreviewMode

fun ZoomRange.toJson(): JsonZoomRange

fun CameraOrientationMode?.toJson(): JsonOrientationLockMode

Converts SDK object to JSON-compatible object.

fun Int.toJsonColor(): JsonColor

Converts Int to argb hex-string representation of the color

fun AspectRatio.toJsonV1(): JsonAspectRatio

Converts SDK object to JSON-compatible object.

fun JsonAspectRatio.toSdk(): AspectRatio

fun JsonCameraModule.toSdk(): CameraModule

fun JsonCameraPreviewMode.toSdk(): CameraPreviewMode

fun JsonOrientationLockMode.toSdk(): CameraOrientationMode?

fun JsonZoomRange.toSdk(): ZoomRange

Converts JSON-compatible object to SDK object.