Android Scanbot Barcode SDK/io.scanbot.sdk.barcode_scanner/ScanbotBarcodeScannerSDK

ScanbotBarcodeScannerSDK

open class ScanbotBarcodeScannerSDK(context: Context, configuration: ScanbotBarcodeScannerSDK.Configuration?) : StorageSpaceAware, LicensableSdk, BarcodeScanningSdk

Provider for Scanbot Barcode Scanner SDK features.

Typical use case is to create this object in Activity.onCreate or Service.onCreate, but it's allowed to create it during any other point of lifecycle before onDestroy.

Note that each instance stores reference to given context, so it should not be cached statically. All necessary caching is already done by ScanbotBarcodeScannerSDK itself - some methods might return same instance repeatedly.

Some insight - Scanbot uses Dependency Injection internally, but we do not want to expose it to users of the library to ensure that changes in DI implementation won't affect users of the library.

Constructors

ScanbotBarcodeScannerSDK

constructor(activity: Activity)

constructor(context: Context)

constructor(service: Service)

constructor(application: Application)

constructor(context: Context, configuration: ScanbotBarcodeScannerSDK.Configuration?)

Types

Configuration

data class Configuration(val sdkFilesDirectory: File?, var fileStorageSettings: FileStorageSettings = FileStorageSettings.Builder().useFileEncryption(false).build(), var pdfImagesExtractorSettings: PdfImagesExtractorSettings? = null)

Properties

availableDiskSpace

open override val availableDiskSpace: Long

Provides full info of how much space available to write data by sdk in bytes. You can check this value before creating page images by sdk. But please don't forget that one page contains more than one image inside.

licenseInfo

open override val licenseInfo: LicenseInfo

Provides full info of the license current state. Returned value is consistent during lifetime of the process, i.e. if license is active at application start-up it will remain that way until app will be killed.

storageAware

var storageAware: StorageSpaceAware

totalDiskSpace

open override val totalDiskSpace: Long

Provides full info of how much space total exist on this device storage in bytes.

usedDiskSpace

open override val usedDiskSpace: Long

Provides full info of how much space used on this device storage in bytes.