io.scanbot.sdk

Class ScanbotSDKInitializer

java.lang.Object

io.scanbot.sdk.ScanbotSDKInitializer

public class ScanbotSDKInitializer
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	initialized
protected Logger	logger
protected boolean	useLog

Constructor Summary

Constructors

Constructor and Description
ScanbotSDKInitializer()

Method Summary

Modifier and Type	Method and Description
ScanbotSDKInitializer	documentDraftExtractor(DocumentDraftExtractor extractor) Adjust this parameter to specify snapped pages should be combined into documents and in which format
void	initialize(android.app.Application application) Initializes Scanbot SDK library
static boolean	isInitialized()
ScanbotSDKInitializer	languageClassifierBlobPath(android.app.Application application, java.lang.String languageClassifierBlobPath) Set Scanbot SDK language classifier blob path
ScanbotSDKInitializer	license(android.app.Application application, java.lang.String license) Set Scanbot SDK license
ScanbotSDKInitializer	logger(Logger logger) Adjust this parameter to specify which Logger should be used.
ScanbotSDKInitializer	ocrBlobsPath(android.app.Application application, java.lang.String ocrBlobsPath) Set Scanbot SDK OCR blobs path
ScanbotSDKInitializer	unreferencedSourcesProvider(UnreferencedSourcesProvider provider) Adjust this parameter to specify which files Cleaner can safely delete during clean up
ScanbotSDKInitializer	useBarcodeDetector(ScanbotBarcodeDetector.BarcodeDetectorType barcodeDetector) Adjust this parameter to specify which ScanbotBarcodeDetector should be used.
ScanbotSDKInitializer	usePageStorageSettings(PageStorageSettings pageStorageSettings) Adjust this parameter to specify which io.scanbot.sdk.persistence.PageStorageSettings should be used.
ScanbotSDKInitializer	withLogging(boolean useLog) Enables or disables logs in Scanbot SDK.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

initialized

protected static boolean initialized

useLog

protected boolean useLog

logger

protected Logger logger

Constructor Detail

ScanbotSDKInitializer

public ScanbotSDKInitializer()

Method Detail

withLogging

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(Application), so it is possible to change logging settings before initializing the SDK.

Parameters:

useLog - true to enable logging false to disable logging

Returns:

same ScanbotSDKInitializer, so calls can be chained

license

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

Set Scanbot SDK license

ocrBlobsPath

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

Set Scanbot SDK OCR blobs path

languageClassifierBlobPath

public ScanbotSDKInitializer languageClassifierBlobPath(android.app.Application application,
                                                        java.lang.String languageClassifierBlobPath)

Set Scanbot SDK language classifier blob path

initialize

public void initialize(android.app.Application application)

Initializes Scanbot SDK library

isInitialized

public static boolean isInitialized()

Returns:

true if SDK initialized, false - otherwise

documentDraftExtractor

public ScanbotSDKInitializer documentDraftExtractor(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 DocumentDraft from SnappingDraft

Returns:

same ScanbotSDKInitializer

unreferencedSourcesProvider

public ScanbotSDKInitializer unreferencedSourcesProvider(UnreferencedSourcesProvider provider)

Adjust this parameter to specify which files Cleaner can safely delete during clean up

Parameters:

provider - provides unreferenced pages and documents which can be safely deleted by Cleaner

Returns:

same ScanbotSDKInitializer

logger

public ScanbotSDKInitializer logger(Logger logger)

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

Parameters:

logger - implementation of Logger

Returns:

same ScanbotSDKInitializer

useBarcodeDetector

public ScanbotSDKInitializer useBarcodeDetector(ScanbotBarcodeDetector.BarcodeDetectorType barcodeDetector)

Adjust this parameter to specify which ScanbotBarcodeDetector should be used. By default - ScanbotBarcodeDetector.BarcodeDetectorType#ZXing

Returns:

same ScanbotSDKInitializer

usePageStorageSettings

public ScanbotSDKInitializer usePageStorageSettings(PageStorageSettings pageStorageSettings)

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

Returns:

same ScanbotSDKInitializer