ResultMetadataType

Represents some type of metadata about the result of the decoding that the decoder wishes to communicate back to the caller.

Entries

Link copied to clipboard

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

Link copied to clipboard

Denotes the likely approximate orientation of the barcode in the image. This value is given as degrees rotated clockwise from the normal, upright orientation. For example a 1D barcode which was found by reading top-to-bottom would be said to have orientation "90". This key maps to an Integer whose value is in the range [0,360).

Link copied to clipboard

2D barcode formats typically encode text, but allow for a sort of 'byte mode' which is sometimes used to encode binary data. While Result makes available the complete raw bytes in the barcode for these formats, it does not offer the bytes from the byte segments alone.

Link copied to clipboard

Error correction level used, if applicable. The value type depends on the format, but is typically a String.

Link copied to clipboard

The number of errors corrected. If applicable, maps to an Integer of value greater than or equal to zero.

Link copied to clipboard

The number of erasures corrected. If applicable, maps to an Integer of value greater than or equal to zero.

Link copied to clipboard

For some periodicals, indicates the issue number as an Integer.

Link copied to clipboard

For some products, indicates the suggested retail price in the barcode as a formatted String.

Link copied to clipboard

For some products, the possible country of manufacture as a String denoting the ISO country code. Some map to multiple possible countries, like "US/CA".

Link copied to clipboard

For some products, the extension text.

Link copied to clipboard

PDF417-specific metadata.

Link copied to clipboard

If the code format supports reader initialization, maps to a Boolean indicating whether or not the symbol is a reader initialization symbol. Reader initialization symbols are used to provide initialization or configuration to a reader.

Link copied to clipboard

If the code format supports structured append and the current scanned code is part of one then the sequence number is given with it.

Link copied to clipboard

If the code format supports structured append and the current scanned code is part of one then the parity is given with it.

Link copied to clipboard

Barcode Symbology Identifier. Note: According to the GS1 specification the identifier may have to replace a leading FNC1/GS character when prepending to the barcode content.

Properties

Link copied to clipboard

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard
expect val name: String
Link copied to clipboard
expect val ordinal: Int

Functions

Link copied to clipboard

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.