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

ScanbotSdkJsonConfiguration

data class ScanbotSdkJsonConfiguration(var version: String?, var screen: String?, var loggingEnabled: Boolean?, var enableNativeLogging: Boolean?, var licenseKey: String?, var storageImageQuality: Int?, var storageImageFormat: JsonStorageImageFormat?, var storageBaseDirectory: String?, var documentScannerEngineMode: JsonDocumentScannerEngineMode?, var fileEncryptionMode: JsonFileEncryptionMode?, var fileEncryptionPassword: String?, var performanceHintApi: Boolean?, var allowGpuAcceleration: Boolean?, var allowXnnpackAcceleration: Boolean?)

Constructors

constructor(version: String?, screen: String?, loggingEnabled: Boolean?, enableNativeLogging: Boolean?, licenseKey: String?, storageImageQuality: Int?, storageImageFormat: JsonStorageImageFormat?, storageBaseDirectory: String?, documentScannerEngineMode: JsonDocumentScannerEngineMode?, fileEncryptionMode: JsonFileEncryptionMode?, fileEncryptionPassword: String?, performanceHintApi: Boolean?, allowGpuAcceleration: Boolean?, allowXnnpackAcceleration: Boolean?)

Properties

allowGpuAcceleration

var allowGpuAcceleration: Boolean?

If set to true, GPU Acceleration will be enabled for Barcode Scanner, Document Scanner and Generic Document Recognizer (Android only). Default is true.

allowXnnpackAcceleration

var allowXnnpackAcceleration: Boolean?

Enables/disables XNNPACK acceleration for TensorFlow ML models, which provides highly optimized implementations of floating-point neural network operators (Android only)

documentScannerEngineMode

var documentScannerEngineMode: JsonDocumentScannerEngineMode?

Optional mode for document scanner engine.

enableNativeLogging

var enableNativeLogging: Boolean?

Optional boolean flag that enables Scanbot SDK Core native logging (default is false, Android only).

fileEncryptionMode

var fileEncryptionMode: JsonFileEncryptionMode?

Optional file encryption mode, 'AES128' or 'AES256'.

fileEncryptionPassword

var fileEncryptionPassword: String?

Optional file encryption password. Refer to the section "Storage Encryption" for more details.

licenseKey

var licenseKey: String?

Your license key for the Scanbot SDK. See the "License Key" section below.

loggingEnabled

var loggingEnabled: Boolean?

Optional boolean flag to enable logging. See the "Logging" section below.

performanceHintApi

var performanceHintApi: Boolean?

If set to true, PerformanceHintApi is enabled, which lead to increase of performance due of increased use of top CPU cores (Android only), also increase battery usage. Default is true.

screen

var screen: String?

The configuration object should be applied for this screen

storageBaseDirectory

var storageBaseDirectory: String?

Optional directory as file URI to override the default storage base directory of the Scanbot SDK. Refer to the section "Storage" for more details.

storageImageFormat

var storageImageFormat: JsonStorageImageFormat?

Optional image format, either 'JPG' or 'PNG'. The recommended default value is 'JPG'. Please note that 'PNG' will result in larger image files! Also, the storageImageQuality value does not apply for 'PNG'.

storageImageQuality

var storageImageQuality: Int?

Optional image quality value. It defines the quality factor of JPEG images. The value must be between 1 and 100, where 100 means maximum quality and largest file size. The recommended default value is 80 which is a good compromise between image file size and document legibility.

version

var version: String?

A version of the configuration object