Interface ScanbotBarcodeSdkConfiguration

interface ScanbotBarcodeSdkConfiguration {
    allowGpuAcceleration?: boolean;
    allowXnnpackAcceleration?: boolean;
    enableNativeLogging?: boolean;
    fileEncryptionMode?: FileEncryptionMode;
    fileEncryptionPassword?: string;
    licenseKey?: string;
    loggingEnabled?: boolean;
    performanceHintApi?: boolean;
    storageBaseDirectory?: string;
}

Properties

allowGpuAcceleration? allowXnnpackAcceleration? enableNativeLogging? fileEncryptionMode? fileEncryptionPassword? licenseKey? loggingEnabled? performanceHintApi? storageBaseDirectory?

Properties

Optional allowGpuAcceleration

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.

Optional allowXnnpackAcceleration

allowXnnpackAcceleration?: boolean

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

Optional enableNativeLogging

enableNativeLogging?: boolean

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

Optional fileEncryptionMode

fileEncryptionMode?: FileEncryptionMode

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

Optional fileEncryptionPassword

fileEncryptionPassword?: string

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

Optional licenseKey

licenseKey?: string

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

Optional loggingEnabled

loggingEnabled?: boolean

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

Optional performanceHintApi

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.

Optional storageBaseDirectory

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.

Settings

Member Visibility

Theme

On This Page

allowGpuAccelerationallowXnnpackAccelerationenableNativeLoggingfileEncryptionModefileEncryptionPasswordlicenseKeyloggingEnabledperformanceHintApistorageBaseDirectory