DecodeHintType enum

Encapsulates a type of hint that a caller may pass to a barcode reader to help it more quickly or accurately decode it. It is up to implementations to decide what, if anything, to do with the information that is supplied.

Inheritance
Available extensions

Values

other → const DecodeHintType

Unspecified, application-specific hint. Maps to an unspecified Object.

const DecodeHintType(Object)
pureBarcode → const DecodeHintType

Image is a pure monochrome image of a barcode. Doesn't matter what it maps to; use booltrue.

const DecodeHintType(Null)
possibleFormats → const DecodeHintType

Image is known to be of one of a few possible formats. Maps to a List of BarcodeFormats.

const DecodeHintType(List)
tryHarder → const DecodeHintType

Spend more time to try to find a barcode; optimize for accuracy, not speed. Doesn't matter what it maps to; use booltrue.

const DecodeHintType(Null)
characterSet → const DecodeHintType

Specifies what character encoding to use when decoding, where applicable (type String)

const DecodeHintType(String)
allowedLengths → const DecodeHintType

Allowed lengths of encoded data -- reject anything else. Maps to an List<int>.

const DecodeHintType(List<int>)
assumeCode39CheckDigit → const DecodeHintType

Assume Code 39 codes employ a check digit. Doesn't matter what it maps to; use {@link bool#TRUE}.

const DecodeHintType(Null)
assumeGs1 → const DecodeHintType

Assume the barcode is being processed as a GS1 barcode, and modify behavior as needed. For example this affects FNC1 handling for Code 128 (aka GS1-128). Doesn't matter what it maps to; use booltrue.

const DecodeHintType(Null)
returnCodabarStartEnd → const DecodeHintType

If true, return the start and end digits in a Codabar barcode instead of stripping them. They are alpha, whereas the rest are numeric. By default, they are stripped, but this causes them to not be. Doesn't matter what it maps to; use booltrue.

const DecodeHintType(Null)
needResultPointCallback → const DecodeHintType

The caller needs to be notified via callback when a possible ResultPoint is found. Maps to a ResultPointCallback.

const DecodeHintType(ResultPointCallback)
allowedEanExtensions → const DecodeHintType

Allowed extension lengths for EAN or UPC barcodes. Other formats will ignore this. Maps to an List<int> of the allowed extension lengths, for example 2, 5, or 2, 5. If it is optional to have an extension, do not set this hint. If this is set, and a UPC or EAN barcode is found but an extension is not, then no result will be returned at all.

const DecodeHintType(List<int>)
alsoInverted → const DecodeHintType

If true, also tries to decode as inverted image. All configured decoders are simply called a second time with an inverted image. Doesn't matter what it maps to; use booltrue.

const DecodeHintType(Null)

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
valueType → Type
Data type the hint is expecting. Among the possible values the Null stands out as being used for hints that do not expect a value to be supplied (flag hints). Such hints will possibly have their value ignored, or replaced by a booltrue. Hint suppliers should probably use booltrue as directed by the actual hint documentation.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<DecodeHintType>
A constant List of the values in this enum, in order of their declaration.