Skip to content

Commit 87f20ce

Browse files
Merge pull request #129 from dynamsoft-docs/preview
update to internal commit cd5af663
2 parents 954f002 + cf2a5a6 commit 87f20ce

28 files changed

+1180
-93
lines changed

_data/full_tree.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ tree_file_list:
3030
- sidelist-programming/programming-python-v9.6.20.html
3131
- sidelist-programming/programming-python-v9.6.40.html
3232
- sidelist-programming/programming-python-v10.4.2100.html
33+
- sidelist-programming/programming-python-v10.5.2100.html
3334
- sidelist-programming/programming-python.html
3435
- sidelist-programming/sidelist-architecture.html
3536
- sidelist-programming/sidelist-faq.html

_includes/sidelist-programming/programming-python-v10.5.2100.html

Lines changed: 250 additions & 0 deletions
Large diffs are not rendered by default.

_includes/sidelist-programming/programming-python.html

Lines changed: 54 additions & 38 deletions
Large diffs are not rendered by default.

assets/js/dbrServerVersionSearch.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
[
2+
{
3+
"version": "11.0.2000",
4+
"matchVersion": {
5+
"python": "3.0.2000"
6+
}
7+
},
28
{
39
"version": "11.0.1000",
410
"matchVersion": {

programming/python/api-reference/barcode-result-item.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Returns the format of the decoded barcode result which is a value of the `EnumBa
4949

5050
**See Also**
5151

52-
[EnumBarcodeFormat]({{ site.dcvb_enumerations }}barcode-reader/barcode-format.html?lang=python)
52+
[EnumBarcodeFormat]({{ site.dbr_python_api }}enum-barcode-format.html)
5353

5454
### get_format_string
5555

programming/python/api-reference/candidate-barcode-zone.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Returns the posssible formats of the candidate barcode.
8787

8888
**See Also**
8989

90-
[EnumBarcodeFormat]({{ site.dcvb_enumerations }}barcode-reader/barcode-format.html?lang=python)
90+
[EnumBarcodeFormat]({{ site.dbr_python_api }}enum-barcode-format.html)
9191

9292
### set_possible_formats
9393

@@ -103,4 +103,4 @@ def set_possible_formats(self, formats: int) -> None:
103103

104104
**See Also**
105105

106-
[EnumBarcodeFormat]({{ site.dcvb_enumerations }}barcode-reader/barcode-format.html?lang=python)
106+
[EnumBarcodeFormat]({{ site.dbr_python_api }}enum-barcode-format.html)

programming/python/api-reference/decoded-barcode-element.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Returns the format of the barcode. This is one of the values of the `EnumBarcode
6262

6363
**See Also**
6464

65-
[EnumBarcodeFormat]({{ site.dcvb_enumerations }}barcode-reader/barcode-format.html?lang=python)
65+
[EnumBarcodeFormat]({{ site.dbr_python_api }}enum-barcode-format.html)
6666

6767
### get_format_string
6868

@@ -227,7 +227,7 @@ def set_format(self, format: int) -> None:
227227

228228
**See Also**
229229

230-
[EnumBarcodeFormat]({{ site.dcvb_enumerations }}barcode-reader/barcode-format.html?lang=python)
230+
[EnumBarcodeFormat]({{ site.dbr_python_api }}enum-barcode-format.html)
231231

232232
### set_text
233233

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
layout: default-layout
3+
title: DecodedBarcodesResult Class - Dynamsoft Barcode Reader Module Python Edition API Reference
4+
description: Definition of DecodedBarcodesResult class in Dynamsoft Barcode Reader Module Python Edition.
5+
keywords: get_original_image_hash_id, get_items, get_error_code, DecodedBarcodesResult, api reference
6+
---
7+
# DecodedBarcodesResult Class
8+
9+
The `DecodedBarcodesResult` class represents the result of a barcode reading process. It provides access to information about the decoded barcodes, the source image, and any errors that occurred during the barcode reading process.
10+
11+
## Definition
12+
13+
*Module:* dynamsoft_barcode_reader
14+
15+
```python
16+
class DecodedBarcodesResult
17+
```
18+
19+
## Methods
20+
21+
| Method | Description |
22+
|----------------------|-------------|
23+
| [`get_error_code`](#get_error_code) | Gets the error code of the barcode reading result, if an error occurred. |
24+
| [`get_error_string`](#get_error_string) | Gets the error message of the barcode reading result, if an error occurred. |
25+
| [`get_items`](#get_items) | Gets all the barcode result items. |
26+
| [`get_original_image_hash_id`](#get_original_image_hash_id) | Gets the hash ID of the source image. |
27+
| [`get_original_image_tag`](#get_original_image_tag) | Gets the tag of the source image. |
28+
| [`get_rotation_transform_matrix`](#get_rotation_transform_matrix) | Gets the 3x3 rotation transformation matrix of the original image relative to the rotated image.|
29+
30+
### get_error_code
31+
32+
Gets the error code of the barcode reading result, if an error occurred.
33+
34+
```python
35+
def get_error_code(self) -> int:
36+
```
37+
38+
**Return Value**
39+
40+
Returns the error code of the barcode reading result, or 0 if no error occurred.
41+
42+
**See Also**
43+
44+
[EnumErrorCode]({{ site.dcvb_python_api }}core/enum-error-code.html)
45+
46+
### get_error_string
47+
48+
Gets the error message of the barcode reading result, if an error occurred.
49+
50+
```python
51+
def get_error_string(self) -> str:
52+
```
53+
54+
**Return Value**
55+
56+
Returns a string containing the error message of the barcode reading result, or an empty string if no error occurred.
57+
58+
### get_items
59+
60+
Gets all the decoded barcode result items.
61+
62+
```python
63+
def get_items(self) -> List[BarcodeResultItem]:
64+
```
65+
66+
**Return Value**
67+
68+
Returns a `BarcodeResultItem` list.
69+
70+
**See Also**
71+
72+
[BarcodeResultItem]({{ site.dbr_python_api }}barcode-result-item.html)
73+
74+
### get_original_image_hash_id
75+
76+
Gets the hash ID of the source image.
77+
78+
```python
79+
def get_original_image_hash_id(self) -> str:
80+
```
81+
82+
**Return Value**
83+
84+
Returns a string containing the hash ID of the source image.
85+
86+
### get_original_image_tag
87+
88+
Gets the tag of the source image.
89+
90+
```python
91+
def get_original_image_tag(self) -> ImageTag:
92+
```
93+
94+
**Return Value**
95+
96+
Returns an `ImageTag` object representing the tag of the source image.
97+
98+
**See Also**
99+
100+
[ImageTag]({{ site.dcvb_python_api }}core/basic-classes/image-tag.html)
101+
102+
### get_rotation_transform_matrix
103+
104+
Gets the 3x3 rotation transformation matrix of the original image relative to the rotated image.
105+
106+
```python
107+
def get_rotation_transform_matrix(self) -> List[float]:
108+
```
109+
110+
**Return Value**
111+
112+
Returns a float list of length 9 which represents a 3x3 rotation matrix.

programming/python/api-reference/decoded-barcodes-result.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@ The `DecodedBarcodesResult` class represents the result of a barcode reading pro
1212

1313
*Module:* dynamsoft_barcode_reader
1414

15+
*Inheritance:* [CapturedResultBase]({{ site.dcvb_python_api }}core/basic-classes/captured-result-base.html) -> DecodedBarcodesResult
16+
1517
```python
16-
class DecodedBarcodesResult
18+
class DecodedBarcodesResult(CapturedResultBase):
1719
```
1820

1921
## Methods
@@ -41,7 +43,7 @@ Returns the error code of the barcode reading result, or 0 if no error occurred.
4143

4244
**See Also**
4345

44-
[EnumErrorCode]({{ site.dcvb_enumerations }}core/error-code.html?lang=python)
46+
[EnumErrorCode]({{ site.dcvb_python_api }}core/enum-error-code.html)
4547

4648
### get_error_string
4749

programming/python/api-reference/deformation-resisted-barcode.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ def __init__(self, *args):
4949

5050
[Quadrilateral]({{ site.dcvb_python_api }}core/basic-classes/quadrilateral.html)
5151

52-
[EnumBarcodeFormat]({{ site.dcvb_enumerations }}barcode-reader/barcode-format.html?lang=python)
52+
[EnumBarcodeFormat]({{ site.dbr_python_api }}enum-barcode-format.html)
5353

5454
### get_format
5555

@@ -65,7 +65,7 @@ Returns the format of the deformation resisted barcode.
6565

6666
**See Also**
6767

68-
[EnumBarcodeFormat]({{ site.dcvb_enumerations }}barcode-reader/barcode-format.html?lang=python)
68+
[EnumBarcodeFormat]({{ site.dbr_python_api }}enum-barcode-format.html)
6969

7070
### set_format
7171

@@ -81,7 +81,7 @@ def set_format(self, format: int) -> None:
8181

8282
**See Also**
8383

84-
[EnumBarcodeFormat]({{ site.dcvb_enumerations }}barcode-reader/barcode-format.html?lang=python)
84+
[EnumBarcodeFormat]({{ site.dbr_python_api }}enum-barcode-format.html)
8585

8686
### get_image_data
8787

0 commit comments

Comments
 (0)