scanbotsdk
    Preparing search index...

    Class BarcodeFormatUpcEanConfiguration

    UPC/EAN barcode configuration. Add to scanner configuration to scan EAN-8, EAN-13, UPC-E and UPC-A barcodes.

    Index

    Constructors

    Properties

    _type: "BarcodeFormatUpcEanConfiguration"
    addAdditionalQuietZone: boolean = false

    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.

    barcodeDefectProfile: BarcodeDefectProfile = "GENERIC_AND_THERMAL"

    Specifies which kind of barcode defects are tried to fix.

    Default is GENERIC_AND_THERMAL.

    blurryOneDScanner: ConfigState = "ENABLE"

    If ENABLE, the scanner will try extra-hard to scan linear barcodes that are heavily blurred or otherwise damaged.

    Default is ENABLE.

    convertUpceToUpca: boolean = false

    UPC-E is a 6-digit code, that has its equivalent in UPC-A 12-digit code with number system 0 or 1. If true, convert this 6-digit code into the corresponding 12-digit code. If false, return the UPC-E code as is.

    Default is false.

    damagedBarcodeReconstruction: ConfigState = "ENABLE"

    If ENABLE, the scanner will try extra-hard to scan linear barcodes that are damaged in a way that every single scanline is corrupted, e.g. due to scratches, ink smudges, glare, or other damage or obstruction. Only affects the following barcode formats: Code39, Code128, Ean8, Ean13, and UpcA. Not used in low power or legacy mode.

    Default is ENABLE.

    ean13: boolean = true

    If true, scan and return valid EAN-13 barcodes.

    Default is true.

    ean8: boolean = true

    If true, scan and return valid EAN-8 barcodes.

    Default is true.

    extensions: UpcEanExtensionBehavior = "ALLOW_ANY"

    Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.

    Default is ALLOW_ANY.

    minimum1DQuietZoneSize: number = 6

    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.

    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number = 1

    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only). Linear barcodes are more prone to false positives. Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.

    Default is 1.

    minimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless: number = 1

    In case that EAN/UPC barcodes both with and without extensions are allowed, we require this number of frames on which the standalone EAN or UPC (i.e. without extension) has to be detected to be considered as valid (live scanning only). EAN/UPC barcodes with extensions are more prone to slicing (incomplete decoding). Increasing the number of frames on which a barcode has to decode to the same content reduces the probability that an extension is accidentally missed.

    Default is 1.

    minimumSizeScore: number = 0.0

    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.

    oneDConfirmationMode: OneDConfirmationMode = "THOROUGH"

    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.

    Default is THOROUGH.

    regexFilter: string = ""

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

    stripCheckDigits: boolean = false

    If true, the check digits are stripped from the result.

    Default is false.

    upca: boolean = true

    If true, scan and return valid UPC-A barcodes. If false, but ean13 is true, then UPC-A barcodes will be returned as EAN-13 barcodes.

    Default is true.

    upce: boolean = true

    If true, scan and return valid UPC-E barcodes.

    Default is true.