kmp-bundle-sdk/io.scanbot.sdk.kmp.common.sdk.configuration/SdkConfiguration

SdkConfiguration

data class SdkConfiguration(var licenseKey: String, var loggingEnabled: Boolean = false, var enableNativeLogging: Boolean = false, var storageBaseDirectory: String? = null, var storageImageQuality: Int = 80, var storageImageFormat: StorageImageFormat = StorageImageFormat.JPG, var fileEncryptionMode: FileEncryptionMode? = null, var fileEncryptionPassword: String? = null, var performanceHintApi: Boolean = true, var allowGpuAcceleration: Boolean = true, var allowXnnpackAcceleration: Boolean = true)

Initialize configuration for the Scanbot SDK.

Constructors

SdkConfiguration

constructor(licenseKey: String, loggingEnabled: Boolean = false, enableNativeLogging: Boolean = false, storageBaseDirectory: String? = null, storageImageQuality: Int = 80, storageImageFormat: StorageImageFormat = StorageImageFormat.JPG, fileEncryptionMode: FileEncryptionMode? = null, fileEncryptionPassword: String? = null, performanceHintApi: Boolean = true, allowGpuAcceleration: Boolean = true, allowXnnpackAcceleration: Boolean = true)

constructor(source: Map<String, Any?>)

Types

Companion

object Companion

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).

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).

enableNativeLogging

var enableNativeLogging: Boolean

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

fileEncryptionMode

var fileEncryptionMode: FileEncryptionMode?

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.

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: StorageImageFormat

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.

Functions

toJson

fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JsonObject

toJsonString

fun toJsonString(config: ToJsonConfiguration = ToJsonConfiguration.default()): String