ReaderParams class

Represents BarcodeReader object.

Constructors

ReaderParams()

Constructor

ReaderParams.fromJson(Map<String, dynamic> json)

Creates a ReaderParams instance from a JSON representation.

Properties

allowAdditionalRestorations ↔ bool?

Allows engine using additional image restorations to recognize corrupted barcodes. At this time, it is used only in MicroPdf417 barcode type. Default value: False.

getter/setter pair

allowComplexBackground ↔ bool?

Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode.

getter/setter pair

allowDatamatrixIndustrialBarcodes ↔ bool?

Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes. Slow mode which helps only for dashed barcodes which consist from spots.

getter/setter pair

allowDecreasedImage ↔ bool?

Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms. Mode helps to recognize barcodes which are noised and blurred but captured with high resolution.

getter/setter pair

allowDetectScanGap ↔ bool?

Allows engine to use gap between scans to increase recognition speed. Mode can make recognition problems with low height barcodes.

getter/setter pair

allowIncorrectBarcodes ↔ bool?

Allows engine to recognize barcodes which has incorrect checksum or incorrect values. Mode can be used to recognize damaged barcodes with incorrect text.

getter/setter pair

allowInvertImage ↔ bool?

Allows engine to recognize inverse color image as additional scan. Mode can be used when barcode is white on black background.

getter/setter pair

allowMedianSmoothing ↔ bool?

Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes.

getter/setter pair

allowMicroWhiteSpotsRemoving ↔ bool?

Allows engine for Postal barcodes to recognize slightly noised images. Mode helps to recognize slightly damaged Postal barcodes.

getter/setter pair

allowOneDFastBarcodesDetector ↔ bool?

Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image. Mode helps to quickly recognize generated barcodes from Internet.

getter/setter pair

allowOneDWipedBarsRestoration ↔ bool?

Allows engine for 1D barcodes to recognize barcodes with single wiped/glued bars in pattern.

getter/setter pair

allowQRMicroQrRestoration ↔ bool?

Allows engine for QR/MicroQR to recognize damaged MicroQR barcodes.

getter/setter pair

allowRegularImage ↔ bool?

Allows engine to recognize regular image without any restorations as main scan. Mode to recognize image as is.

getter/setter pair

allowSaltAndPepperFiltering ↔ bool?

Allows engine to recognize barcodes with salt and pepper noise type. Mode can remove small noise with white and black dots.

getter/setter pair

allowWhiteSpotsRemoving ↔ bool?

Allows engine to recognize image without small white spots as additional scan. Mode helps to recognize noised image as well as median smoothing filtering.

getter/setter pair

australianPostEncodingTable ↔ CustomerInformationInterpretingType?

Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.

getter/setter pair

checkMore1DVariants ↔ bool?

Allows engine to recognize 1D barcodes with checksum by checking more recognition variants. Default value: False.

getter/setter pair

checksumValidation ↔ ChecksumValidation?

Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies

getter/setter pair

detectEncoding ↔ bool?

A flag which force engine to detect codetext encoding for Unicode.

getter/setter pair

fastScanOnly ↔ bool?

Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms. Default value: False.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

ignoreEndingFillingPatternsForCTable ↔ bool?

The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequence "333" of filling patterns is decoded as letter "z".

getter/setter pair

medianSmoothingWindowSize ↔ int?

Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set.

getter/setter pair

preset ↔ PresetType?

Preset allows to configure recognition quality and speed manually. You can quickly set up Preset by embedded presets: HighPerformance, NormalQuality, HighQuality, MaxBarCodes or you can manually configure separate options. Default value of Preset is NormalQuality.

getter/setter pair

readTinyBarcodes ↔ bool?

Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False.

getter/setter pair

rectHeight ↔ int?

Set Height of area for recognition.

getter/setter pair

rectWidth ↔ int?

Set Width of area for recognition.

getter/setter pair

rectX ↔ int?

Set X of top left corner of area for recognition.

getter/setter pair

rectY ↔ int?

Set Y of top left corner of area for recognition.

getter/setter pair

regionLikelihoodThresholdPercent ↔ double?

Sets threshold for detected regions that may contain barcodes. Value 0.7 means that bottom 70% of possible regions are filtered out and not processed further. Region likelihood threshold must be between 0.05, 0.9 Use high values for clear images with few barcodes. Use low values for images with many barcodes or for noisy images. Low value may lead to a bigger recognition time.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scanWindowSizes ↔ List<int>?

Scan window sizes in pixels. Allowed sizes are 10, 15, 20, 25, 30. Scanning with small window size takes more time and provides more accuracy but may fail in detecting very big barcodes. Combining of several window sizes can improve detection quality.

getter/setter pair

similarity ↔ double?

Similarity coefficient depends on how homogeneous barcodes are. Use high value for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between 0.5, 0.9

getter/setter pair

skipDiagonalSearch ↔ bool?

Allows detector to skip search for diagonal barcodes. Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise. Enabling of diagonal search leads to a bigger detection time.

getter/setter pair

stripFNC ↔ bool?

Value indicating whether FNC symbol strip must be done.

getter/setter pair

timeout ↔ int?

Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 30_000 (1/2 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout.

getter/setter pair

type ↔ DecodeBarcodeType?

The type of barcode to read.

getter/setter pair

types ↔ List<DecodeBarcodeType>?

Multiple barcode types to read.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Returns a JSON representation of ReaderParams.

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

listFromJson(List json) → List<ReaderParams>

Converts a list of JSON objects to a list of ReaderParams instances.