Crate rxing

Modules

aztec

client

common

datamatrix

helpers

maxicode

multi

oned

pdf417

qrcode

result_point_utils

Structs

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.

BufferedImageLuminanceSource

This LuminanceSource implementation is meant for J2SE clients and our blackbox unit tests.

DecodeHints

Dimension

Simply encapsulates a width and height.

EncodeHints

FilteredImageReader

Passed image data is ignored, only the image data

Luma8LuminanceSource

A simple luma8 source for bytes, supports cropping but not rotation

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.

MultiUseMultiFormatReader

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.

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.

PointT

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.

RGBLuminanceSource

This class is used to help decode images from files which arrive as RGB data from an ARGB pixel array. It does not support rotation.

RXingResult

Encapsulates the result of decoding a barcode within an image.

Enums

BarcodeFormat

Enumerates barcode formats known to this package. Please keep alphabetized.

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.

DecodeHintValue

EncodeHintType

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

EncodeHintValue

Exceptions

RXingResultMetadataType

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

RXingResultMetadataValue

Constants

DEFAULT_DOWNSCALE_FACTOR

DEFAULT_DOWNSCALE_THRESHHOLD

Traits

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.

ImmutableReader

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.

Reader

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

ResultPoint

Writer

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

Functions

point

point_f

An alias for Point::new.

point_i

Type Aliases

DecodingHintDictionary

EncodingHintDictionary

MetadataDictionary

Point

PointCallback

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

PointF

PointI

PointU

RXingResultMetaDataDictionary

RXingResultPointCallback

Temporary type to ease refactoring and keep backwards-compatibility