candidate-barcode-zones-unit.md

layout	title	description	keywords	needAutoGenerateSidebar	needGenerateH3Content	breadcrumbText	permalink
default-layout	CandidateBarcodeZonesUnit Class - Dynamsoft Barcode Reader Android Edition	CandidateBarcodeZonesUnit class represents a unit that contains candidate barcode zones unit. It inherits from the IntermediateResultUnit class.	candidate barcode zone, CandidateBarcodeZonesUnit, api reference	true	true	CandidateBarcodeZonesUnit	/programming/android/api-reference/candidate-barcode-zones-unit.html

CandidateBarcodeZonesUnit Class

The CandidateBarcodeZonesUnit class represents a unit that contains candidate barcode zones unit. It inherits from the [IntermediateResultUnit]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html) class.

Definition

Assembly: DynamsoftBarcodeReader.aar

Namespace: com.dynamsoft.dbr.intermediate_results

class CandidateBarcodeZonesUnit extends IntermediateResultUnit

Methods

Method	Description
getCandidateBarcodeZones	Get an array of quadrilaterals as the candidate barcode zones.
getCount	Get the number of candidate barcode zones.
getCandidateBarcodeZone	Get a candidate barcode zone.
removeAllCandidateBarcodeZones	Remove all candidate barcode zones.
removeCandidateBarcodeZone	Remove a candidate barcode zone.
addCandidateBarcodeZone	Add a candidate barcode zone.
setCandidateBarcodeZone	Set a candidate barcode zone.

Inherited Methods

The following methods are inherited from class [IntermediateResultUnit]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html).

{%- include api-reference/intermediate-result-unit-android.md -%}

getCandidateBarcodeZones

Get an array of CandidateBarcodeZone as the candidate barcode zones.

CandidateBarcodeZone[] getCandidateBarcodeZones()

getCount

Get the number of candidate barcode zones.

int getCount()

Return Value

Returns the number of candidate barcode zones.

getCandidateBarcodeZone

Get the CandidateBarcodeZone at the specified index.

CandidateBarcodeZone getCandidateBarcodeZone(int index)

Parameters

[in] index: The index of the candidate barcode zone.

Return Value

Returns the CandidateBarcodeZone at the specified index.

removeAllCandidateBarcodeZones

Remove all candidate barcode zones.

void removeAllCandidateBarcodeZones()

removeCandidateBarcodeZone

Remove the CandidateBarcodeZone at the specified index.

int removeCandidateBarcodeZone(int index)

Parameters

[in] index: The index of the candidate barcode zone.

Return Value

Returns the ErrorCode if failed. Otherwise, returns 0.

addCandidateBarcodeZone

Add a CandidateBarcodeZone to the candidate barcode zones array.

int addCandidateBarcodeZone(CandidateBarcodeZone barcodeZone, Matrix matrixToOriginalImage)

Parameters

[in] barcodeZone: The CandidateBarcodeZone to be added.

[in] matrixToOriginalImage: The transformation matrix to the original image.

Return Value

Returns the ErrorCode if failed. Otherwise, returns 0.

setCandidateBarcodeZone

Set the CandidateBarcodeZone at the specified index.

int setCandidateBarcodeZone(int index, CandidateBarcodeZone barcodeZone, Matrix matrixToOriginalImage)

Parameters

[in] index: The index of the candidate barcode zone.

[in] barcodeZone: The CandidateBarcodeZone to be set.

[in] matrixToOriginalImage: The transformation matrix to the original image.

Return Value

Returns the ErrorCode if failed. Otherwise, returns 0.