Constructor Detail

• ScanbotSdkJsonConfiguration

  ScanbotSdkJsonConfiguration(String version, String screen, Boolean loggingEnabled, Boolean enableNativeLogging, String licenseKey, Integer storageImageQuality, JsonStorageImageFormat storageImageFormat, String storageBaseDirectory, JsonDocumentScannerEngineMode documentScannerEngineMode, JsonFileEncryptionMode fileEncryptionMode, String fileEncryptionPassword, Boolean useCameraX, Boolean allowGpuAcceleration, Boolean allowXnnpackAcceleration)

Method Detail

• getVersion

   final String getVersion()

  A version of the configuration object

• setVersion

   final Unit setVersion(String version)

  A version of the configuration object

• getScreen

   final String getScreen()

  The configuration object should be applied for this screen

• setScreen

   final Unit setScreen(String screen)

  The configuration object should be applied for this screen

• getLoggingEnabled

   final Boolean getLoggingEnabled()

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

• setLoggingEnabled

   final Unit setLoggingEnabled(Boolean loggingEnabled)

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

• getEnableNativeLogging

   final Boolean getEnableNativeLogging()

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

• setEnableNativeLogging

   final Unit setEnableNativeLogging(Boolean enableNativeLogging)

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

• getLicenseKey

   final String getLicenseKey()

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

• setLicenseKey

   final Unit setLicenseKey(String licenseKey)

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

• getStorageImageQuality

   final Integer getStorageImageQuality()

  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.

• setStorageImageQuality

   final Unit setStorageImageQuality(Integer storageImageQuality)

  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.

• getStorageImageFormat

   final JsonStorageImageFormat getStorageImageFormat()

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

• setStorageImageFormat

   final Unit setStorageImageFormat(JsonStorageImageFormat 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'.

• getStorageBaseDirectory

   final String getStorageBaseDirectory()

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

• setStorageBaseDirectory

   final Unit setStorageBaseDirectory(String storageBaseDirectory)

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

• getDocumentScannerEngineMode

   final JsonDocumentScannerEngineMode getDocumentScannerEngineMode()

  Optional mode for document scanner engine.

• setDocumentScannerEngineMode

   final Unit setDocumentScannerEngineMode(JsonDocumentScannerEngineMode documentScannerEngineMode)

  Optional mode for document scanner engine.

• getFileEncryptionMode

   final JsonFileEncryptionMode getFileEncryptionMode()

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

• setFileEncryptionMode

   final Unit setFileEncryptionMode(JsonFileEncryptionMode fileEncryptionMode)

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

• getFileEncryptionPassword

   final String getFileEncryptionPassword()

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

• setFileEncryptionPassword

   final Unit setFileEncryptionPassword(String fileEncryptionPassword)

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

• getUseCameraX

   final Boolean getUseCameraX()

  If set to true, Camera X will be used for the RTU-UI components (Android only). Default is true.

• setUseCameraX

   final Unit setUseCameraX(Boolean useCameraX)

  If set to true, Camera X will be used for the RTU-UI components (Android only). Default is true.

• getAllowGpuAcceleration

   final Boolean getAllowGpuAcceleration()

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

• setAllowGpuAcceleration

   final Unit setAllowGpuAcceleration(Boolean allowGpuAcceleration)

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

• getAllowXnnpackAcceleration

   final Boolean getAllowXnnpackAcceleration()

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

• setAllowXnnpackAcceleration

   final Unit setAllowXnnpackAcceleration(Boolean allowXnnpackAcceleration)

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