Table of Contents

Class MultiFormatReader

Namespace
ZXing
Assembly
zxing.dll

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.

public sealed class MultiFormatReader : Reader
Inheritance
MultiFormatReader
Implements
Inherited Members

Constructors

MultiFormatReader()

public MultiFormatReader()

Properties

Hints

This method adds state to the MultiFormatReader. By setting the hints once, subsequent calls to decodeWithState(image) can reuse the same set of readers without reallocating memory. This is important for performance in continuous scan clients.

public IDictionary<DecodeHintType, object> Hints { set; }

Property Value

IDictionary<DecodeHintType, object>

Methods

decode(BinaryBitmap)

This version of decode honors the intent of Reader.decode(BinaryBitmap) in that it passes null as a hint to the decoders. However, that makes it inefficient to call repeatedly. Use setHints() followed by decodeWithState() for continuous scan applications.

public Result decode(BinaryBitmap image)

Parameters

image BinaryBitmap

The pixel data to decode

Returns

Result

The contents of the image

decode(BinaryBitmap, IDictionary<DecodeHintType, object>)

Decode an image using the hints provided. Does not honor existing state.

public Result decode(BinaryBitmap image, IDictionary<DecodeHintType, object> hints)

Parameters

image BinaryBitmap

The pixel data to decode

hints IDictionary<DecodeHintType, object>

The hints to use, clearing the previous state.

Returns

Result

The contents of the image

decodeWithState(BinaryBitmap)

Decode an image using the state set up by calling setHints() previously. Continuous scan clients will get a large speed increase by using this instead of decode().

public Result decodeWithState(BinaryBitmap image)

Parameters

image BinaryBitmap

The pixel data to decode

Returns

Result

The contents of the image

reset()

resets all specific readers

public void reset()