Merge pull request #63 from dynamsoft-docs/preview

update to internal commit 07c20332
dynamsoft-docs · Dec 5, 2024 · 3360d43 · 3360d43
2 parents b023924 + 8dc8657
commit 3360d43
Show file tree

Hide file tree

Showing 65 changed files with 3,750 additions and 32 deletions.
diff --git a/_data/full_tree.yml b/_data/full_tree.yml
@@ -4,6 +4,7 @@ tree_file_list:
   - sidelist-programming/programming-cpp-v2.4.2000.html
   - sidelist-programming/programming-dotnet.html
   - sidelist-programming/programming-python.html
+  - sidelist-programming/programming-python-v2.4.2100.html
   - sidelist-programming/sidelist-architecture.html
   - sidelist-programming/sidelist-code-types.html
   - sidelist-programming/sidelist-parameter-reference.html

diff --git a/_data/product_version.yml b/_data/product_version.yml
@@ -4,6 +4,7 @@ version_info_list_desktop:
   - value: latest version
   - value: 2.x
     child:
+      - 2.4.2100_python
       - 2.4.2000_python
       - 2.4.2000_cplusplus
 
diff --git a/_includes/sidelist-programming/programming-cpp.html b/_includes/sidelist-programming/programming-cpp.html
@@ -100,6 +100,8 @@
                         <li><a href="{{ site.dlr_cpp_api }}label-recognizer-module.html" class="otherLinkColour">CLabelRecognizerModule</a></li>
                         <li><a href="{{ site.dlr_cpp_api }}localized-text-line-element.html" class="otherLinkColour">CLocalizedTextLineElement</a></li>
                         <li><a href="{{ site.dlr_cpp_api }}localized-text-lines-unit.html" class="otherLinkColour">CLocalizedTextLinesUnit</a></li>
+                        <li><a href="{{ site.dlr_cpp_api }}raw-text-line.html" class="otherLinkColour">CRawTextLine</a></li>
+                        <li><a href="{{ site.dlr_cpp_api }}raw-text-lines-unit.html" class="otherLinkColour">CRawTextLinesUnit</a></li>
                         <li><a href="{{ site.dlr_cpp_api }}recognized-text-line-element.html" class="otherLinkColour">CRecognizedTextLineElement</a></li>
                         <li><a href="{{ site.dlr_cpp_api }}recognized-text-lines-result.html" class="otherLinkColour">CRecognizedTextLinesResult</a></li>
                         <li><a href="{{ site.dlr_cpp_api }}recognized-text-lines-unit.html" class="otherLinkColour">CRecognizedTextLinesUnit</a></li>
@@ -234,7 +236,7 @@
                         <li><a href="{{ site.dcvb_enumerations }}core/raster-data-source.html?lang=cpp"  class="otherLinkColour">RasterDataSource</a></li>
                         <li><a href="{{ site.dcvb_enumerations }}core/region-object-element-type.html?lang=cpp"  class="otherLinkColour">RegionObjectElementType</a></li>
                         <li><a href="{{ site.dcvb_enumerations }}core/section-type.html?lang=cpp"  class="otherLinkColour">SectionType</a></li>
-                        <li><a href="{{ site.dcvb_enumerations }}core/target-type.html?lang=cpp"  class="otherLinkColour">TargetType</a></li>
+                        <li><a href="{{ site.dcvb_enumerations }}core/transform-matrix-type.html?lang=cpp"  class="otherLinkColour">TransformMatrixType</a></li>
                         <li><a href="{{ site.dcvb_enumerations }}core/video-frame-quality.html?lang=cpp"  class="otherLinkColour">VideoFrameQuality</a></li>
                     </ul>
                 </li>

diff --git a/_includes/sidelist-programming/programming-python-v2.4.2100.html b/_includes/sidelist-programming/programming-python-v2.4.2100.html
diff --git a/_includes/sidelist-programming/programming-python.html b/_includes/sidelist-programming/programming-python.html
diff --git a/assets/js/dcvServerVersionSearch.json b/assets/js/dcvServerVersionSearch.json
@@ -5,6 +5,12 @@
             "cpp": "10.4.2000"
         }
     },
+    {
+        "version": "2.5.2100",
+        "matchVersion": {
+            "python": "10.5.2100"
+        }
+    },
     {
         "version": "2.4.2100",
         "matchVersion": {

diff --git a/programming/cplusplus/api-reference/index.md b/programming/cplusplus/api-reference/index.md
@@ -50,12 +50,14 @@ needAutoGenerateSidebar: false
 - [`CBarcodeDetails`]({{ site.dbr_cpp_api }}barcode-details.html)
 - [`CBarcodeReaderModule`]({{ site.dbr_cpp_api }}barcode-reader-module.html)
 - [`CBarcodeResultItem`]({{ site.dbr_cpp_api }}barcode-result-item.html)
+- [`CCandidateBarcodeZone`]({{ site.dbr_cpp_api }}candidate-barcode-zone.html)
 - [`CCandidateBarcodeZonesUnit`]({{ site.dbr_cpp_api }}candidate-barcode-zones-unit.html)
 - [`CComplementedBarcodeImageUnit`]({{ site.dbr_cpp_api }}complemented-barcode-image-unit.html)
 - [`CDataMatrixDetails`]({{ site.dbr_cpp_api }}datamatrix-details.html)
 - [`CDecodedBarcodeElement`]({{ site.dbr_cpp_api }}decoded-barcode-element.html)
 - [`CDecodedBarcodesResult`]({{ site.dbr_cpp_api }}decoded-barcodes-result.html)
 - [`CDecodedBarcodesUnit`]({{ site.dbr_cpp_api }}decoded-barcodes-unit.html)
+- [`CDeformationResistedBarcode`]({{ site.dbr_cpp_api }}deformation-resisted-barcode.html)
 - [`CDeformationResistedBarcodeImageUnit`]({{ site.dbr_cpp_api }}deformation-resisted-barcode-image-unit.html)
 - [`CExtendedBarcodeResult`]({{ site.dbr_cpp_api }}extended-barcode-result.html)
 - [`CLocalizedBarcodeElement`]({{ site.dbr_cpp_api }}localized-barcode-element.html)
@@ -85,6 +87,8 @@ needAutoGenerateSidebar: false
 - [`CLabelRecognizerModule`]({{ site.dlr_cpp_api }}label-recognizer-module.html)
 - [`CLocalizedTextLineElement`]({{ site.dlr_cpp_api }}localized-text-line-element.html)
 - [`CLocalizedTextLinesUnit`]({{ site.dlr_cpp_api }}localized-text-lines-unit.html)
+- [`CRawTextLine`]({{ site.dlr_cpp_api }}raw-text-line.html)
+- [`CRawTextLinesUnit`]({{ site.dlr_cpp_api }}raw-text-lines-unit.html)
 - [`CRecognizedTextLineElement`]({{ site.dlr_cpp_api }}recognized-text-line-element.html)
 - [`CRecognizedTextLinesResult`]({{ site.dlr_cpp_api }}recognized-text-lines-result.html)
 - [`CRecognizedTextLinesUnit`]({{ site.dlr_cpp_api }}recognized-text-lines-unit.html)
@@ -202,7 +206,7 @@ needAutoGenerateSidebar: false
 - [`RasterDataSource`]({{ site.dcvb_enumerations }}core/raster-data-source.html?lang=cpp)
 - [`RegionObjectElementType`]({{ site.dcvb_enumerations }}core/region-object-element-type.html?lang=cpp)
 - [`SectionType`]({{ site.dcvb_enumerations }}core/section-type.html?lang=cpp)
-- [`TargetType`]({{ site.dcvb_enumerations }}core/target-type.html?lang=cpp)
+- [`TransformMatrixType`]({{ site.dcvb_enumerations }}core/transform-matrix-type.html?lang=cpp)
 - [`VideoFrameQuality`]({{ site.dcvb_enumerations }}core/video-frame-quality.html?lang=cpp)
 
 ## DynamsoftUtility

diff --git a/...api-reference/capture-vision-router/auxiliary-classes/buffered-items-manager.md b/...api-reference/capture-vision-router/auxiliary-classes/buffered-items-manager.md
@@ -16,7 +16,7 @@ Defines a listener for image source state changes.
 *Module:* dynamsoft_capture_vision_router
 
 ```python
-class BufferedItemsManager(object)
+class BufferedItemsManager
 ```
 
 ## Methods

diff --git a/...ference/capture-vision-router/auxiliary-classes/capture-vision-router-module.md b/...ference/capture-vision-router/auxiliary-classes/capture-vision-router-module.md
@@ -13,10 +13,10 @@ The `CaptureVisionRouterModule` class defines general functions in the capture v
 
 ## Definition
 
-*Package:* dynamsoft_capture_vision_router
+*Module:* dynamsoft_capture_vision_router
 
 ```python
-class CaptureVisionRouterModule(object)
+class CaptureVisionRouterModule
 ```
 
 ## Methods

diff --git a/...api-reference/capture-vision-router/auxiliary-classes/captured-result-filter.md b/...api-reference/capture-vision-router/auxiliary-classes/captured-result-filter.md
@@ -18,7 +18,7 @@ The `CapturedResultFilter` class is responsible for filtering captured results.
 *Module:* dynamsoft_capture_vision_router
 
 ```python
-class CapturedResultFilter(object) 
+class CapturedResultFilter 
 ```
 
 ## Methods

diff --git a/...i-reference/capture-vision-router/auxiliary-classes/captured-result-receiver.md b/...i-reference/capture-vision-router/auxiliary-classes/captured-result-receiver.md
@@ -18,7 +18,7 @@ The `CapturedResultReceiver` class is responsible for receiving captured results
 *Module:* dynamsoft_capture_vision_router
 
 ```python
-class CapturedResultReceiver(object)
+class CapturedResultReceiver
 ```
 
 ## Methods

diff --git a/...python/api-reference/capture-vision-router/auxiliary-classes/captured-result.md b/...python/api-reference/capture-vision-router/auxiliary-classes/captured-result.md
@@ -15,7 +15,7 @@ The `CapturedResult` class represents the result of a capture operation on an im
 *Module:* dynamsoft_capture_vision_router
 
 ```python
-class CapturedResult(object) 
+class CapturedResult 
 ```
 
 ## Methods

diff --git a/...eference/capture-vision-router/auxiliary-classes/intermediate-result-manager.md b/...eference/capture-vision-router/auxiliary-classes/intermediate-result-manager.md
@@ -0,0 +1,87 @@
+---
+layout: default-layout
+title: class IntermediateResultManager - Dynamsoft Capture Vision Router Python Edition API Reference
+description: This page shows the Python Edition of the class IntermediateResultManager in Dynamsoft Capture Vision Router Module.
+keywords: intermediate result manager, python
+needAutoGenerateSidebar: true
+---
+
+# IntermediateResultManager
+
+The `IntermediateResultManager` class manages intermediate results generated during data capturing. It provides methods to add and remove intermediate result receivers, as well as to get original image data using an image hash id.
+
+## Definition
+
+*Module:* dynamsoft_capture_vision_router
+
+```python
+class IntermediateResultManager 
+```
+
+## Methods Summary
+
+| Method | Description |
+|--------|-------------|
+| [`add_result_receiver`](#add_result_receiver) | Adds an intermediate result receiver.|
+| [`remove_result_receiver`](#remove_result_receiver) | Removes an intermediate result receiver. |
+| [`get_original_image`](#get_original_image) | Gets the original image data using an image hash id. |
+
+### add_result_receiver
+
+Adds an intermediate result receiver to the manager.
+
+```python
+def add_result_receiver(self, receiver: IntermediateResultReceiver) -> int:
+```
+
+**Parameters**
+
+`receiver` The intermediate result receiver to add.
+
+**Return value**
+
+Returns 0 if succeeds, nonzero otherwise.
+
+**See Also**
+
+[IntermediateResultReceiver]({{ site.dcvb_python_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html)
+
+### remove_result_receiver
+
+Removes an intermediate result receiver from the manager.
+
+```python
+def remove_result_receiver(self, receiver: IntermediateResultReceiver) -> int:
+```
+
+**Parameters**
+
+`receiver` The intermediate result receiver to remove.
+
+**Return value**
+
+Returns 0 if succeeds, nonzero otherwise.
+
+**See Also**
+
+[IntermediateResultReceiver]({{ site.dcvb_python_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html)
+
+### get_original_image
+
+Gets the original image data using an image hash id.
+
+```python
+def get_original_image(self, image_hash_id: str)->ImageData:
+```
+
+**Parameters**
+
+`image_hash_id` The hash id of the image to retrieve.
+
+**Return value**
+
+Returns an `ImageData` object containing the original image data.
+
+**See Also**
+
+[ImageData]({{ site.dcvb_python_api }}core/basic-classes/image-data.html)