Android Scanbot SDK API reference/io.scanbot.sdk/ScanbotSDKInitializer

ScanbotSDKInitializer

class ScanbotSDKInitializer : SdkInitializer, ScanbotSdkInitializerCommonApi<ScanbotSDKInitializer>

Initializes Scanbot SDK library. Use it to set up desired components and then call initialize.

Constructors

constructor()

Types

Companion

object Companion : Initializable

PrepareBlobsTask

inner class PrepareBlobsTask(val application: Application)

Functions

allowGpuAcceleration

fun allowGpuAcceleration(enable: Boolean): ScanbotSDKInitializer

Enables/disables GPU acceleration for TensorFlow ML models

allowXnnpackAcceleration

fun allowXnnpackAcceleration(enable: Boolean): ScanbotSDKInitializer

Enables/disables XNNPACK acceleration for TensorFlow ML models, which provides highly optimized implementations of floating-point neural network operators. By default - true.

documentDraftExtractor

fun documentDraftExtractor(extractor: DocumentDraftExtractor): ScanbotSDKInitializer

Adjust this parameter to specify snapped pages should be combined into documents and in which format

documentScannerEngineMode

fun documentScannerEngineMode(type: DocumentScannerEngineMode): ScanbotSDKInitializer

Set Scanbot SDK to use the specified DocumentScannerEngineMode

fromJson

fun ScanbotSDKInitializer.fromJson(application: Application, input: String): ScanbotSDKInitializer

initialize

open override fun initialize(application: Application): SdkLicenseInfo

Initializes Scanbot SDK library. Can be called only once.

licenceErrorHandler

fun licenceErrorHandler(licenseErrorHandler: IScanbotSDKLicenseErrorHandler): ScanbotSDKInitializer

license

fun license(application: Application, license: String): ScanbotSDKInitializer

Set Scanbot SDK license

logger

open override fun logger(logger: Logger): ScanbotSDKInitializer

Adjust this parameter to specify which Logger should be used. To set a custom logger withLogging must be set to true.

ocrBlobsPath

fun ocrBlobsPath(application: Application, ocrBlobsPath: String): ScanbotSDKInitializer

Set Scanbot SDK OCR blobs path

pdfImagesExtractorType

fun pdfImagesExtractorType(type: PdfImagesExtractor.Type): ScanbotSDKInitializer

Set Scanbot SDK to use the specified io.scanbot.sdk.pdf.PdfImagesExtractor.Type

precompileGpuMlModels

fun precompileGpuMlModels(precompilingCallback: () -> Unit = {}): ScanbotSDKInitializer

Performs GPU ML models precompiling

prepareOCRLanguagesBlobs

fun prepareOCRLanguagesBlobs(prepareOCRLanguagesBlobs: Boolean): ScanbotSDKInitializer

Set Scanbot SDK to prepare OCR languages blobs. Prepares language train data blobs for io.scanbot.sdk.mcscanner.MedicalCertificateScanner and io.scanbot.sdk.hicscanner.HealthInsuranceCardScanner

sdkFilesDirectory

fun sdkFilesDirectory(application: Application, sdkFilesDirectory: File): ScanbotSDKInitializer

Set the custom directory for pages and documents storage

setPerformanceHintApiEnabled

open override fun setPerformanceHintApiEnabled(enabled: Boolean): ScanbotSDKInitializer

Enable or disable CPU acceleration.

useFileEncryption

fun useFileEncryption(enableFileEncryption: Boolean, fileIOProcessor: FileIOProcessor? = null): ScanbotSDKInitializer

Sets a global Scanbot SDK flag which enables/disables a usage of encrypted file IO processor for all image and pdf files. By default - false.

useOcrSettings

fun useOcrSettings(ocrSettings: OcrSettings): ScanbotSDKInitializer

Set Scanbot SDK to use given OCR settings

usePageStorageSettings

fun usePageStorageSettings(pageStorageSettings: PageStorageSettings): ScanbotSDKInitializer

Adjust this parameter to specify which io.scanbot.sdk.persistence.PageStorageSettings should be used.

withLogging

open override fun withLogging(useLog: Boolean, enableNativeLogging: Boolean): ScanbotSDKInitializer

Enables or disables logs in Scanbot SDK.