Merge pull request #71 from dynamsoft-docs/preview

update to internal commit 2649f719

Author: DMGithubPublisher

_data/full_tree.yml

@@ -5,6 +5,7 @@ tree_file_list:
   - sidelist-programming/programming-cpp.html
   - sidelist-programming/programming-dotnet.html
   - sidelist-programming/programming-python-v2.4.2100.html
+  - sidelist-programming/programming-python-v2.5.2100.html
   - sidelist-programming/programming-python.html
   - sidelist-programming/sidelist-architecture-v2.6.1000.html
   - sidelist-programming/sidelist-architecture.html

_includes/sidelist-programming/programming-cpp.html

@@ -134,11 +134,11 @@
                         <li><a href="{{ site.ddn_cpp_api }}detected-quads-unit.html" class="otherLinkColour">CDetectedQuadsUnit</a></li>
                         <li><a href="{{ site.ddn_cpp_api }}deskewed-image-element.html" class="otherLinkColour">CDeskewedImageElement</a></li>
                         <li><a href="{{ site.ddn_cpp_api }}deskewed-image-result-item.html" class="otherLinkColour">CDeskewedImageResultItem</a></li>
-                        <li><a href="{{ site.ddn_cpp_api }}deskewed-image-unit.html" class="otherLinkColour">CDeskewedImagesUnit</a></li>
+                        <li><a href="{{ site.ddn_cpp_api }}deskewed-image-unit.html" class="otherLinkColour">CDeskewedImageUnit</a></li>
                         <li><a href="{{ site.ddn_cpp_api }}document-normalizer-module.html" class="otherLinkColour">CDocumentNormalizerModule</a></li>
                         <li><a href="{{ site.ddn_cpp_api }}enhanced-image-element.html" class="otherLinkColour">CEnhancedImageElement</a></li>
                         <li><a href="{{ site.ddn_cpp_api }}enhanced-image-result-item.html" class="otherLinkColour">CEnhancedImageResultItem</a></li>
-                        <li><a href="{{ site.ddn_cpp_api }}enhanced-image-unit.html" class="otherLinkColour">CEnhancedImagesUnit</a></li>
+                        <li><a href="{{ site.ddn_cpp_api }}enhanced-image-unit.html" class="otherLinkColour">CEnhancedImageUnit</a></li>
                         <li><a href="{{ site.ddn_cpp_api }}long-lines-unit.html" class="otherLinkColour">CLongLinesUnit</a></li>
                         <li><a href="{{ site.ddn_cpp_api }}logic-lines-unit.html" class="otherLinkColour">CLogicLinesUnit</a></li>
                         <li><a href="{{ site.ddn_cpp_api }}processed-document-result.html" class="otherLinkColour">CProcessedDocumentResult</a></li>
@@ -161,6 +161,7 @@
                 {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath lang=include.lang targetRelativePath="sidelist-code-types.html" -%}
                 <li><a>Classes</a>
                     <ul>
+                        <li><a href="{{ site.dcp_cpp_api }}code-parser-module.html" class="otherLinkColour">CCodeParserModule</a></li>
                         <li><a href="{{ site.dcp_cpp_api }}parsed-result-item.html" class="otherLinkColour">CParsedResultItem</a></li>
                         <li><a href="{{ site.dcp_cpp_api }}parsed-result.html" class="otherLinkColour">CParsedResult</a></li>
                     </ul>

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

@@ -1,4 +1,10 @@
 [
+    {
+        "version": "3.0.2000",
+        "matchVersion": {
+            "python": "11.0.2000"
+        }
+    },
     {
         "version": "3.0.1000",
         "matchVersion": {

_includes/sidelist-programming/programming-python.html

@@ -112,10 +112,10 @@ needAutoGenerateSidebar: false
 - [`CDetectedQuadsUnit`]({{ site.ddn_cpp_api }}detected-quads-unit.html)
 - [`CDeskewedImageElement`]({{ site.ddn_cpp_api }}deskewed-image-element.html)
 - [`CDeskewedImageResultItem`]({{ site.ddn_cpp_api }}deskewed-image-result-item.html)
-- [`CDeskewedImagesUnit`]({{ site.ddn_cpp_api }}deskewed-image-unit.html)
+- [`CDeskewedImageUnit`]({{ site.ddn_cpp_api }}deskewed-image-unit.html)
 - [`CEnhancedImageElement`]({{ site.ddn_cpp_api }}enhanced-image-element.html)
 - [`CEnhancedImageResultItem`]({{ site.ddn_cpp_api }}enhanced-image-result-item.html)
-- [`CEnhancedImagesUnit`]({{ site.ddn_cpp_api }}enhanced-image-unit.html)
+- [`CEnhancedImageUnit`]({{ site.ddn_cpp_api }}enhanced-image-unit.html)
 - [`CDocumentNormalizerModule`]({{ site.ddn_cpp_api }}document-normalizer-module.html)
 - [`CLogicLinesUnit`]({{ site.ddn_cpp_api }}logic-lines-unit.html)
 - [`CLongLinesUnit`]({{ site.ddn_cpp_api }}long-lines-unit.html)
@@ -133,6 +133,7 @@ needAutoGenerateSidebar: false
 
 ### Classes
 
+- [`CCodeParserModule`]({{ site.dcp_cpp_api }}code-parser-module.html)
 - [`CParsedResultItem`]({{ site.dcp_cpp_api }}parsed-result-item.html)
 - [`CParsedResult`]({{ site.dcp_cpp_api }}parsed-result.html)
 

assets/js/dcvServerVersionSearch.json

@@ -0,0 +1,45 @@
+---
+layout: default-layout
+title: CaptureStateListener Class - Dynamsoft Capture Vision Module Python Edition API Reference
+description: Definition of CaptureStateListener class in Dynamsoft Capture Vision Module Python Edition.
+keywords: capture state listener, python
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+---
+
+# CaptureStateListener
+
+Defines a listener for capture state changes. 
+
+>Note: Subclasses inheriting from this class must ensure that the parent class constructor (`super().__init__()`) is properly called to guarantee correct initialization.
+
+## Definition
+
+*Module:* dynamsoft_capture_vision_router
+
+```python
+class CaptureStateListener(ABC)
+```
+
+## Methods
+
+| Method                                            | Description                            |
+| ------------------------------------------------- | -------------------------------------- |
+| [`on_capture_state_changed`](#on_capture_state_changed) | Called when the capture state changes. |
+
+### on_capture_state_changed
+
+Called when the capture state changes.
+
+```python
+@abstractmethod
+def on_capture_state_changed(self, state: int) -> None:
+```
+
+**Parameters**
+
+`state` The new capture state. It is one of the values of the `EnumCaptureState` enumeration.
+
+**See Also**
+
+[EnumCaptureState]({{ site.dcvb_enumerations }}capture-vision-router/capture-state.html?lang=python)

programming/cplusplus/api-reference/index.md

@@ -42,4 +42,4 @@ def on_capture_state_changed(self, state: int) -> None:
 
 **See Also**
 
-[EnumCaptureState]({{ site.dcvb_enumerations }}capture-vision-router/capture-state.html?lang=python)
+[EnumCaptureState]({{ site.dcvb_python_api }}capture-vision-router/enum-capture-state.html)

programming/python/api-reference/capture-vision-router/auxiliary-classes/capture-state-listener-v2.5.2100.md

@@ -0,0 +1,42 @@
+---
+layout: default-layout
+title: CapturedResultArray Class - Dynamsoft Capture Vision Module Python Edition API Reference
+description: Definition of CapturedResultArray class in Dynamsoft Capture Vision Module Python Edition.
+keywords: captured result, python
+needAutoGenerateSidebar: true
+---
+
+# CapturedResultArray
+
+The `CapturedResultArray` class represents a collection of `CaptureResult`, each derived from a capture operation on an image. Internally, `CaptureResult` maintains an array of items, which may include barcodes, text lines, detected quads, normalized images, raw images, parsed items, and more.
+
+## Definition
+
+*Module:* dynamsoft_capture_vision_router
+
+```python
+class CapturedResultArray
+```
+
+## Methods
+
+| Method               | Description |
+|----------------------|-------------|
+| [`get_results`](#get_results) | Gets all `CapturedResult` objects from current result collection. |
+
+### get_results
+
+Gets all `CapturedResult` objects from current result collection.
+
+```python
+def get_results(self) -> List[CapturedResult]:
+```
+
+**Return value**
+
+Returns a `CapturedResult` list.
+
+**See Also**
+
+[CapturedResult]({{ site.dcvb_python_api }}capture-vision-router/auxiliary-classes/captured-result.html)
+

programming/python/api-reference/capture-vision-router/auxiliary-classes/capture-state-listener.md

@@ -0,0 +1,172 @@
+---
+layout: default-layout
+title: CapturedResultReceiver Class - Dynamsoft Capture Vision Module Python Edition API Reference
+description: Definition of CapturedResultReceiver class in Dynamsoft Capture Vision Module Python Edition.
+keywords: captured result receiver, python
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+---
+
+# CapturedResultReceiver
+
+The `CapturedResultReceiver` class is responsible for receiving captured results. It contains several callback functions for different types of results, including original image, decoded barcodes, recognized text lines, detected quads, normalized images, and parsed results.
+
+>Note: Subclasses inheriting from this class must ensure that the parent class constructor (`super().__init__()`) is properly called to guarantee correct initialization.
+
+## Definition
+
+*Module:* dynamsoft_capture_vision_router
+
+```python
+class CapturedResultReceiver
+```
+
+## Methods
+
+| Method                                                            | Description                                          |
+| ----------------------------------------------------------------- | ---------------------------------------------------- |
+| [`on_captured_result_received`](#on_captured_result_received)           | Callback function triggered after processing each image and returns all captured results.          |
+| [`on_original_image_result_received`](#on_original_image_result_received) | Callback function triggered when start processing each image and returns the original image result.        |
+| [`on_decoded_barcodes_received`](#on_decoded_barcodes_received)         | Callback function triggered after processing each image and returns all decoded barcodes results.      |
+| [`on_recognized_text_lines_received`](#on_recognized_text_lines_received) | Callback function triggered after processing each image and returns all recognized text lines results. |
+| [`on_detected_quads_received`](#on_detected_quads_received)             | Callback function triggered after processing each image and returns all detected quads results.        |
+| [`on_normalized_images_received`](#on_normalized_images_received)       | Callback function triggered after processing each image and returns all normalized images results.     |
+| [`on_parsed_results_received`](#on_parsed_results_received)             | Callback function triggered after processing each image and returns all parsed results.                |
+| [`get_name`](#get_name)       | Gets the name of the captured result receiver.                                             |
+| [`set_name`](#set_name)       | Sets the name of the captured result receiver.                                             |
+
+### on_captured_result_received
+
+Callback function triggered after processing each image and returns all captured results.
+
+```python
+def on_captured_result_received(self, result: CapturedResult) -> None:
+```
+
+**Parameters**
+
+`result` The captured result.
+
+**See Also**
+
+[CapturedResult]({{ site.dcvb_python_api }}capture-vision-router/auxiliary-classes/captured-result.html)
+
+### on_original_image_result_received
+
+Callback function triggered when start processing each image and returns the original image result. For the callback to be triggered, it is essential that the parameter `OutputOriginalImage` is set to value `1`.
+
+```python
+def on_original_image_result_received(self, result: OriginalImageResultItem) -> None:
+```
+
+**Parameters**
+
+`result` The original image result.
+
+**See Also**
+
+[OriginalImageResultItem]({{ site.dcvb_python_api }}core/basic-classes/original-image-result-item.html)
+
+### on_decoded_barcodes_received
+
+Callback function triggered after processing each image and returns all decoded barcodes. For the callback to be triggered, it is essential that the `BarcodeReaderTask` is properly configured.
+
+```python
+def on_decoded_barcodes_received(self, result: "DecodedBarcodesResult") -> None:
+```
+
+**Parameters**
+
+`result` The decoded barcodes result.
+
+**See Also**
+
+[DecodedBarcodesResult]({{ site.dbr_python_api }}decoded-barcodes-result.html)
+
+### on_recognized_text_lines_received
+
+Callback function triggered after processing each image and returns all recognized text lines. For the callback to be triggered, it is essential that the `LabelRecognizerTask` is properly configured.
+
+```python
+def on_recognized_text_lines_received(self, result: "RecognizedTextLinesResult") -> None:
+```
+
+**Parameters**
+
+`result` The recognized text lines result.
+
+**See Also**
+
+[RecognizedTextLinesResult]({{ site.dlr_python_api }}recognized-text-lines-result.html)
+
+### on_detected_quads_received
+
+Callback function triggered after processing each image and returns all detected quads. For the callback to be triggered, it is essential that the `DocumentNormalizerTask` is properly configured.
+
+```python
+def on_detected_quads_received(self, result: "DetectedQuadsResult") -> None:
+```
+
+**Parameters**
+
+`result` The detected quads result.
+
+**See Also**
+
+[DetectedQuadsResult]({{ site.ddn_python_api }}detected-quads-result.html)
+
+### on_normalized_images_received
+
+Callback function triggered after processing each image and returns all normalized images. For the callback to be triggered, it is essential that the `DocumentNormalizerTask` is properly configured.
+
+```python
+def on_normalized_images_received(self, result: "NormalizedImagesResult") -> None:
+```
+
+**Parameters**
+
+`result` The normalized images result.
+
+**See Also**
+
+[NormalizedImagesResult]({{ site.ddn_python_api }}normalized-images-result.html)
+
+### on_parsed_results_received
+
+Callback function triggered after processing each image and returns all parsed results. For the callback to be triggered, it is essential that the `CodeParserTask` is properly configured.
+
+```python
+def on_parsed_results_received(self, result: "ParsedResult") -> None:
+```
+
+**Parameters**
+
+`result` The parsed result.
+
+**See Also**
+
+[ParsedResult]({{ site.dcp_python_api }}parsed-result.html)
+
+### get_name
+
+Gets the name of the captured result receiver.  
+
+```python
+def get_name(self) -> str:
+```
+
+**Return Value**
+
+Returns the name of the captured result receiver.  
+
+### set_name
+
+Sets the name of the captured result receiver.  
+
+```python
+def set_name(self, name: str) -> None:
+```
+
+**Parameters**
+
+`name` The name of the captured result receiver.