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 | Static Public Member Functions | Static Public Attributes | List of all members
TrackedBarcode Class Reference

Inherits Barcode.

Public Member Functions

Quadrilateral getPredictedLocation ()
 
long getDeltaTimeForPrediction ()
 
boolean shouldAnimateFromPreviousToNextState ()
 
boolean isColorInverted ()
 

Static Public Member Functions

static String symbologyToString (int sym)
 
static int symbologyFromString (String symbologyName)
 

Static Public Attributes

static final int[] ALL_SYMBOLOGIES
 
Symbologies
static final int SYMBOLOGY_UNKNOWN
 
static final int SYMBOLOGY_EAN13
 
static final int SYMBOLOGY_EAN8
 
static final int SYMBOLOGY_UPCA
 
static final int SYMBOLOGY_UPCE
 
static final int SYMBOLOGY_CODE128
 
static final int SYMBOLOGY_CODE11
 
static final int SYMBOLOGY_CODE25
 
static final int SYMBOLOGY_CODE32
 
static final int SYMBOLOGY_CODE39
 
static final int SYMBOLOGY_CODE93
 
static final int SYMBOLOGY_INTERLEAVED_2_OF_5
 
static final int SYMBOLOGY_QR
 
static final int SYMBOLOGY_MICRO_QR
 
static final int SYMBOLOGY_DATA_MATRIX
 
static final int SYMBOLOGY_PDF417
 
static final int SYMBOLOGY_MICRO_PDF417
 
static final int SYMBOLOGY_MSI_PLESSEY
 
static final int SYMBOLOGY_GS1_DATABAR
 
static final int SYMBOLOGY_GS1_DATABAR_EXPANDED
 
static final int SYMBOLOGY_GS1_DATABAR_LIMITED
 
static final int SYMBOLOGY_CODABAR
 
static final int SYMBOLOGY_AZTEC
 
static final int SYMBOLOGY_MAXICODE
 
static final int SYMBOLOGY_TWO_DIGIT_ADD_ON
 
static final int SYMBOLOGY_FIVE_DIGIT_ADD_ON
 
static final int SYMBOLOGY_KIX
 
static final int SYMBOLOGY_RM4SCC
 
static final int SYMBOLOGY_LAPA4SC
 
static final int SYMBOLOGY_DOTCODE
 
CompositeFlags
static final int SC_COMPOSITE_FLAG_NONE
 
static final int SC_COMPOSITE_FLAG_UNKNOWN
 
static final int SC_COMPOSITE_FLAG_LINKED
 
static final int SC_COMPOSITE_FLAG_GS1_A
 
static final int SC_COMPOSITE_FLAG_GS1_B
 
static final int SC_COMPOSITE_FLAG_GS1_C
 

Detailed Description

Represents a recognized/localized barcode/2D code that is being tracked over multiple frames.

The TrackedBarcode class represents a barcode, or 2D code that has been localized or recognized by the barcode recognition engine and is being tracked over multiple frames.

Since
5.2.0

Member Function Documentation

Quadrilateral getPredictedLocation ( )

The predicted location of the tracked code.

The location where the tracked code is predicted to be in getDeltaTimeForPrediction()

Returns
The predicted location of the tracked code.
See also
getDeltaTimeForPrediction()
long getDeltaTimeForPrediction ( )

The delta time for the predicted location of the code in milliseconds.

The time (in milliseconds) it will take for the tracked code to move to the predicted location (getPredictedLocation()). This value can be used to animate the predicted change of location of the tracked code.

Returns
The delta time for the predicted location of the code in milliseconds.
See also
getPredictedLocation()
boolean shouldAnimateFromPreviousToNextState ( )

Whether the change in location should be animated.

As there are state transitions that do not guarantee a stable ordering of the location's corners you should always check this function before animating a location change.

Returns
True if the change in location should be animated.
Since
5.2.0
boolean isColorInverted ( )
inherited

Whether the recognized code is color inverted.

Returns
True if the code has been recognized and is color-inverted (printed bright on dark). For codes that have been localized but not recognized, this method returns false.
Since
5.5
static String symbologyToString ( int  sym)
staticinherited

Helper function to convert a symbology enum to a string representing it.

Parameters
symsymbology enum
Returns
the string representing the given symbology
static int symbologyFromString ( String  symbologyName)
staticinherited

Helper function to convert a symbology string to its corresponding symbology enum.

Parameters
symbologyNamestring with symbology name
Returns
the enum value for the given symbology string

Member Data Documentation

final int SYMBOLOGY_UNKNOWN
staticinherited

Sentinel value to represent an unknown symbology.

final int SYMBOLOGY_EAN13
staticinherited

EAN-13 1D barcode symbology.

final int SYMBOLOGY_EAN8
staticinherited

EAN-8 1D barcode symbology.

final int SYMBOLOGY_UPCA
staticinherited

UPC-12/UPC-A 1D barcode symbology.

final int SYMBOLOGY_UPCE
staticinherited

UPC-E 1D barcode symbology.

final int SYMBOLOGY_CODE128
staticinherited

Code 128 1D barcode symbology, including GS1-Code128.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_CODE11
staticinherited

Code 11 barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_CODE25
staticinherited

Code 25 barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_CODE32
staticinherited

Code 32 barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_CODE39
staticinherited

Code 39 barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_CODE93
staticinherited

Code 93 barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_INTERLEAVED_2_OF_5
staticinherited

Interleaved-Two-of-Five (ITF) 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_QR
staticinherited

QR Code 2D barcode symbology.

final int SYMBOLOGY_MICRO_QR
staticinherited

MicroQR Code 2D barcode symbology.

final int SYMBOLOGY_DATA_MATRIX
staticinherited

Data Matrix 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_PDF417
staticinherited

PDF417 barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_MICRO_PDF417
staticinherited

MicroPDF417 barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_MSI_PLESSEY
staticinherited

MSI Plessey 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_GS1_DATABAR
staticinherited

GS1 DataBar 14 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_GS1_DATABAR_EXPANDED
staticinherited

GS1 DataBar Expanded 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_GS1_DATABAR_LIMITED
staticinherited

GS1 DataBar Limited 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_CODABAR
staticinherited

Codabar 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_AZTEC
staticinherited

Aztec Code 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_MAXICODE
staticinherited

MaxiCode 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_TWO_DIGIT_ADD_ON
staticinherited

Two-digit add-on for UPC and EAN codes.

In order to scan two-digit add-on codes, at least one of these symbologies must be activated as well: SYMBOLOGY_EAN13, SYMBOLOGY_UPCA, SYMBOLOGY_UPCE, or SYMBOLOGY_EAN8 and the maximum number of codes per frame has to be set to at least 2.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_FIVE_DIGIT_ADD_ON
staticinherited

Five-digit add-on for UPC and EAN codes.

In order to scan five-digit add-on codes, at least one of these symbologies must be activated as well: SYMBOLOGY_EAN13, SYMBOLOGY_UPCA, SYMBOLOGY_UPCE, or SYMBOLOGY_EAN8 and the maximum number of codes per frame has to be set to at least 2.

Only available in the Professional and Enterprise Packages.

final int SYMBOLOGY_KIX
staticinherited

Royal Dutch TPG Post KIX.

Only available in Professional and Enterprise Packages

final int SYMBOLOGY_RM4SCC
staticinherited

Royal Mail 4 State Customer Code (RM4SCC)

Only available in Professional and Enterprise Packages

final int SYMBOLOGY_LAPA4SC
staticinherited

LAPA 4 State Code.

Only available in Professional and Enterprise Packages

final int SYMBOLOGY_DOTCODE
staticinherited

Dot Code.

Only available in Professional and Enterprise Packages

final int [] ALL_SYMBOLOGIES
staticinherited

Enumerates all symbologies.

final int SC_COMPOSITE_FLAG_NONE
staticinherited

Code is not part of a composite code.

final int SC_COMPOSITE_FLAG_UNKNOWN
staticinherited

Code could be part of a composite code.

This flag is set by linear (1d) symbologies that have no composite flag support but can be part of a composite code like the EAN/UPC symbology family.

final int SC_COMPOSITE_FLAG_LINKED
staticinherited

Code is the linear component of a composite code.

This flag can be set by GS1 DataBar or GS1-128 (Code 128).

final int SC_COMPOSITE_FLAG_GS1_A
staticinherited

Code is a GS1 Composite Code Type A (CC-A).

This flag can be set by MicroPDF417 codes.

final int SC_COMPOSITE_FLAG_GS1_B
staticinherited

Code is a GS1 Composite Code Type B (CC-B).

This flag can be set by MicroPDF417 codes.

final int SC_COMPOSITE_FLAG_GS1_C
staticinherited

Code is a GS1 Composite Code Type C (CC-C).

This flag can be set by PDF417 codes.

The documentation for this class was generated from the following file:
  • TrackedBarcode.java
Copyright (C) 2019 Scandit AG