Package io.scanbot.sdk.barcode

Class BarcodeFormatDataMatrixConfiguration

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatTwoDConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatDataMatrixConfiguration

public class BarcodeFormatDataMatrixConfiguration
extends BarcodeFormatTwoDConfigurationBase

DataMatrix configuration. Add to scanner configuration to scan DataMatrix and DataMatrix rectangular extensions (DMRE) codes.

Constructor Summary

Constructors

Constructor	Description
BarcodeFormatDataMatrixConfiguration()	Constructs BarcodeFormatDataMatrixConfiguration with default parameters.
BarcodeFormatDataMatrixConfiguration(String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, CharacterEncoding fallbackEncoding, Gs1Handling gs1Handling, TwoDDecodingMode twoDDecoderMode)	Constructs BarcodeFormatDataMatrixConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
Gs1Handling	getGs1Handling()	Getter for gs1Handling field.
TwoDDecodingMode	getTwoDDecoderMode()	Getter for twoDDecoderMode field.
void	setGs1Handling(Gs1Handling gs1Handling)	Setter for gs1Handling field.
void	setTwoDDecoderMode(TwoDDecodingMode twoDDecoderMode)	Setter for twoDDecoderMode field.

Methods inherited from class io.scanbot.sdk.barcode.BarcodeFormatTwoDConfigurationBase

getFallbackEncoding, setFallbackEncoding

Methods inherited from class io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

getAddAdditionalQuietZone, getMinimumSizeScore, getRegexFilter, setAddAdditionalQuietZone, setMinimumSizeScore, setRegexFilter

Methods inherited from class java.lang.Object

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

Constructor Details

BarcodeFormatDataMatrixConfiguration

public BarcodeFormatDataMatrixConfiguration(String regexFilter,
 double minimumSizeScore,
 boolean addAdditionalQuietZone,
 CharacterEncoding fallbackEncoding,
 Gs1Handling gs1Handling,
 TwoDDecodingMode twoDDecoderMode)

Constructs BarcodeFormatDataMatrixConfiguration with the given params.

Parameters:

regexFilter - Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off). Default is `""`

minimumSizeScore - Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is. Default is `0`.

addAdditionalQuietZone - If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode. Default is `false`.

fallbackEncoding - Fallback character encoding to use for decoding a 2D barcode in case that the character encoding is not specified in the barcode itself. Note that some specifications suggest a particular fallback encoding. Instead, by default, we use Unknown encoding, which means that the scanner will try to detect the character encoding automatically. Default is `UNKNOWN`.

gs1Handling - GS1 message handling options. Default is `PARSE`.

twoDDecoderMode - Allows to select the balance between decoding speed and recall in harsh conditions such as barcodes on curved surfaces or partial occlusions. Default is `HIGH_EFFORT`.

BarcodeFormatDataMatrixConfiguration

public BarcodeFormatDataMatrixConfiguration()

Constructs BarcodeFormatDataMatrixConfiguration with default parameters.

Method Details

getGs1Handling

public Gs1Handling getGs1Handling()

Getter for gs1Handling field. See constructor documentation for more information about the field.

Returns:

gs1Handling

setGs1Handling

public void setGs1Handling(Gs1Handling gs1Handling)

Setter for gs1Handling field. See constructor documentation for more information about the field.

Parameters:

gs1Handling - Value to set.

getTwoDDecoderMode

public TwoDDecodingMode getTwoDDecoderMode()

Getter for twoDDecoderMode field. See constructor documentation for more information about the field.

Returns:

twoDDecoderMode

setTwoDDecoderMode

public void setTwoDDecoderMode(TwoDDecodingMode twoDDecoderMode)

Setter for twoDDecoderMode field. See constructor documentation for more information about the field.

Parameters:

twoDDecoderMode - Value to set.