io.scanbot.sdk

Class ScanbotSDKInitializer

io.scanbot.sdk.ScanbotSDKInitializer

public class ScanbotSDKInitializer

Initializes Scanbot SDK library. Use it to set up desired components and then call .initialize. Can be initialized only once.

See Also:

.initialize

Field Detail

Companion

public static io.scanbot.sdk.ScanbotSDKInitializer.Companion Companion

Constructor Detail

ScanbotSDKInitializer

public ScanbotSDKInitializer()

Initializes Scanbot SDK library. Use it to set up desired components and then call .initialize. Can be initialized only once.

See Also:

.initialize

Method Detail

getUseLog

protected boolean getUseLog()

setUseLog

protected void setUseLog(boolean p)

getLogger

@Nullable
protected io.scanbot.sdk.util.log.Logger getLogger()

setLogger

protected void setLogger(@Nullable
                         io.scanbot.sdk.util.log.Logger p)

withLogging

@NotNull
public ScanbotSDKInitializer withLogging(boolean useLog)

Enables or disables logs in Scanbot SDK.

Logs are printed into LogCat as well as saved on the device. You can find them in Environment.getExternalStorageDirectory/debug_logs/package_name. Usually it is /sdcard/debug_logs/package_name

By default all logs are disabled. If you're using logging, consider switching it off for production builds for security and performance reasons.

This method must be called before .initialize, so it is possible to change logging settings before initializing the SDK.

Parameters:

useLog - true to enable loggingfalse to disable logging

Returns:

same class ScanbotSDKInitializer, so calls can be chained

See Also:

package_name, package_name, .initialize

license

@NotNull
public ScanbotSDKInitializer license(@NotNull
                                              android.app.Application application,
                                              @NotNull
                                              java.lang.String license)

Set Scanbot SDK license

licenceErrorHandler

@NotNull
public ScanbotSDKInitializer licenceErrorHandler(@NotNull
                                                          io.scanbot.sap.IScanbotSDKLicenseErrorHandler licenseErrorHandler)

Register callback for handling all sdk license errors after sdk initialisation

ocrBlobsPath

@NotNull
public ScanbotSDKInitializer ocrBlobsPath(@NotNull
                                                   android.app.Application application,
                                                   @NotNull
                                                   java.lang.String ocrBlobsPath)

Set Scanbot SDK OCR blobs path

prepareOCRLanguagesBlobs

@NotNull
public ScanbotSDKInitializer prepareOCRLanguagesBlobs(boolean prepareOCRLanguagesBlobs)

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

prepareBlurEstimatorBlobs

@NotNull
public ScanbotSDKInitializer prepareBlurEstimatorBlobs(boolean prepareBlurEstimatorBlobs)

Set Scanbot SDK to prepare io.scanbot.sdk.process.BlurEstimator blobs.

useOcrSettings

@NotNull
public ScanbotSDKInitializer useOcrSettings(@NotNull
                                                     io.scanbot.sdk.ocr.intelligence.OcrSettings ocrSettings)

Set Scanbot SDK to use given OCR settings

prepareMRZBlobs

@NotNull
public ScanbotSDKInitializer prepareMRZBlobs(boolean prepareMRZBlobs)

Set Scanbot SDK to prepare MRZ scanner blobs

prepareChequeBlobs

@NotNull
public ScanbotSDKInitializer prepareChequeBlobs(boolean prepareChequeBlobs)

Set Scanbot SDK to prepare Cheque scanner blobs

preparePayFormBlobs

@NotNull
public ScanbotSDKInitializer preparePayFormBlobs(boolean preparePayFormBlobs)

Set Scanbot SDK to prepare PayForm scanner blobs

prepareFilterPredictionBlobs

@NotNull
public ScanbotSDKInitializer prepareFilterPredictionBlobs(boolean prepareFilterPredictionBlobs)

Set Scanbot SDK to prepare Filter prediction blobs

contourDetectorType

@NotNull
public ScanbotSDKInitializer contourDetectorType(@NotNull
                                                          io.scanbot.sdk.core.contourdetector.ContourDetector.Type type)

Set Scanbot SDK to use the specified io.scanbot.sdk.core.contourdetector.ContourDetector.Type

Default is io.scanbot.sdk.core.contourdetector.ContourDetector.Type.ML_BASED.

Use io.scanbot.sdk.ScanbotSDK.contourDetector to get an instance of io.scanbot.sdk.core.contourdetector.ContourDetector

See Also:

io.scanbot.sdk.ScanbotSDK.contourDetector

imageProcessorType

@NotNull
public ScanbotSDKInitializer imageProcessorType(@NotNull
                                                         io.scanbot.sdk.process.ImageProcessor.Type type)

Set Scanbot SDK to use the specified io.scanbot.sdk.process.ImageProcessor.Type

Default is io.scanbot.sdk.process.ImageProcessor.Type.BASE.

Use io.scanbot.sdk.ScanbotSDK.imageProcessor to get an instance of io.scanbot.sdk.process.ImageProcessor

See Also:

io.scanbot.sdk.ScanbotSDK.imageProcessor

useFileEncryption

@NotNull
public ScanbotSDKInitializer useFileEncryption(boolean enableFileEncryption,
                                                        @Nullable
                                                        io.scanbot.sdk.persistence.fileio.FileIOProcessor fileIOProcessor)

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.

initialize

@NotNull
public io.scanbot.sap.SdkLicenseInfo initialize(@NotNull
                                                         android.app.Application application)

Initializes Scanbot SDK library

documentDraftExtractor

@NotNull
public ScanbotSDKInitializer documentDraftExtractor(@NotNull
                                                             io.scanbot.sdk.docprocessing.draft.DocumentDraftExtractor extractor)

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

Parameters:

extractor - algorithm to extract array of io.scanbot.sdk.entity.DocumentDraftfrom io.scanbot.sdk.entity.SnappingDraft

Returns:

same class ScanbotSDKInitializer

sdkFilesDirectory

@NotNull
public ScanbotSDKInitializer sdkFilesDirectory(@NotNull
                                                        android.app.Application application,
                                                        @NotNull
                                                        java.io.File sdkFilesDirectory)

Set the custom directory for pages and documents storage

logger

@NotNull
public ScanbotSDKInitializer logger(@NotNull
                                             io.scanbot.sdk.util.log.Logger logger)

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

Parameters:

logger - implementation of Logger

Returns:

same class ScanbotSDKInitializer

See Also:

ScanbotSDKInitializer.withLogging

usePageStorageSettings

@NotNull
public ScanbotSDKInitializer usePageStorageSettings(@NotNull
                                                             io.scanbot.sdk.persistence.PageStorageSettings pageStorageSettings)

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

Returns:

same class ScanbotSDKInitializer

isInitialized

@JvmStatic
public static boolean isInitialized()