Table of Contents

Namespace ZXing

Classes

BarcodeReader

A smart class to decode the barcode inside a bitmap object

BarcodeReaderExtensions

extensions methods which are working directly on any IBarcodeReaderGeneric implementation

BarcodeReaderGeneric

A smart class to decode the barcode inside a bitmap object

BarcodeReader<T>

A smart class to decode the barcode inside a bitmap object

BarcodeWriter

A smart class to encode some content to a barcode image

BarcodeWriterExtensions

extensions methods which are working directly on any BarcodeWriterGeneric implementation

BarcodeWriterGeneric

A base class for specific barcode writers with specific formats of barcode images.

BarcodeWriterGeometryExtensions

extensions methods which are working directly on any BarcodeWriterGeneric implementation

BarcodeWriterPixelData

A smart class to encode some content to raw pixel data

BarcodeWriterSvg

A smart class to encode some content to a svg barcode image

BarcodeWriter<TOutput>

A base class for specific barcode writers with specific formats of barcode images.

BaseLuminanceSource

The base class for luminance sources which supports cropping and rotating based upon the luminance values.

Binarizer

This class hierarchy provides a set of methods to convert luminance data to 1 bit data. It allows the algorithm to vary polymorphically, for example allowing a very expensive thresholding technique for servers and a fast one for mobile. It also permits the implementation to vary, e.g. a JNI version for Android and a Java fallback version for other platforms.

       <author>dswitkin@google.com (Daniel Switkin)</author>
BinaryBitmap

This class is the core bitmap class used by ZXing to represent 1 bit data. Reader objects accept a BinaryBitmap and attempt to decode it.

BitmapLuminanceSource

class which represents the luminance values for a bitmap object

BitmapSourceLuminanceSource

class which represents the luminance source values for bitmap source objects

Dimension

Simply encapsulates a width and height.

FormatException

Thrown when a barcode was successfully detected, but some aspect of the content did not conform to the barcode's format rules. This could have been due to a mis-detection. Sean Owen

InvertedLuminanceSource

A wrapper implementation of {@link LuminanceSource} which inverts the luminances it returns -- black becomes white and vice versa, and each value becomes (255-value).

LuminanceSource

The purpose of this class hierarchy is to abstract different bitmap implementations across platforms into a standard interface for requesting greyscale luminance values. The interface only provides immutable methods; therefore crop and rotation create copies. This is to ensure that one Reader does not modify the original luminance source and leave it in an unknown state for other Readers in the chain.

MultiFormatReader

MultiFormatReader is a convenience class and the main entry point into the library for most uses. By default it attempts to decode all barcode formats that the library supports. Optionally, you can provide a hints object to request different behavior, for example only decoding QR codes.

MultiFormatWriter

This is a factory class which finds the appropriate Writer subclass for the BarcodeFormat requested and encodes the barcode with the supplied contents.

PlanarYUVLuminanceSource

This object extends LuminanceSource around an array of YUV data returned from the camera driver, with the option to crop to a rectangle within the full data. This can be used to exclude superfluous pixels around the perimeter and speed up decoding. It works for any pixel format where the Y channel is planar and appears first, including YCbCr_420_SP and YCbCr_422_SP. @author dswitkin@google.com (Daniel Switkin)

RGBLuminanceSource

Luminance source class which support different formats of images.

ReaderException

The general exception class throw when something goes wrong during decoding of a barcode. This includes, but is not limited to, failing checksums / error correction algorithms, being unable to locate finder timing patterns, and so on.

Result

Encapsulates the result of decoding a barcode within an image.

ResultPoint

Encapsulates a point of interest in an image containing a barcode. Typically, this would be the location of a finder pattern or the corner of the barcode, for example.

SupportClass

Contains conversion support elements such as classes, interfaces and static methods.

WriterException

A base class which covers the range of exceptions which may occur when encoding a barcode using the Writer framework.

Interfaces

IBarcodeReader

Interface for a smart class to decode the barcode inside a bitmap object

IBarcodeReaderGeneric

Interface for a smart class to decode the barcode inside a bitmap object

IBarcodeReader<T>

Interface for a smart class to decode the barcode inside a bitmap object

IBarcodeWriter

Interface for a smart class to encode some content into a barcode

IBarcodeWriterGeneric

Interface for a smart class to encode some content into a barcode

IBarcodeWriterPixelData

Interface for a smart class to encode some content into a barcode

IBarcodeWriterSvg

Interface for a smart class to encode some content into a barcode

IBarcodeWriter<TOutput>

Interface for a smart class to encode some content into a barcode

Reader

Implementations of this interface can decode an image of a barcode in some format into the String it encodes. For example, QRCodeReader can decode a QR code. The decoder may optionally receive hints from the caller which may help it decode more quickly or accurately.

See MultiFormatReader, which attempts to determine what barcode format is present within the image as well, and then decodes it accordingly.

Writer

The base class for all objects which encode/generate a barcode image.

Enums

BarcodeFormat

Enumerates barcode formats known to this package.

DecodeHintType

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. decode(BinaryBitmap, IDictionary<DecodeHintType, object>)

EncodeHintType

These are a set of hints that you may pass to Writers to specify their behavior.

RGBLuminanceSource.BitmapFormat

enumeration of supported bitmap format which the RGBLuminanceSource can process

ResultMetadataType

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

Delegates

ResultPointCallback

Callback which is invoked when a possible result point (significant point in the barcode image such as a corner) is found.