Table of Contents

Namespace ScanbotSDK.MAUI.Core.Barcode

Classes

AustraliaPostCustomerFormatConverter

Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.

BarcodeAccumulationConfiguration

Configuration for how to accumulate results.

BarcodeAccumulationMethodConverter

The method how to display barcodes from previous frames.

BarcodeDocumentFormatConverter

Type of barcode document format used.

BarcodeDocumentFormats

Barcode document formats.

BarcodeDocumentParserResult

The result of barcode document parsing.

BarcodeFormatAustraliaPostConfiguration

Australia Post barcode configuration. Add to scanner configuration to scan Australia Post barcodes.

BarcodeFormatAztecConfiguration

Aztec configuration. Add to scanner configuration to scan Aztec codes.

BarcodeFormatCodabarConfiguration

Codabar barcode configuration. Add to scanner configuration to scan Codabar barcodes.

BarcodeFormatCode11Configuration

Code 11 barcode configuration. Add to scanner configuration to scan Code 11 barcodes.

BarcodeFormatCode128Configuration

Code 128 barcode configuration. Add to scanner configuration to scan Code 128 barcodes.

BarcodeFormatCode2Of5Configuration

Configuration for all 2-of-5 barcode types (except Interleaved 2-of-5, which is handled by ItfConfig). Add to scanner configuration to scan Code 25, IATA 2-of-5 and Industrial 2-of-5 barcodes.

Industrial 2-of-5 barcodes are a subset of Code 25 barcodes. Any valid Industrial 2-of-5 barcode is also a valid Code 25 barcode.

BarcodeFormatCode39Configuration

Code 39 barcode and derivatives configuration. Add to scanner configuration to scan Code 39, Code 32 (Italian Pharmacode), PZN7 and PZN8 (Pharmazentralnummer) barcodes.

BarcodeFormatCode93Configuration

Code 93 barcode configuration. Add to scanner configuration to scan Code 93 barcodes.

BarcodeFormatCommonConfiguration

Convenience configuration for enabling the scanning of multiple barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple barcodes.

The given configuration will be applied to all enabled barcode formats, if they support it. You can override the common configuration for individual barcode formats by additionally adding their specific configuration to the scanner's configuration.

BarcodeFormatCommonFourStateConfiguration

Convenience configuration for enabling the scanning of multiple four-state barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple four-state codes.

The given configuration will be applied to all enabled barcode formats, if they support it. You can override the common configuration for individual barcode formats by additionally adding their specific configuration to the scanner's configuration.

BarcodeFormatCommonOneDConfiguration

Convenience configuration for enabling the scanning of multiple linear (1D) barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple linear (1D) barcode formats.

The given configuration will be applied to all enabled barcode formats, if they support it. You can override the common configuration for individual barcode formats by additionally adding their specific configuration to the scanner's configuration.

BarcodeFormatCommonTwoDConfiguration

Convenience configuration for enabling the scanning of multiple 2D codes with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple 2D codes.

The given configuration will be applied to all enabled barcode formats, if they support it. You can override the common configuration for individual barcode formats by additionally adding their specific configuration to the scanner's configuration.

BarcodeFormatConfigurationBase

Base class for all barcode configurations.

BarcodeFormatConverter

Enumerates barcode formats.

BarcodeFormatDataBarConfiguration

GS1 DataBar barcode configuration. Add to scanner configuration to scan GS1 DataBar-14, GS1 DataBar-14 Truncated, GS1 DataBar-14 Stacked and GS1 DataBar-14 Stacked Omnidirectional barcodes.

BarcodeFormatDataBarExpandedConfiguration

GS1 DataBar Expanded barcode configuration. Add to scanner configuration to scan GS1 DataBar Expanded and GS1 DataBar Expanded Stacked barcodes.

BarcodeFormatDataBarLimitedConfiguration

GS1 DataBar Limited barcode configuration. Add to scanner configuration to scan GS1 DataBar Limited barcodes.

BarcodeFormatDataMatrixConfiguration

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

BarcodeFormatFourStateConfigurationBase

Base class for all four-state barcode configurations.

BarcodeFormatGs1CompositeConfiguration

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.

BarcodeFormatItfConfiguration

ITF (Interleaved 2-of-5) barcode configuration. Add to scanner configuration to scan Interleaved 2-of-5 (ITF) barcodes.

BarcodeFormatJapanPostConfiguration

Japan Post barcode configuration. Add to scanner configuration to scan Japan Post barcodes.

BarcodeFormatMaxiCodeConfiguration

MaxiCode configuration. Add to scanner configuration to scan MaxiCode codes.

BarcodeFormatMicroPdf417Configuration

MicroPDF417 configuration. Add to scanner configuration to scan MicroPDF417 codes.

BarcodeFormatMsiPlesseyConfiguration

MSI Plessey barcode configuration. Add to scanner configuration to scan MSI Plessey barcodes.

BarcodeFormatOneDConfigurationBase

Base class for all linear (1D) barcode configurations.

BarcodeFormatPdf417Configuration

PDF417 configuration. Add to scanner configuration to scan PDF417 codes.

BarcodeFormatPharmaCodeConfiguration

PharmaCode barcode configuration. Add to scanner configuration to scan linear (1D) Laetus Pharmacode barcodes. Two-track PharmaCode scanning is configured separately through the PharmaCodeTwoTrackConfig class.

BarcodeFormatPharmaCodeTwoTrackConfiguration

PHARMA_CODE_TWO_TRACK barcode configuration. Add to scanner configuration to scan Laetus two-track PharmaCode barcodes. Linear (i.e. one-track) PharmaCode scanning is configured separately through the PharmaCodeConfig class.

BarcodeFormatQrCodeConfiguration

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

BarcodeFormatRoyalMailConfiguration

Royal Mail barcode configuration. Add to scanner configuration to scan Royal Mail (a.k.a. RM4SCC, CBC, BPO 4-State) barcodes.

BarcodeFormatRoyalTntPostConfiguration

Royal TNT Post barcode configuration. Add to scanner configuration to scan Royal TNT Post (a.k.a. KIX, Klant IndeX) barcodes.

BarcodeFormatTwoDConfigurationBase

Base class for all 2D barcode configurations.

BarcodeFormatUpcEanConfiguration

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

BarcodeFormatUspsIntelligentMailConfiguration

USPS Intelligent Mail barcode configuration. Add to scanner configuration to scan USPS Intelligent Mail (a.k.a. USPS OneCode, USPS-STD-11) barcodes.

BarcodeFormats

Lists of barcode formats to decode.

BarcodeItem

A single barcode found in the input image. Barcodes with the same content but different locations in the image are considered separate barcodes.

BarcodeScannerConfiguration

Configuration for the barcode scanner.

BarcodeScannerEngineModeConverter

The engine mode for barcode scanning.

BarcodeScannerResult

The result of barcode scanning.

CharacterEncodingConverter

Enumerates character encodings.

Gs1HandlingConverter

GS1 message handling options. The GS1 standard defines a key-value format for business-centric data that can be encoded into many 1D and 2D barcode types. https://ref.gs1.org/standards/genspecs/

GS1 messages have two representations or formats: a human-readable format and a machine-readable format. The human-readable format uses parentheses to wrap the keys in each pair. For example, the string "(01)012345678901(37)02(3922)00278" contains three AI keys: 01, 37, and 3922. The corresponding values are 012345678901, 02, and 00278.

The machine-readable format uses the special ASCII \x1D character to terminate key-value pairs in the string in cases where the given key implies that the value is variable-length. The equivalent machine-readable string for the above example is "010123456789013702\x1D392200278". In the above example, the 01 AI key is fixed-length, so the \x1D character is not necessary. The 37 AI keys is variable-length, so the \x1D character is necessary after the value in the pair. The 3922 AI key is also variable-length, but it is the last pair in the message, so the \x1D character is not necessary at the end.

The character \x1D is UNPRINTABLE - this means that if you try to print or otherwise visualize a GS1 message containing the \x1D character, you may see a number of different results, depending on how the system handles unprintable characters. You may see a question mark, a box, an escape sequence, a space or nothing at all.

MsiPlesseyChecksumAlgorithmConverter

Checksum algorithm for MSI_PLESSEY.

OneDConfirmationModeConverter

Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes. Some barcode types are naturally prone to false positives (e.g. MSI Plessey). For those barcode types false positives can be drastically reduced (precision can be increased) by requiring that multiple scan-lines in the input scan to the same result. However, this stronger condition can lead to missed barcodes (lower recall). Confirmation is avoided for barcode types, which are by design resistant to false positives, (e.g. Code128) to maximize recall.

RangeEncoding

A character encoding for a given range of bytes.

StructuredAppendInfo

The structured append mode can be used to split a message across multiple barcodes.

UpcEanExtensionBehaviorConverter

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

Enums

AustraliaPostCustomerFormat
BarcodeAccumulationMethod
BarcodeDocumentFormat
BarcodeFormat
BarcodeScannerEngineMode
CharacterEncoding
Gs1Handling
MsiPlesseyChecksumAlgorithm
OneDConfirmationMode
UpcEanExtensionBehavior