Package io.scanbot.sdk.barcode

Class BarcodeScanner

java.lang.Object

io.scanbot.sdk.barcode.BarcodeScanner

All Implemented Interfaces:

AutoCloseable

public class BarcodeScanner
extends Object
implements AutoCloseable

API for barcode scanning. Required licence feature(s): BarcodeScanner.

Constructor Summary

Constructors

Constructor	Description
BarcodeScanner(BarcodeScannerConfiguration configuration)	Constructs BarcodeScanner with the given params.

Method Summary

Modifier and Type	Method	Description
void	clearFrameAccumulationCache()	Clear the cache of the barcode frame accumulator.
void	close()	Closes native resources held by the object.
protected void	finalize()
BarcodeScannerResult	run(ImageRef image)	Recognize barcodes in the given image.

Methods inherited from class java.lang.Object

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

Constructor Details

BarcodeScanner

public BarcodeScanner(BarcodeScannerConfiguration configuration)
               throws LicenseException

Constructs BarcodeScanner with the given params.

Parameters:

configuration - The configuration to use for the barcode scanner.

Throws:

LicenseException - If license requirements for the API are not met

Method Details

run

public BarcodeScannerResult run(ImageRef image)
                         throws InvalidImageRefException,
LicenseException

Recognize barcodes in the given image.

Parameters:

image - The image to recognize barcodes in.

Returns:

The recognized barcodes.

Throws:

InvalidImageRefException - If an invalid image reference is used

LicenseException - If license requirements for the API are not met

clearFrameAccumulationCache

public void clearFrameAccumulationCache()

Clear the cache of the barcode frame accumulator.

close

public void close()

Closes native resources held by the object.

Specified by:

close in interface AutoCloseable

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable