ScanAreaSettings Class Reference

Static Public Member Functions
static ScanAreaSettings	createDefaultPortraitSettings ()
static ScanAreaSettings	createDefaultLandscapeSettings ()

Public Attributes
int	squareCodeLocationConstraint
int	wideCodeLocationConstraint
RectF	squareCodeLocationArea
RectF	wideCodeLocationArea
RectF	searchArea

Detailed Description

Scanning area settings control where codes are to be searched in images/frames.

The areas as well as the hot-spot is specified in relative coordinates. The coordinates are rotated with the device: The top-left corner of the camera preview is 0,0, whereas 1,1 is the bottom-right corner. Coordinates specified outside of the supported range raise an exception.

For most use-cases, the "active scanning area portrait/active scanning area landscape" available as part of the ScanSettings is sufficient and is simpler to use. We only recommend to use the ScanAreaSettings if you have very specific needs for your application that can't be met with the "active scanning area" interface.

This class allows to control the areas separately for wide and square symbologies. Classification of symbologies into square and wide is according to their aspect ratio: symbologies that have a width/height ratio different from one (1d codes, PDF417, etc.) are classified as wide, symbologies whose width/height aspect ratio is close to 1.0 (QR, Aztec etc.) are classified as square. Symbologies whose aspect ratio can vary, e.g. DataMatrix, or DataBar, are classified according to their pre-dominant aspect ratio.

Note

This interface is not part of the stable API yet and is subject to change. Functionality may dissappear, or change in future releases.

Since

5.0

Member Function Documentation

static ScanAreaSettings createDefaultPortraitSettings ( )

static

Create new default settings for portrait scanning.

Returns

A new scan area settings instance

Since

5.0

static ScanAreaSettings createDefaultLandscapeSettings ( )

static

Create new default settings for landscape scanning.

Returns

A new scan area settings instance

Since

5.0

Member Data Documentation

int squareCodeLocationConstraint

The code location constraint to be used for square codes.

Since

5.0

int wideCodeLocationConstraint

The code location constraint to be used for wide codes.

Since

5.0

RectF squareCodeLocationArea

The code location area to be used for square codes.

Depending on squareCodeLocationConstraint, square codes are either only recognized, or given preference in this area.

Since

5.0

RectF wideCodeLocationArea

The code location area to be used for wide codes.

Depending on wideCodeLocationConstraint, square codes are either only recognized, or given preference in this area.

Since

5.0

RectF searchArea

The area in which codes are searched.

When the code location constraint it set to CODE_LOCATION_RESTRICT this area is ignored.

Since

5.0

---

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

• ScanAreaSettings.java