WARNING: This server provides a static reference view of the NetKernel documentation. Links to dynamic content do not work. For the best experience we recommend you install NetKernel and view the documentation in the live system .

Endpoint
Name:image.barcode.DecodeBarcode
Description:
Id:image.barcode.DecodeBarcode
Category:accessor
Identifier Syntax

image.barcode.DecodeBarcode is an accessor using Active URI syntax with the following base identifiers:

Base
active:barcodeDecode

and the following arguments: (for more details on argument passing details see here)

ArgumentRulesTypingDescription
operand
Mandatory
Representation (ImageAspect)input image
Request Verbs

The following verb is supported:

Verb
SOURCE
Response

The following response representations can be returned for SOURCE requests:

SOURCE Representations
java.lang.String

This accessor throws no documented exceptions.

Import Requirements

To use image.barcode.DecodeBarcode accessor you must import the module urn:org:netkernel:mod:barcode:

<import>
  <uri>urn:org:netkernel:mod:barcode</uri>
</import>

The operand argument must be an image source transreptable to a binary stream.

Supported Barcode Formats

  • UPC-A and UPC-E
  • EAN-8 and EAN-13
  • Code 39
  • Code 93
  • Code 128
  • QR Code
  • ITF
  • Codabar
  • RSS-14 (all variants)
  • Data Matrix
  • PDF 417 ('alpha' quality)
  • Aztec ('alpha' quality)

Response

The response is a java.lang.String containing the text encoded in the barcode image.

Response Headers

All additional metadata contained in the barcode is supplied in the INKFResponse headers as follows.

BARCODE_FORMAT

A string value of the detected barcode format.

BARCODE_METADATA_HDS

An HDS name-value pair list of all discovered metadata attributes for the barcode.

BARCODE_TIMESTAMP

The timestamp of the barcode.