Skip to content

Commit 24fc8f7

Browse files
Mark-DynamsoftMark-Dynamsoft
committed
Updates for 3.4.1000
1 parent 34e8f26 commit 24fc8f7

146 files changed

Lines changed: 1745 additions & 300 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎_includes/sidelist-programming/programming-cpp.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@
6767
<li><a href="{{ site.dbr_cpp_api }}decoded-barcodes-unit.html" class="otherLinkColour">CDecodedBarcodesUnit</a></li>
6868
<li><a href="{{ site.dbr_cpp_api }}deformation-resisted-barcode-image-unit.html" class="otherLinkColour">CDeformationResistedBarcodeImageUnit</a></li>
6969
<li><a href="{{ site.dbr_cpp_api }}deformation-resisted-barcode.html" class="otherLinkColour">CDeformationResistedBarcode</a></li>
70+
<li><a href="{{ site.dbr_cpp_api }}eci-segment.html" class="otherLinkColour">CECISegment</a></li>
7071
<li><a href="{{ site.dbr_cpp_api }}extended-barcode-result.html" class="otherLinkColour">CExtendedBarcodeResult</a></li>
7172
<li><a href="{{ site.dbr_cpp_api }}localized-barcode-element.html" class="otherLinkColour">CLocalizedBarcodeElement</a></li>
7273
<li><a href="{{ site.dbr_cpp_api }}localized-barcodes-unit.html" class="otherLinkColour">CLocalizedBarcodesUnit</a></li>
@@ -180,6 +181,7 @@
180181
<li><a>Classes</a>
181182
<ul>
182183
<li><a href="{{ site.dcvb_cpp_api }}core/intermediate-results/abstract-intermediate-result-receiver.html" class="otherLinkColour">CAbstractIntermediateResultReceiver</a></li>
184+
<li><a href="{{ site.dcvb_cpp_api }}core/intermediate-results/auxiliary-region-element.html" class="otherLinkColour">CAuxiliaryRegionElement</a></li>
183185
<li><a href="{{ site.dcvb_cpp_api }}core/intermediate-results/binary-image-unit.html" class="otherLinkColour">CBinaryImageUnit</a></li>
184186
<li><a href="{{ site.dcvb_cpp_api }}core/basic-structures/captured-result-base.html" class="otherLinkColour">CCapturedResultBase</a></li>
185187
<li><a href="{{ site.dcvb_cpp_api }}core/basic-structures/captured-result-item.html" class="otherLinkColour">CCapturedResultItem</a></li>
@@ -280,6 +282,12 @@
280282
<li><a href="{{ site.dcvb_cpp_api }}license/license-module.html" class="otherLinkColour">CLicenseModule</a></li>
281283
</ul>
282284
</li>
285+
<li><a>DynamsoftIdentityUtility</a>
286+
<ul>
287+
<li><a href="{{ site.dcvb_cpp_api }}id-utility/identity-processor.html" class="otherLinkColour">CIdentityProcessor</a></li>
288+
<li><a href="{{ site.dcvb_cpp_api }}id-utility/identity-utility-module.html" class="otherLinkColour">CIdentityUtilityModule</a></li>
289+
</ul>
290+
</li>
283291
<li><a>DynamsoftImageProcessing</a>
284292
<ul>
285293
<li><a href="{{ site.dcvb_cpp_api }}image-processing/image-processing-module.html" class="otherLinkColour">CImageProcessingModule</a></li>

‎_includes/sidelist-programming/programming-dotnet.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@
6464
<li><a href="{{ site.dbr_dotnet_api }}decoded-barcodes-unit.html" class="otherLinkColour">DecodedBarcodesUnit</a></li>
6565
<li><a href="{{ site.dbr_dotnet_api }}deformation-resisted-barcode-image-unit.html" class="otherLinkColour">DeformationResistedBarcodeImageUnit</a></li>
6666
<li><a href="{{ site.dbr_dotnet_api }}deformation-resisted-barcode.html" class="otherLinkColour">DeformationResistedBarcode</a></li>
67+
<li><a href="{{ site.dbr_dotnet_api }}eci-segment.html" class="otherLinkColour">ECISegment</a></li>
6768
<li><a href="{{ site.dbr_dotnet_api }}extended-barcode-result.html" class="otherLinkColour">ExtendedBarcodeResult</a></li>
6869
<li><a href="{{ site.dbr_dotnet_api }}localized-barcode-element.html" class="otherLinkColour">LocalizedBarcodeElement</a></li>
6970
<li><a href="{{ site.dbr_dotnet_api }}localized-barcodes-unit.html" class="otherLinkColour">LocalizedBarcodesUnit</a></li>
@@ -165,6 +166,7 @@
165166
<li><a>Classes</a>
166167
<ul>
167168
<li><a href="{{ site.dcvb_dotnet_api }}core/intermediate-results/abstract-intermediate-result-receiver.html" class="otherLinkColour">AbstractIntermediateResultReceiver</a></li>
169+
<li><a href="{{ site.dcvb_dotnet_api }}core/intermediate-results/auxiliary-region-element.html" class="otherLinkColour">AuxiliaryRegionElement</a></li>
168170
<li><a href="{{ site.dcvb_dotnet_api }}core/intermediate-results/binary-image-unit.html" class="otherLinkColour">BinaryImageUnit</a></li>
169171
<li><a href="{{ site.dcvb_dotnet_api }}core/basic-classes/captured-result-base.html" class="otherLinkColour">CapturedResultBase</a></li>
170172
<li><a href="{{ site.dcvb_dotnet_api }}core/basic-classes/captured-result-item.html" class="otherLinkColour">CapturedResultItem</a></li>
@@ -264,6 +266,12 @@
264266
<li><a href="{{ site.dcvb_dotnet_api }}license/license-module.html" class="otherLinkColour">LicenseModule</a></li>
265267
</ul>
266268
</li>
269+
<li><a>DynamsoftIdentityUtility</a>
270+
<ul>
271+
<li><a href="{{ site.dcvb_dotnet_api }}id-utility/identity-processor.html" class="otherLinkColour">IdentityProcessor</a></li>
272+
<li><a href="{{ site.dcvb_dotnet_api }}id-utility/identity-utility-module.html" class="otherLinkColour">IdentityUtilityModule</a></li>
273+
</ul>
274+
</li>
267275
<li><a>DynamsoftImageProcessing</a>
268276
<ul>
269277
<li><a href="{{ site.dcvb_dotnet_api }}image-processing/image-processing-module.html" class="otherLinkColour">ImageProcessingModule</a></li>

‎_includes/sidelist-programming/programming-java.html‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/captured-result.html" class="otherLinkColour">CapturedResult</a></li>
2727
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html" class="otherLinkColour">IntermediateResultManager</a></li>
2828
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html" class="otherLinkColour">IntermediateResultReceiver</a></li>
29-
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/preset-template.html" class="otherLinkColour">PresetTemplate</a></li>
3029
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html" class="otherLinkColour">SimplifiedCaptureVisionSettings</a></li>
3130
</ul>
3231
</li>
@@ -40,6 +39,7 @@
4039
<ul>
4140
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/enum-capture-state.html" class="otherLinkColour">EnumCaptureState</a></li>
4241
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/enum-image-source-state.html" class="otherLinkColour">EnumImageSourceState</a></li>
42+
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/enum-preset-template.html" class="otherLinkColour">EnumPresetTemplate</a></li>
4343
</ul>
4444
</li>
4545
</ul>
@@ -62,6 +62,7 @@
6262
<li><a href="{{ site.dbr_java_api }}decoded-barcodes-unit.html" class="otherLinkColour">DecodedBarcodesUnit</a></li>
6363
<li><a href="{{ site.dbr_java_api }}deformation-resisted-barcode-image-unit.html" class="otherLinkColour">DeformationResistedBarcodeImageUnit</a></li>
6464
<li><a href="{{ site.dbr_java_api }}deformation-resisted-barcode.html" class="otherLinkColour">DeformationResistedBarcode</a></li>
65+
<li><a href="{{ site.dbr_java_api }}eci-segment.html" class="otherLinkColour">ECISegment</a></li>
6566
<li><a href="{{ site.dbr_java_api }}extended-barcode-result.html" class="otherLinkColour">ExtendedBarcodeResult</a></li>
6667
<li><a href="{{ site.dbr_java_api }}localized-barcode-element.html" class="otherLinkColour">LocalizedBarcodeElement</a></li>
6768
<li><a href="{{ site.dbr_java_api }}localized-barcodes-unit.html" class="otherLinkColour">LocalizedBarcodesUnit</a></li>
@@ -165,6 +166,7 @@
165166
<li><a>Classes</a>
166167
<ul>
167168
<li><a href="{{ site.dcvb_java_api }}core/intermediate-results/abstract-intermediate-result-receiver.html" class="otherLinkColour">AbstractIntermediateResultReceiver</a></li>
169+
<li><a href="{{ site.dcvb_java_api }}core/intermediate-results/auxiliary-region-element.html" class="otherLinkColour">AuxiliaryRegionElement</a></li>
168170
<li><a href="{{ site.dcvb_java_api }}core/intermediate-results/binary-image-unit.html" class="otherLinkColour">BinaryImageUnit</a></li>
169171
<li><a href="{{ site.dcvb_java_api }}core/basic-classes/captured-result-base.html" class="otherLinkColour">CapturedResultBase</a></li>
170172
<li><a href="{{ site.dcvb_java_api }}core/basic-classes/captured-result-item.html" class="otherLinkColour">CapturedResultItem</a></li>
@@ -269,6 +271,12 @@
269271
<li><a href="{{ site.dcvb_java_api }}license/license-module.html" class="otherLinkColour">LicenseModule</a></li>
270272
</ul>
271273
</li>
274+
<li><a>DynamsoftIdentityUtility</a>
275+
<ul>
276+
<li><a href="{{ site.dcvb_java_api }}id-utility/identity-processor.html" class="otherLinkColour">IdentityProcessor</a></li>
277+
<li><a href="{{ site.dcvb_java_api }}id-utility/identity-utility-module.html" class="otherLinkColour">IdentityUtilityModule</a></li>
278+
</ul>
279+
</li>
272280
<li><a>DynamsoftImageProcessing</a>
273281
<ul>
274282
<li><a href="{{ site.dcvb_java_api }}image-processing/image-processing-module.html" class="otherLinkColour">ImageProcessingModule</a></li>

‎_includes/sidelist-programming/programming-python.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@
6363
<li><a href="{{ site.dbr_python_api }}decoded-barcodes-unit.html" class="otherLinkColour">DecodedBarcodesUnit</a></li>
6464
<li><a href="{{ site.dbr_python_api }}deformation-resisted-barcode-image-unit.html" class="otherLinkColour">DeformationResistedBarcodeImageUnit</a></li>
6565
<li><a href="{{ site.dbr_python_api }}deformation-resisted-barcode.html" class="otherLinkColour">DeformationResistedBarcode</a></li>
66+
<li><a href="{{ site.dbr_python_api }}eci-segment.html" class="otherLinkColour">ECISegment</a></li>
6667
<li><a href="{{ site.dbr_python_api }}extended-barcode-result.html" class="otherLinkColour">ExtendedBarcodeResult</a></li>
6768
<li><a href="{{ site.dbr_python_api }}localized-barcode-element.html" class="otherLinkColour">LocalizedBarcodeElement</a></li>
6869
<li><a href="{{ site.dbr_python_api }}localized-barcodes-unit.html" class="otherLinkColour">LocalizedBarcodesUnit</a></li>
@@ -164,6 +165,7 @@
164165
<li><a>Classes</a>
165166
<ul>
166167
<li><a href="{{ site.dcvb_python_api }}core/intermediate-results/abstract-intermediate-result-receiver.html" class="otherLinkColour">AbstractIntermediateResultReceiver</a></li>
168+
<li><a href="{{ site.dcvb_python_api }}core/intermediate-results/auxiliary-region-element.html" class="otherLinkColour">AuxiliaryRegionElement</a></li>
167169
<li><a href="{{ site.dcvb_python_api }}core/intermediate-results/binary-image-unit.html" class="otherLinkColour">BinaryImageUnit</a></li>
168170
<li><a href="{{ site.dcvb_python_api }}core/basic-classes/captured-result-base.html" class="otherLinkColour">CapturedResultBase</a></li>
169171
<li><a href="{{ site.dcvb_python_api }}core/basic-classes/captured-result-item.html" class="otherLinkColour">CapturedResultItem</a></li>
@@ -259,6 +261,12 @@
259261
<li><a href="{{ site.dcvb_python_api }}license/license-module.html" class="otherLinkColour">LicenseModule</a></li>
260262
</ul>
261263
</li>
264+
<li><a>DynamsoftIdentityUtility</a>
265+
<ul>
266+
<li><a href="{{ site.dcvb_python_api }}id-utility/identity-processor.html" class="otherLinkColour">IdentityProcessor</a></li>
267+
<li><a href="{{ site.dcvb_python_api }}id-utility/identity-utility-module.html" class="otherLinkColour">IdentityUtilityModule</a></li>
268+
</ul>
269+
</li>
262270
<li><a>DynamsoftImageProcessing</a>
263271
<ul>
264272
<li><a href="{{ site.dcvb_python_api }}image-processing/image-processing-module.html" class="otherLinkColour">ImageProcessingModule</a></li>

‎_includes/sidelist-programming/sidelist-parameters-organization.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,7 @@
434434
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-width-range-array.html" class="otherLinkColour">BarcodeWidthRangeArray</a></li>
435435
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-zone-bar-count-range-array.html" class="otherLinkColour">BarcodeZoneBarCountRangeArray</a></li>
436436
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-zone-min-distance-to-image-borders.html" class="otherLinkColour">BarcodeZoneMinDistanceToImageBorders</a></li>
437+
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-zone-width-to-height-ratio-range-array.html" class="otherLinkColour">BarcodeZoneWidthToHeightRatioRangeArray</a></li>
437438
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/code128-subset.html" class="otherLinkColour">Code128Subset</a></li>
438439
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/data-matrix-module-isotropic.html" class="otherLinkColour">DataMatrixModuleIsotropic</a></li>
439440
<li><a href="{{ site.dcvb_parameters_reference }}barcode-format-specification/data-matrix-size-options.html" class="otherLinkColour">DataMatrixSizeOptions</a></li>

‎programming/cplusplus/api-reference/core/enum-error-code.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,8 @@ typedef enum ErrorCode
136136
EC_RECT_INVALID = -10080,
137137
/*The template version is incompatible. Please use a compatible template.*/
138138
EC_TEMPLATE_VERSION_INCOMPATIBLE = -10081,
139+
/**The portrait zone could not be located on the identity document.*/
140+
EC_PORTRAIT_ZONE_NOT_FOUND = -10082,
139141
/** -20000~-29999: DLS license error code. */
140142
/** No license. */
141143
EC_NO_LICENSE = -20000,

‎programming/cplusplus/api-reference/core/enum-region-object-element-type.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ typedef enum RegionObjectElementType
4040
/**The type of subclass SourceImageElement.*/
4141
ROET_SOURCE_IMAGE,
4242
/**The type of subclass TargetROIElement.*/
43-
ROET_TARGET_ROI
43+
ROET_TARGET_ROI,
44+
/**The type of subclass AuxiliaryRegionElement.*/
45+
ROET_AUXILIARY_REGION
4446
} RegionObjectElementType;
4547
```

‎programming/cplusplus/api-reference/core/intermediate-results/auxiliary-region-element.md‎

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: class CAuxiliaryRegionElement - Dynamsoft Core Module C++ Edition API Reference
4+
description: This page shows the C++ edition of the class CAuxiliaryRegionElement in Dynamsoft Core Module.
5+
keywords: auxiliary region element, c++
6+
---
7+
8+
# CAuxiliaryRegionElement
9+
10+
The `CAuxiliaryRegionElement` class represents an auxiliary region element that contains additional region information detected during processing (e.g., MRZ, portrait zones, signature areas). It inherits from the `CRegionObjectElement` class.
11+
12+
**Remarks**
13+
14+
Introduced in Dynamsoft Capture Vision version 3.4.1000.
15+
16+
## Definition
17+
18+
*Namespace:* dynamsoft::intermediate_results
19+
20+
*Assembly:* DynamsoftCore
21+
22+
*Inheritance:* [CRegionObjectElement]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html) -> CAuxiliaryRegionElement
23+
24+
```cpp
25+
class CAuxiliaryRegionElement : public CRegionObjectElement
26+
```
27+
28+
## Methods
29+
30+
| Method | Description |
31+
|----------------------|-------------|
32+
| [`GetName`](#getname) | Gets the name of this auxiliary region. |
33+
| [`GetConfidence`](#getconfidence) | Gets the confidence level of this auxiliary region detection. |
34+
| [`SetName`](#setname) | Sets the name of this auxiliary region. |
35+
| [`SetLocation`](#setlocation) | Sets the location of this auxiliary region. |
36+
| [`SetConfidence`](#setconfidence) | Sets the confidence level of this auxiliary region detection. |
37+
| **Methods Inherited from [CRegionObjectElement]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html):** | |
38+
| [`GetLocation`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getlocation) | Gets the location of the region object element. |
39+
| [`GetReferencedElement`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Gets a pointer to a referenced region object element. |
40+
| [`GetElementType`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getelementtype) | Gets the type of the region object element. |
41+
| [`GetImageData`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getimagedata) | Gets the imageData of the region object element. |
42+
| [`Clone`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#clone) | Clone the region object element. |
43+
| [`Retain`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#retain) | Increases the reference count of the `CRegionObjectElement` object. |
44+
| [`Release`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#release) | Decreases the reference count of the `CRegionObjectElement` object. |
45+
46+
### GetName
47+
48+
Gets the name of this auxiliary region.
49+
50+
```cpp
51+
virtual const char* GetName() const = 0;
52+
```
53+
54+
**Return value**
55+
56+
Returns a string representing the region name (e.g., "MRZ", "PortraitZone", "SignatureArea").
57+
58+
### GetConfidence
59+
60+
Gets the confidence level of this auxiliary region detection.
61+
62+
```cpp
63+
virtual int GetConfidence() const = 0;
64+
```
65+
66+
**Return value**
67+
68+
Returns the confidence value, typically in the range [0, 100].
69+
70+
### SetName
71+
72+
Sets the name of this auxiliary region.
73+
74+
```cpp
75+
virtual void SetName(const char* name) = 0;
76+
```
77+
78+
**Parameters**
79+
80+
`[in] name` The region name to set (e.g., "MRZ", "PortraitZone", "SignatureArea").
81+
82+
### SetLocation
83+
84+
Sets the location of this auxiliary region.
85+
86+
```cpp
87+
virtual int SetLocation(const CQuadrilateral& location) = 0;
88+
```
89+
90+
**Parameters**
91+
92+
`[in] location` A `CQuadrilateral` object defining the region boundaries.
93+
94+
**Return value**
95+
96+
Returns 0 if successful, otherwise returns an error code.
97+
98+
**See Also**
99+
100+
[CQuadrilateral]({{ site.dcvb_cpp_api }}core/basic-structures/quadrilateral.html)
101+
102+
### SetConfidence
103+
104+
Sets the confidence level of this auxiliary region detection.
105+
106+
```cpp
107+
virtual void SetConfidence(int confidence) = 0;
108+
```
109+
110+
**Parameters**
111+
112+
`[in] confidence` The confidence value to set, typically in the range [0, 100].

0 commit comments

Comments
 (0)