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

Public Member Functions

Set< Long > getAddedIdentifiers ()
 
Set< Long > getRemovedIdentifiers ()
 
Set< Long > getUpdatedIdentifiers ()
 
Map< Long, TrackedBarcodegetTrackedCodes ()
 
ScanSession getScanSession ()
 
byte[] getImageBytes ()
 
int getWidth ()
 
int getHeight ()
 

Detailed Description

An extended abstraction of a frame that is being processed by the MatrixScan.

The Frame holds basic information like raw image bytes (accessible via Frame.getImageBytes()), as well as more advanced data prepared by the MatrixScan, e.g. added ids (Frame.getAddedIdentifiers()), scan session (getScanSession()), etc.

All the class members are public to allow easy access to the data carried by the Frame.

Since
5.9.0

Member Function Documentation

Set<Long> getAddedIdentifiers ( )

A set of tracked barcodes' identifiers that have been added while processing this Frame.

Returns
A set of identifiers.
Since
5.9.0
Set<Long> getRemovedIdentifiers ( )

A set of tracked barcodes' identifiers have been removed while processing this Frame.

Returns
A set of identifiers.
Since
5.9.0
Set<Long> getUpdatedIdentifiers ( )

A set of tracked barcodes' identifiers have been updated while processing this Frame.

Returns
A set of identifiers.
Since
5.9.0
Map<Long, TrackedBarcode> getTrackedCodes ( )

All tracked barcodes as a dictionary.

The entries in the dictionary map barcode's identifier to the tracked barcode itself.

Returns
A map of tracked barcodes.
Since
5.9.0
ScanSession getScanSession ( )

Current Scan Session.

This object can be accessed only from the session thread. Accessing it from a different thread may result in a deadlock.

Returns
A com.scandit.barcodepicker.ScanSession instance.
Since
5.9.0
byte [] getImageBytes ( )

Raw frame data.

Returns
A byte array.
Since
5.9.0
int getWidth ( )

Frame's width.

Returns
An int representing frame's width.
Since
5.9.0
int getHeight ( )

Frame's height.

Returns
An int representing frame's height.
Since
5.9.0

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