ZBar.ImageScanner Class Reference

Mid-level image scanner interface. reads barcodes from 2-D images. More...

List of all members.

Public Member Functions
	ImageScanner ()
	Create a new ImageScanner.
int	Scan (Image image)
	Scan an image for symbols.
List< Symbol >	Scan (System.Drawing.Image image)
	Scan an image for symbols.
void	SetConfiguration (SymbolType symbology, Config config, int value)
	Set config for indicated symbology (0 for all) to specified value.
void	Dispose ()
	Release resources held by this object.
Protected Member Functions
virtual void	Dispose (bool disposing)
	Dispose this object.
Properties
bool	Cache [get, set]

---

Detailed Description

Mid-level image scanner interface. reads barcodes from 2-D images.

Definition at line 33 of file ImageScanner.cs.

---

Constructor & Destructor Documentation

ZBar.ImageScanner.ImageScanner

(

)

Create a new ImageScanner.

Definition at line 41 of file ImageScanner.cs.

---

Member Function Documentation

virtual void ZBar.ImageScanner.Dispose

(

bool

disposing

)

[protected, virtual]

Dispose this object.

This boolean disposing parameter here ensures that objects with a finalizer is not disposed, this is method is invoked from the finalizer. Do overwrite, and call, this method in base classes if you use any unmanaged resources.

Parameters:

disposing

A System.Boolean False if called from the finalizer, True if called from Dispose.

Definition at line 135 of file ImageScanner.cs.

void ZBar.ImageScanner.Dispose

(

)

Release resources held by this object.

Definition at line 148 of file ImageScanner.cs.

List<Symbol> ZBar.ImageScanner.Scan

(

System.Drawing.Image

image

)

Scan an image for symbols.

Parameters:

image

A System.Drawing.Image to be scanned for symbols

This method convert the image to the appropriate format, and release the converted image immidiately. While copying all the symbols to a list.

Returns:

A list of symbols found in the image

Definition at line 83 of file ImageScanner.cs.

int ZBar.ImageScanner.Scan

(

Image

image

)

Scan an image for symbols.

Once an image have been scanned the result will be associated with the image. Use image.Symbols to access the symbol list.

Parameters:

image

A Image to be scanned

Returns:

A System.Int32 number of symbols decoded on the image.

Definition at line 62 of file ImageScanner.cs.

void ZBar.ImageScanner.SetConfiguration	(	SymbolType	symbology,
		Config	config,
		int	value
	)

Set config for indicated symbology (0 for all) to specified value.

Definition at line 113 of file ImageScanner.cs.

---

Property Documentation

bool ZBar.ImageScanner.Cache [get, set]

Enable or disable the inter-image result cache (default disabled).

Mostly useful for scanning video frames, the cache filters duplicate results from consecutive images, while adding some consistency checking and hysteresis to the results. this interface also clears the cache.

Definition at line 100 of file ImageScanner.cs.

---

The documentation for this class was generated from the following file:

• libzbar-cil/ImageScanner.cs