kiteqr/io.github.yuroyami.kiteqr.aztec/AztecReader/decode

decode

open override fun decode(image: BinaryBitmap): Result

Locates and decodes a Data Matrix code in an image.

Return

a String representing the content encoded by the Data Matrix code

Throws

NotFoundException

if a Data Matrix code cannot be found

FormatException

if a Data Matrix code cannot be decoded

open override fun decode(image: BinaryBitmap, hints: Map<DecodeHintType, *>?): Result

Locates and decodes a barcode in some format within an image. This method also accepts hints, each possibly associated to some data, which may help the implementation decode.

Return

String which the barcode encodes

Parameters

image

image of barcode to decode

hints

passed as a Map from DecodeHintType to arbitrary data. The meaning of the data depends upon the hint type. The implementation may or may not do anything with these hints.

Throws

NotFoundException

if no potential barcode is found

ChecksumException

if a potential barcode is found but does not pass its checksum

FormatException

if a potential barcode is found but format is invalid