Skip to content

Commit 45c8f6e

Browse files
Dynamsoft-HenryDynamsoft-Henry
authored
Merge pull request #367 from dynamsoft-docs/preview
update to internal commit 36c1a9dc
2 parents 5b96ba9 + 88eee7b commit 45c8f6e

35 files changed

+193
-402
lines changed

‎_includes/api-reference/region-object-element-android.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33

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

1111

‎_includes/api-reference/region-object-element-ios.md‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11

22

3-
43
| Method | Description |
54
|------- |-------------|
6-
| [`getLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getlocation) | Returns the location info of the element. |
7-
| [`setLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#setlocation) | Sets the location info of the element. |
8-
| [`getReferencedElement`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Returns the referenced element that supports the capturing of this element. |
9-
| [`getRegionObjectElementType`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getregionobjectelementtype) | Returns the type of the element. |
10-
11-
5+
| [`getLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getlocation) | Gets the location of the region object, represented as a quadrilateral. |
6+
| [`getReferencedElement`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Gets the referenced element that supports the capturing of this element. |
7+
| [`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). |
8+
| [`getImageData`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getimagedata) | Gets the image data of this region object element. |

‎programming/android/api-reference/auxiliary-AztecDetails.md‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,10 @@ class AztecDetails extends BarcodeDetails
2727

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

35-
### AztecDetails
36-
37-
The constructor. Initializes a new instance of the AztecDetails class.
38-
39-
```java
40-
AztecDetails()
41-
```
42-
4334
### getRows
4435

4536
Returns the number of rows of the Aztec barcode, indicating how many rows of modules it contains.

‎programming/android/api-reference/auxiliary-DataMatrixDetails.md‎

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,12 @@ class DataMatrixDetails extends BarcodeDetails
2727

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

37-
### DataMatrixDetails
38-
39-
The constructor for the DataMatrixDetails class.
40-
41-
```java
42-
DataMatrixDetails();
43-
```
44-
4536
### getRows
4637

4738
Returns the number of rows of the Data Matrix barcode, indicating how many rows of data modules it contains.
@@ -95,7 +86,7 @@ An integer representing the column count of the barcode data region.
9586
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.
9687

9788
```java
98-
int getDataRegionNumber
89+
int getDataRegionNumber();
9990
```
10091

10192
**Return Value**

‎programming/android/api-reference/auxiliary-ExtendedResult.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ The following methods are inherited from class [`RegionObjectElement`]({{ site.d
6767
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.
6868

6969
```java
70-
EnumExtendedBarcodeResultType getExtendedBarcodeResultType();
70+
@EnumExtendedBarcodeResultType
71+
int getExtendedBarcodeResultType();
7172
```
7273

7374
**Return Value**

‎programming/android/api-reference/auxiliary-OneDCodeDetails.md‎

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,22 +27,13 @@ class OneDCodeDetails extends BarcodeDetails
2727

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

38-
### OneDCodeDetails
39-
40-
The constructor. Initializes a new instance of the `OneDCodeDetails` class.
41-
42-
```java
43-
OneDCodeDetails();
44-
```
45-
4637
### getStartCharsBytes
4738

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

5445
**Return Value**
5546

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

5849
### getStopCharsBytes
5950

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

6657
**Return Value**
6758

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

7061
### getCheckDigitBytes
7162

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

7869
**Return Value**
7970

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

8273
### getStartPatternRange
8374

‎programming/android/api-reference/auxiliary-PDF417Details.md‎

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,22 +27,13 @@ class PDF417Details extends BarcodeDetails
2727

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

38-
### PDF417Details
39-
40-
The constructor. Initializes a new instance of the `PDF417Details` class.
41-
42-
```java
43-
PDF417Details();
44-
```
45-
4637
### getRows
4738

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

6253
```java
63-
byte[] getCodewords();
54+
int[] getCodewords();
6455
```
6556

6657
**Return Value**

‎programming/android/api-reference/auxiliary-QRCodeDetails.md‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ class QRCodeDetails extends BarcodeDetails
2727

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

43-
### QRCodeDetails
44-
45-
The constructor. Initializes a new instance of the `QRCodeDetails` class.
46-
47-
```java
48-
QRCodeDetails()
49-
```
50-
5142
### getRows
5243

5344
Returns the number of rows in the QR Code.

‎programming/android/api-reference/candidate-barcode-zone.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,17 @@ breadcrumbText: CandidateBarcodeZone
2222
class CandidateBarcodeZone
2323
```
2424

25-
## Attributes
25+
## Attributes & Methods
2626

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

32+
| Method | Description |
33+
| ------ | ----------- |
34+
| [`CandidateBarcodeZone`](#candidatebarcodezone) | The constructor. |
35+
3236
### location
3337

3438
The location of the candidate barcode zone within the image represented as a [`Quadrilateral`]({{ site.dcvb_android_api }}core/basic-structures/quadrilateral.html).
@@ -44,3 +48,11 @@ The possible format(s) of the barcode in the candidate barcode zone.
4448
```java
4549
long possibleFormats;
4650
```
51+
52+
### CandidateBarcodeZone
53+
54+
The constructor.
55+
56+
```java
57+
CandidateBarcodeZone(@NonNull Quadrilateral location, @EnumBarcodeFormat long possibleFormats);
58+
```

‎programming/android/api-reference/decoded-barcode-element.md‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ class DecodedBarcodeElement extends RegionObjectElement
4242
| [`setConfidence`](#setconfidence) | Set the confidence score of the barcode recognition result. |
4343
| [`getDetails`](#getdetails) | Returns the `BarcodeDetails` of the decoded barcode. |
4444
| [`getExtendedBarcodeResults`](#getextendedbarcoderesults) | Returns the extended barcode results of the decoded barcode. |
45+
| [`setLocation`](#setlocation) | Sets the location of the decoded barcode. |
4546

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

@@ -81,7 +82,7 @@ byte[] getBytes();
8182

8283
**Return Value**
8384

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

8687
### setBytes
8788

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

138139
```java
139-
void setFormat(EnumBarcodeFormat format);
140+
void setFormat(@EnumBarcodeFormat long format);
140141
```
141142

142143
**Parameters**
@@ -226,3 +227,19 @@ ExtendedBarcodeResult[] getExtendedBarcodeResults();
226227
**Return Value**
227228

228229
An array of [`ExtendedBarcodeResult`](auxiliary-ExtendedResult.md) that represents the extended barcode results.
230+
231+
### setLocation
232+
233+
Sets the location of the decoded barcode.
234+
235+
```java
236+
int setLocation(Quadrilateral location);
237+
```
238+
239+
**Parameters**
240+
241+
`location`: The location of the decoded barcode as a [`Quadrilateral`]({{ site.dcvb_android_api }}core/basic-structures/quadrilateral.html) object.
242+
243+
**Return Value**
244+
245+
Returns 0 if it succeeds. Otherwise, returns an error code.

0 commit comments

Comments
 (0)