Class BarcodeFormatGs1CompositeConfiguration

  • All Implemented Interfaces:
    android.os.Parcelable

    public final class BarcodeFormatGs1CompositeConfiguration
    extends BarcodeFormatConfigurationBase implements Parcelable
                        

    GS1 Composite configuration. Add to scanner configuration to scan GS1 Composite barcodes.

    When not enabled, the individual parts of GS1 Composite barcodes will be returned as separate items, if the respective formats are enabled (UPC-A, Code 128, MicroPDF417, PDF417). Those barcode items will have their isGS1CompositePart field set to true. If GS1 Composite scanning is enabled, the individual parts are never returned, even if their respective formats are enabled, except when the linear component is a UPC or EAN barcode. In that case the linear component might still occasionally be returned as a separate result. If this situation needs to be avoided, remove the UPC and EAN formats from the enabled formats.

    If GS1 Composite scanning is disabled, but GS1 message validation is enabled, then the parts of the composite barcode may fail validation and be rejected.

    • Constructor Detail

      • BarcodeFormatGs1CompositeConfiguration

        BarcodeFormatGs1CompositeConfiguration(Map<String, Object> source)
      • BarcodeFormatGs1CompositeConfiguration

        BarcodeFormatGs1CompositeConfiguration(JSONObject json)
      • BarcodeFormatGs1CompositeConfiguration

        BarcodeFormatGs1CompositeConfiguration(String regexFilter, Double minimumSizeScore, Boolean addAdditionalQuietZone, Integer minimum1DQuietZoneSize, Gs1Handling gs1Handling, Boolean strictMode)
    • Method Detail

      • getRegexFilter

         String getRegexFilter()

        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 ""

      • setRegexFilter

         Unit setRegexFilter(String 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 ""

      • getMinimumSizeScore

         Double getMinimumSizeScore()

        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

      • setMinimumSizeScore

         Unit setMinimumSizeScore(Double 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

      • getAddAdditionalQuietZone

         Boolean getAddAdditionalQuietZone()

        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

      • setAddAdditionalQuietZone

         Unit setAddAdditionalQuietZone(Boolean 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

      • getMinimum1DQuietZoneSize

         final Integer getMinimum1DQuietZoneSize()

        Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.

        Default is 6

      • setMinimum1DQuietZoneSize

         final Unit setMinimum1DQuietZoneSize(Integer minimum1DQuietZoneSize)

        Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey, and Code11.

        Default is 6

      • getStrictMode

         final Boolean getStrictMode()

        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

      • setStrictMode

         final Unit setStrictMode(Boolean 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