Package io.scanbot.sdk.barcode

Class BarcodeFormatQrCodeConfiguration

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatTwoDConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatQrCodeConfiguration

public class BarcodeFormatQrCodeConfiguration
extends BarcodeFormatTwoDConfigurationBase

QR Code configuration. Add to scanner configuration to scan QR codes, Micro QR codes and rectangular Micro QR (rMQR) codes.

Constructor Summary

Constructors

Constructor	Description
BarcodeFormatQrCodeConfiguration()	Constructs BarcodeFormatQrCodeConfiguration with default parameters.
BarcodeFormatQrCodeConfiguration(String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, CharacterEncoding fallbackEncoding, Gs1Handling gs1Handling, boolean strictMode, boolean qr, boolean microQr, boolean rmqr)	Constructs BarcodeFormatQrCodeConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
Gs1Handling	getGs1Handling()	Getter for gs1Handling field.
boolean	getMicroQr()	Getter for microQr field.
boolean	getQr()	Getter for qr field.
boolean	getRmqr()	Getter for rmqr field.
boolean	getStrictMode()	Getter for strictMode field.
void	setGs1Handling(Gs1Handling gs1Handling)	Setter for gs1Handling field.
void	setMicroQr(boolean microQr)	Setter for microQr field.
void	setQr(boolean qr)	Setter for qr field.
void	setRmqr(boolean rmqr)	Setter for rmqr field.
void	setStrictMode(boolean strictMode)	Setter for strictMode 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

BarcodeFormatQrCodeConfiguration

public BarcodeFormatQrCodeConfiguration(String regexFilter,
 double minimumSizeScore,
 boolean addAdditionalQuietZone,
 CharacterEncoding fallbackEncoding,
 Gs1Handling gs1Handling,
 boolean strictMode,
 boolean qr,
 boolean microQr,
 boolean rmqr)

Constructs BarcodeFormatQrCodeConfiguration 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`.

strictMode - If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives. Default is `true`.

qr - If true, scan and return QR codes. Default is `true`.

microQr - If true, scan and return Micro QR codes. Default is `false`.

rmqr - If true, scan and return rectangular Micro QR (rMQR) codes. Default is `false`.

BarcodeFormatQrCodeConfiguration

public BarcodeFormatQrCodeConfiguration()

Constructs BarcodeFormatQrCodeConfiguration 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.

getStrictMode

public boolean getStrictMode()

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

Returns:

strictMode

setStrictMode

public void setStrictMode(boolean strictMode)

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

Parameters:

strictMode - Value to set.

getQr

public boolean getQr()

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

Returns:

qr

setQr

public void setQr(boolean qr)

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

Parameters:

qr - Value to set.

getMicroQr

public boolean getMicroQr()

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

Returns:

microQr

setMicroQr

public void setMicroQr(boolean microQr)

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

Parameters:

microQr - Value to set.

getRmqr

public boolean getRmqr()

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

Returns:

rmqr

setRmqr

public void setRmqr(boolean rmqr)

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

Parameters:

rmqr - Value to set.