Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Android

Inherits NativeHandle.

Public Member Functions

BarcodeScannerSession getSession ()
 
void applySettings (BarcodeScannerSettings settings)
 
RecognitionContext getContext ()
 
boolean waitForSetupCompleted ()
 
boolean isSetupComplete ()
 
BarcodeScannerSettings getSettings ()
 

Static Public Member Functions

static BarcodeScanner create (RecognitionContext context, BarcodeScannerSettings settings)
 

Static Public Attributes

Code Direction
static final int CODE_DIRECTION_NONE
 
static final int CODE_DIRECTION_LEFT_TO_RIGHT
 
static final int CODE_DIRECTION_RIGHT_TO_LEFT
 
static final int CODE_DIRECTION_TOP_TO_BOTTOM
 
static final int CODE_DIRECTION_BOTTOM_TO_TOP
 
static final int CODE_DIRECTION_VERTICAL
 
static final int CODE_DIRECTION_HORIZONTAL
 

Detailed Description

Scans barcodes in images.

The barcode scanner is the main interface for decoding barcodes in images. After constructing a barcode scanner, barcodes are decoded when a frame is processed with RecognitionContext.processFrame()

Barcode scanner results (decoded and localized barcodes) are available in the "scan session" that can be retrieved by getSession().

Since
4.7.0

Member Function Documentation

static BarcodeScanner create ( RecognitionContext  context,
BarcodeScannerSettings  settings 
)
static

Create a new barcode scanner instance with the given settings.

Parameters
contextThe recognition context. Must not be null.
settingsThe barcode scanner settings. Must not be null.
Returns
a new barcode scanner instance. NULL is returned, if there is already another barcode scanner associated with this context.
Since
4.7.0
BarcodeScannerSession getSession ( )

Get the current scanning session.

The scanning session contains the current state of the barcode decoding process, such as the codes that were decoded in the last frame.

Returns
The session object. The returned session object is guaranteed to be non-null.
Since
4.7.0
void applySettings ( BarcodeScannerSettings  settings)

Apply new settings.

Parameters
settingsThe barcode scanner settings object. Must not be null.
Since
4.7.0
RecognitionContext getContext ( )

Retrieve the recognition context.

Returns
The recognition context this barcode scanner belongs to.
boolean waitForSetupCompleted ( )

Block execution until the barcode scanner has completed setup.

Returns
True on success, false otherwise.
Since
4.7.0
boolean isSetupComplete ( )

Checks whether the barcode scanner has completed initialization.

Returns
True if setup has completed, false otherwise.
Since
4.7.0
BarcodeScannerSettings getSettings ( )

Get current barcode scanner settings.

Returns
the current barcode scanner settings. Note that changing the barcode scanner settings has no effect. You will need to call applySettings.

Member Data Documentation

final int CODE_DIRECTION_NONE
static

Code orientation is unknown.

final int CODE_DIRECTION_LEFT_TO_RIGHT
static

Code is oriented from left to right in the image.

final int CODE_DIRECTION_RIGHT_TO_LEFT
static

Code is oriented from right to left in the image.

final int CODE_DIRECTION_TOP_TO_BOTTOM
static

Code is oriented from top to bottom in the image.

final int CODE_DIRECTION_BOTTOM_TO_TOP
static

Code is oriented from bottom to top in the image.

final int CODE_DIRECTION_VERTICAL
static

The code is oriented vertically in the image (top to bottom, or bottom to top).

final int CODE_DIRECTION_HORIZONTAL
static

The code is oriented horizontally in the image (left to right, or right to left)


The documentation for this class was generated from the following file:
  • BarcodeScanner.java