Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions _includes/api-reference/region-object-element-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

| Method | Description |
|------- |-------------|
| [`getLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getlocation) | Returns the location info of the element. |
| [`setLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#setlocation) | Sets the location info of the element. |
| [`getReferencedElement`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Returns the referenced element that supports the capturing of this element. |
| [`getRegionObjectElementType`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getregionobjectelementtype) | Returns the type of the element. |
| [`getImageData`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html#getlocation) | Returns the ImageData of the image that produce this element. |
| [`getLocation`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html#getlocation) | Returns the location info of the element. |
| [`getReferencedElement`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Returns the referenced element that supports the capturing of this element. |
| [`getType`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html#getregionobjectelementtype) | Returns the type of the element. |


11 changes: 4 additions & 7 deletions _includes/api-reference/region-object-element-ios.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@



| Method | Description |
|------- |-------------|
| [`getLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getlocation) | Returns the location info of the element. |
| [`setLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#setlocation) | Sets the location info of the element. |
| [`getReferencedElement`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Returns the referenced element that supports the capturing of this element. |
| [`getRegionObjectElementType`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getregionobjectelementtype) | Returns the type of the element. |


| [`getLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getlocation) | Gets the location of the region object, represented as a quadrilateral. |
| [`getReferencedElement`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Gets the referenced element that supports the capturing of this element. |
| [`getRegionObjectElementType`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getregionobjectelementtype) | Gets the type of the region object element, defined by the enumeration [`DSRegionObjectElementType`]({{ site.dcv_ios_api }}core/enum/region-object-element-type.html?lang=objc,swift). |
| [`getImageData`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getimagedata) | Gets the image data of this region object element. |
9 changes: 0 additions & 9 deletions programming/android/api-reference/auxiliary-AztecDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,10 @@ class AztecDetails extends BarcodeDetails

| Method | Description |
| ------ | ----------- |
| [`AztecDetails`](#aztecdetails) | The constructor which initializes a new instance of the AztecDetails class. |
| [`getRows`](#getrows) | Returns the number of rows of the Aztec barcode. |
| [`getColumns`](#getcolumns) | Returns the number of columns in the Aztec barcode. |
| [`getLayerNumber`](#getlayernumber) | Returns the layer number of the Aztec barcode. |

### AztecDetails

The constructor. Initializes a new instance of the AztecDetails class.

```java
AztecDetails()
```

### getRows

Returns the number of rows of the Aztec barcode, indicating how many rows of modules it contains.
Expand Down
11 changes: 1 addition & 10 deletions programming/android/api-reference/auxiliary-DataMatrixDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,12 @@ class DataMatrixDetails extends BarcodeDetails

| Method | Description |
| ------ | ----------- |
| [`DataMatrixDetails`](#datamatrixdetails-1) | The constructor for the DataMatrixDetails class. |
| [`getRows`](#getrows) | Returns the number of rows of the Data Matrix barcode. |
| [`getColumns`](#getcolumns) | Returns the number of columns of the Data Matrix barcode. |
| [`getDataRegionRows`](#getdataregionrows) | Returns the number of rows in the data region of the Data Matrix barcode. |
| [`getDataRegionColumns`](#getdataregioncolumns) | Returns the number of columns in the data region of the Data Matrix barcode. |
| [`getDataRegionNumber`](#getdataregionnumber) | Returns the number of data regions in the Data Matrix barcode. |

### DataMatrixDetails

The constructor for the DataMatrixDetails class.

```java
DataMatrixDetails();
```

### getRows

Returns the number of rows of the Data Matrix barcode, indicating how many rows of data modules it contains.
Expand Down Expand Up @@ -95,7 +86,7 @@ An integer representing the column count of the barcode data region.
Returns the number of data regions in the Data Matrix barcode. Data Matrix barcodes can have multiple data regions for storing data redundantly or for error correction purposes.

```java
int getDataRegionNumber
int getDataRegionNumber();
```

**Return Value**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ The following methods are inherited from class [`RegionObjectElement`]({{ site.d
Returns the type of the extended barcode result as a [`ExtendedBarcodeResultType`]({{ site.dbr_android_api }}enum/extended-barcode-result-type.html?lang=android) enumeration item.

```java
EnumExtendedBarcodeResultType getExtendedBarcodeResultType();
@EnumExtendedBarcodeResultType
int getExtendedBarcodeResultType();
```

**Return Value**
Expand Down
15 changes: 3 additions & 12 deletions programming/android/api-reference/auxiliary-OneDCodeDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,13 @@ class OneDCodeDetails extends BarcodeDetails

| Method | Description |
| ------ | ----------- |
| [`OneDCodeDetails`](#onedcodedetails-1) | The constructor. Initializes a new instance of the OneDCodeDetails class. |
| [`getStartCharsBytes`](#getstartcharsbytes) | Returns the start characters of the 1D barcode in a byte array. |
| [`getStopCharsBytes`](#getstopcharsbytes) | Returns the stop characters of the 1D barcode in a byte array. |
| [`getCheckDigitBytes`](#getcheckdigitbytes) | Returns the check digit characters of the 1D barcode in a byte array. |
| [`getStartPatternRange`](#getstartpatternrange) | Returns the position range of the start pattern relative to the barcode's location. |
| [`getMiddlePatternRange`](#getmiddlepatternrange) | Returns the position range of the middle pattern relative to the barcode's location. |
| [`getEndPatternRange`](#getendpatternrange) | Returns the position of the end pattern relative to the barcode location. |

### OneDCodeDetails

The constructor. Initializes a new instance of the `OneDCodeDetails` class.

```java
OneDCodeDetails();
```

### getStartCharsBytes

Returns the start characters of the 1D barcode in a byte array. Start characters are often used to identify the beginning of the barcode.
Expand All @@ -53,7 +44,7 @@ byte[] getStartCharsBytes();

**Return Value**

A [Byte](https://developer.android.com/reference/java/lang/Byte){:target="_blank"} object representing the start characters of the 1D barcode.
A byte array representing the start characters of the 1D barcode.

### getStopCharsBytes

Expand All @@ -65,7 +56,7 @@ byte[] getStopCharsBytes();

**Return Value**

A [Byte](https://developer.android.com/reference/java/lang/Byte){:target="_blank"} object representing the stop characters of the 1D barcode.
A byte array representing the stop characters of the 1D barcode.

### getCheckDigitBytes

Expand All @@ -77,7 +68,7 @@ byte[] getCheckDigitBytes();

**Return Value**

A [Byte](https://developer.android.com/reference/java/lang/Byte){:target="_blank"} object representing the check digit characters of the 1D barcode.
A byte array representing the check digit characters of the 1D barcode.

### getStartPatternRange

Expand Down
11 changes: 1 addition & 10 deletions programming/android/api-reference/auxiliary-PDF417Details.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,13 @@ class PDF417Details extends BarcodeDetails

| Method | Description |
| ------ | ----------- |
| [`PDF417Details`](#pdf417details-1) | The constructor. Initializes a new instance of the `PDF417Details` class. |
| [`getRows`](#getrows) | Returns the number of rows in the PDF417 barcode. |
| [`getCodewords`](#getcodewords) | Returns the code words of the PDF417 barcode. |
| [`getColumns`](#getcolumns) | Returns the number of columns in the PDF417 barcode. |
| [`getErrorCorrectionLevel`](#geterrorcorrectionlevel) | Returns the error correction level of PDF417 code. |
| [`hasLeftRowIndicator`](#hasleftrowindicator) | Indicates whether the left row indicator of the PDF417 code exists. |
| [`hasRightRowIndicator`](#hasrightrowindicator) | Indicates whether the right row indicator of the PDF417 code exists. |

### PDF417Details

The constructor. Initializes a new instance of the `PDF417Details` class.

```java
PDF417Details();
```

### getRows

Returns the number of rows in the PDF417 barcode, indicating how many rows of modules it contains.
Expand All @@ -60,7 +51,7 @@ An integer representing the number of rows in the PDF417 barcode.
Returns the code words of the PDF417 barcode.

```java
byte[] getCodewords();
int[] getCodewords();
```

**Return Value**
Expand Down
9 changes: 0 additions & 9 deletions programming/android/api-reference/auxiliary-QRCodeDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ class QRCodeDetails extends BarcodeDetails

| Method | Description |
| ------ | ----------- |
| [`QRCodeDetails`](#qrcodedetails-1) | The constructor. Initializes a new instance of the `QRCodeDetails` class. |
| [`getRows`](#getrows) | Returns the number of rows in the QR Code. |
| [`getColumns`](#getcolumns) | Returns the number of columns in the QR Code. |
| [`getErrorCorrectionLevel`](#geterrorcorrectionlevel) | Returns the error correction level of the QR Code.|
Expand All @@ -40,14 +39,6 @@ class QRCodeDetails extends BarcodeDetails
| [`getDataMaskPattern`](#getdatamaskpattern) | Gets the data mask pattern reference for QR Code symbols. |
| [`getCodewords`](#getcodewords) | Gets the codewords of the QR Code. |

### QRCodeDetails

The constructor. Initializes a new instance of the `QRCodeDetails` class.

```java
QRCodeDetails()
```

### getRows

Returns the number of rows in the QR Code.
Expand Down
14 changes: 13 additions & 1 deletion programming/android/api-reference/candidate-barcode-zone.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,17 @@ breadcrumbText: CandidateBarcodeZone
class CandidateBarcodeZone
```

## Attributes
## Attributes & Methods

| Attribute | Description |
| --------- | ------------|
| [`location`](#location) | The location of the candidate barcode zone. |
| [`possibleFormats`](#possibleformats) | The possible barcode formats of the barcode in the candidate barcode zone. |

| Method | Description |
| ------ | ----------- |
| [`CandidateBarcodeZone`](#candidatebarcodezone) | The constructor. |

### location

The location of the candidate barcode zone within the image represented as a [`Quadrilateral`]({{ site.dcvb_android_api }}core/basic-structures/quadrilateral.html).
Expand All @@ -44,3 +48,11 @@ The possible format(s) of the barcode in the candidate barcode zone.
```java
long possibleFormats;
```

### CandidateBarcodeZone

The constructor.

```java
CandidateBarcodeZone(@NonNull Quadrilateral location, @EnumBarcodeFormat long possibleFormats);
```
21 changes: 19 additions & 2 deletions programming/android/api-reference/decoded-barcode-element.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ class DecodedBarcodeElement extends RegionObjectElement
| [`setConfidence`](#setconfidence) | Set the confidence score of the barcode recognition result. |
| [`getDetails`](#getdetails) | Returns the `BarcodeDetails` of the decoded barcode. |
| [`getExtendedBarcodeResults`](#getextendedbarcoderesults) | Returns the extended barcode results of the decoded barcode. |
| [`setLocation`](#setlocation) | Sets the location of the decoded barcode. |

The following methods are inherited from [`RegionObjectElement`]({{ site.dcvb_android_api }}core/intermediate-results/region-object-element.html).

Expand Down Expand Up @@ -81,7 +82,7 @@ byte[] getBytes();

**Return Value**

A [Byte](https://developer.android.com/reference/java/lang/Byte){:target="_blank"} object representing the raw bytes of the decoded barcode.
A byte array representing the raw bytes of the decoded barcode.

### setBytes

Expand Down Expand Up @@ -136,7 +137,7 @@ A [`EnumBarcodeFormat`]({{site.dbr_android_api }}enum/barcode-format.html?lang=a
Sets the format of the decoded barcode as a [`EnumBarcodeFormat`]({{site.dbr_android_api }}enum/barcode-format.html?lang=android) item.

```java
void setFormat(EnumBarcodeFormat format);
void setFormat(@EnumBarcodeFormat long format);
```

**Parameters**
Expand Down Expand Up @@ -226,3 +227,19 @@ ExtendedBarcodeResult[] getExtendedBarcodeResults();
**Return Value**

An array of [`ExtendedBarcodeResult`](auxiliary-ExtendedResult.md) that represents the extended barcode results.

### setLocation

Sets the location of the decoded barcode.

```java
int setLocation(Quadrilateral location);
```

**Parameters**

`location`: The location of the decoded barcode as a [`Quadrilateral`]({{ site.dcvb_android_api }}core/basic-structures/quadrilateral.html) object.

**Return Value**

Returns 0 if it succeeds. Otherwise, returns an error code.
9 changes: 9 additions & 0 deletions programming/android/api-reference/decoded-barcodes-result.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ class DecodedBarcodesResult extends CapturedResultBase

| Method | Description |
| ------ | ----------- |
| [`DecodedBarcodesResult`](#decodedbarcodesresult) | The constructor. |
| [`getItems`](#getitems) | Returns an array of `BarcodeResultItem`, which is the basic unit of the captured results. |

The following methods are inherited from [`CapturedResultBase`]({{ site.dcvb_android_api }}core/basic-structures/captured-result-base.html):
Expand All @@ -39,6 +40,14 @@ The following methods are inherited from [`CapturedResultBase`]({{ site.dcvb_and
| [`getErrorCode`]({{ site.dcvb_android_api }}core/basic-structures/captured-result-base.html#geterrorcode) | Gets the error code of this result. |
| [`getErrorMessage`]({{ site.dcvb_android_api }}core/basic-structures/captured-result-base.html#geterrormessage) | Gets the error message of this result. |

### DecodedBarcodesResult

The constructor.

```java
DecodedBarcodesResult();
```

### getItems

Returns an array of [`BarcodeResultItem`](barcode-result-item.md), which is the basic unit of the captured results.
Expand Down
2 changes: 1 addition & 1 deletion programming/android/api-reference/decoded-barcodes-unit.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ void removeAllDecodedBarcodes();
Set the [`DecodedBarcodeElement`](decoded-barcode-element.md) of the `DecodedBarcodesUnit`.

```java
int setDecodedBarcode(DecodedBarcodeElement decodedBarcode, Matrix matrixToOriginalImage);
int setDecodedBarcode(DecodedBarcodeElement element, Matrix matrixToOriginalImage);
```

**Parameters**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,18 @@ permalink: /programming/android/api-reference/deformation-resisted-barcode.html
class DeformationResistedBarcode
```

## Attributes
## Attributes & Methods

| Attribute | Description |
| ------ | ----------- |
| [`imageData`](#imagedata) | The deformation-resisted barcode image data. |
| [`location`](#location) | The location of the deformation-resisted barcode. |
| [`format`](#format) | The format of the deformation-resisted barcode. |

| Method | Description |
| ------ | ----------- |
| [`DeformationResistedBarcode`](#deformationresistedbarcode) | The constructor. |

### imageData

An [`ImageData`]({{ site.dcvb_android_api }}core/basic-structures/image-data.html) object representing the deformation-resisted barcode image.
Expand All @@ -54,3 +58,11 @@ A [`EnumBarcodeFormat`]({{site.dbr_android_api }}enum/barcode-format.html?lang=a
```java
long format;
```

### DeformationResistedBarcode

The constructor.

```java
DeformationResistedBarcode(ImageData imageData, @NonNull Quadrilateral location, @EnumBarcodeFormat long format);
```
19 changes: 18 additions & 1 deletion programming/android/api-reference/localized-barcode-element.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ class LocalizedBarcodeElement extends RegionObjectElement
| [`setPossibleFormats`](#setpossibleformats) | Sets the possible format of the localized barcode. |
| [`getPossibleFormatsString`](#getpossibleformatsstring) | Returns the possible formats of the localized barcode as a string. |
| [`getModuleSize`](#getmodulesize) | Returns the module size of the localized barcode. |
| [`setLocation`](#setlocation) | Sets the location of the localized barcode. |

The following methods are inherited from class [`RegionObjectElement`]({{ site.dcvb_android_api }}core/intermediate-results/region-object-element.html).

Expand Down Expand Up @@ -80,7 +81,7 @@ Returns the possible format(s) of the localized barcode.
Set the possibleformat of the barcode.

```java
void setPossibleFormats(long possibleFormats);
void setPossibleFormats(@EnumBarcodeFormat long possibleFormats);
```

**Parameters**
Expand Down Expand Up @@ -110,3 +111,19 @@ int getModuleSize();
**Return value**

An integer representing the module size of the localized barcode.

### setLocation

Sets the location of the localized barcode.

```java
int setLocation(Quadrilateral location)
```

**Parameters**

`location`: The location of the localized barcode, represented as a [`Quadrilateral`]({{ site.dcvb_android_api }}core/basic-structures/quadrilateral.html).

**Return value**

Returns 0 if the location is set successfully, otherwise returns the error code.
Loading