Skip to content

Commit 06da035

Browse files
Dynamsoft-HenryDynamsoft-Henry
authored
Merge pull request #214 from dynamsoft-docs/preview
update to internal commit abc45b69
2 parents c0d1c47 + b566a17 commit 06da035

File tree

12 files changed

+292
-17
lines changed

12 files changed

+292
-17
lines changed

‎_config.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,12 @@ dce_maui_api: /camera-enhancer/docs/mobile/programming/maui/api-reference/
102102
dcp_maui: /code-parser/docs/mobile/programming/maui/
103103
dcp_maui_api: /code-parser/docs/mobile/programming/maui/api-reference/
104104

105+
dcv_cpp: /capture-vision/docs/server/programming/cplusplus/
106+
dcv_python: /capture-vision/docs/server/programming/python/
107+
dcv_java: /capture-vision/docs/server/programming/java/
108+
dcv_dotnet: /capture-vision/docs/server/programming/dotnet/
109+
dcv_js: /capture-vision/docs/web/programming/javascript/
110+
105111
code_types: /code-parser/docs/core/code-types/
106112

107113
assets: /capture-vision/docs/mobile/assets/

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -895,3 +895,19 @@
895895
<li lang="android"><a href="{{ site.dcv_android_v2 }}release-notes/android-2.html" class="otherLinkColour">v2.x</a></li>
896896
</ul>
897897
</li>
898+
899+
<li lang="android" class="category">OTHER EDITIONS</li>
900+
<li lang="android"><a class="otherLinkColour">Choose a Language</a>
901+
<ul>
902+
<li><a target="_blank" href="{{ site.dcv_ios }}" class="otherLinkColour refreshLink">iOS (Objective-C & Swift)</a></li>
903+
<li><a target="_blank" href="{{ site.dcv_maui }}" class="otherLinkColour refreshLink">MAUI</a></li>
904+
<li><a target="_blank" href="https://github.com/Dynamsoft/barcode-reader-react-native-samples" class="otherLinkColour refreshLink">React Native</a></li>
905+
<li><a target="_blank" href="{{ site.dcv_flutter }}" class="otherLinkColour refreshLink">Flutter</a></li>
906+
<li><a target="_blank" href="{{ site.dcv_cpp }}" class="otherLinkColour refreshLink">C++</a></li>
907+
<li><a target="_blank" href="{{ site.dcv_python }}" class="otherLinkColour refreshLink">Python</a></li>
908+
<li><a target="_blank" href="{{ site.dcv_java }}" class="otherLinkColour refreshLink">Java</a></li>
909+
<li><a target="_blank" href="{{ site.dcv_dotnet }}" class="otherLinkColour refreshLink">.NET</a></li>
910+
<li><a target="_blank" href="{{ site.dcv_js }}" class="otherLinkColour refreshLink">JS</a></li>
911+
</ul>
912+
</li>
913+

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -900,3 +900,18 @@
900900
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_v2 }}release-notes/ios-2.html" class="otherLinkColour">v2.x</a></li>
901901
</ul>
902902
</li>
903+
904+
<li lang="objectivec-swift" class="category">OTHER EDITIONS</li>
905+
<li lang="objectivec-swift"><a class="otherLinkColour">Choose a Language</a>
906+
<ul>
907+
<li><a target="_blank" href="{{ site.dcv_android }}" class="otherLinkColour refreshLink">Android (Java & Kotlin)</a></li>
908+
<li><a target="_blank" href="{{ site.dcv_maui }}" class="otherLinkColour refreshLink">MAUI</a></li>
909+
<li><a target="_blank" href="https://github.com/Dynamsoft/barcode-reader-react-native-samples" class="otherLinkColour refreshLink">React Native</a></li>
910+
<li><a target="_blank" href="{{ site.dcv_flutter }}" class="otherLinkColour refreshLink">Flutter</a></li>
911+
<li><a target="_blank" href="{{ site.dcv_cpp }}" class="otherLinkColour refreshLink">C++</a></li>
912+
<li><a target="_blank" href="{{ site.dcv_python }}" class="otherLinkColour refreshLink">Python</a></li>
913+
<li><a target="_blank" href="{{ site.dcv_java }}" class="otherLinkColour refreshLink">Java</a></li>
914+
<li><a target="_blank" href="{{ site.dcv_dotnet }}" class="otherLinkColour refreshLink">.NET</a></li>
915+
<li><a target="_blank" href="{{ site.dcv_js }}" class="otherLinkColour refreshLink">JS</a></li>
916+
</ul>
917+
</li>

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

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,23 @@
4242
<ul lang="maui">
4343
<li lang="maui"><a class="otherLinkColour">Classes</a>
4444
<ul lang="maui">
45+
<li lang="maui"><a href="{{ site.dbr_maui_api }}aztec-details.html" class="otherLinkColour">AztecDetails</a></li>
4546
<li lang="maui"><a href="{{ site.dbr_maui_api }}barcode-reader-module.html" class="otherLinkColour">BarcodeReaderModule</a></li>
4647
<li lang="maui"><a href="{{ site.dbr_maui_api }}barcode-result-item.html" class="otherLinkColour">BarcodeResultItem</a></li>
48+
<li lang="maui"><a href="{{ site.dbr_maui_api }}datamatrix-details.html" class="otherLinkColour">DataMatrixDetails</a></li>
4749
<li lang="maui"><a href="{{ site.dbr_maui_api }}decoded-barcodes-result.html" class="otherLinkColour">DecodedBarcodesResult</a></li>
50+
<li lang="maui"><a href="{{ site.dbr_maui_api }}oned-details.html" class="otherLinkColour">OneDCodeDetails</a></li>
51+
<li lang="maui"><a href="{{ site.dbr_maui_api }}pdf417-details.html" class="otherLinkColour">PDF417Details</a></li>
52+
<li lang="maui"><a href="{{ site.dbr_maui_api }}qr-code-details.html" class="otherLinkColour">QRCodeDetails</a></li>
4853
<li lang="maui"><a href="{{ site.dbr_maui_api }}simplified-barcode-reader-settings.html" class="otherLinkColour">SimplifiedBarcodeReaderSettings</a></li>
4954
</ul>
5055
</li>
5156
<li lang="maui"><a>Enumerations</a>
5257
<ul lang="maui">
53-
<li lang="maui"><a href="{{ site.dcv_maui_api }}enum/barcode-format.html" class="otherLinkColour">EnumBarcodeFormat</a></li>
54-
<li lang="maui"><a href="{{ site.dcv_maui_api }}enum/deblur-mode.html" class="otherLinkColour">EnumDeblurMode</a></li>
55-
<li lang="maui"><a href="{{ site.dcv_maui_api }}enum/localization-mode.html" class="otherLinkColour">EnumLocalizationMode</a></li>
58+
<li lang="maui"><a href="{{ site.dbr_maui_api }}enum/barcode-format.html" class="otherLinkColour">EnumBarcodeFormat</a></li>
59+
<li lang="maui"><a href="{{ site.dbr_maui_api }}enum/deblur-mode.html" class="otherLinkColour">EnumDeblurMode</a></li>
60+
<li lang="maui"><a href="{{ site.dbr_maui_api }}enum/localization-mode.html" class="otherLinkColour">EnumLocalizationMode</a></li>
61+
<li lang="maui"><a href="{{ site.dbr_maui_api }}enum/qr-code-error-correction-level.html" class="otherLinkColour">EnumQRCodeErrorCorrectionLevel</a></li>
5662
</ul>
5763
</li>
5864
</ul>
@@ -96,6 +102,7 @@
96102
<li lang="maui"><a href="{{ site.dce_maui_api }}camera-enhancer-module.html" class="otherLinkColour">CameraEnhancerModule</a></li>
97103
<li lang="maui"><a href="{{ site.dce_maui_api }}camera-enhancer.html" class="otherLinkColour">CameraEnhancer</a></li>
98104
<li lang="maui"><a href="{{ site.dce_maui_api }}camera-view.html" class="otherLinkColour">CameraView</a></li>
105+
<li lang="maui"><a href="{{ site.dce_maui_api }}camera-toggle-button.html" class="otherLinkColour">CameraToggleButton</a></li>
99106
<li lang="maui"><a href="{{ site.dce_maui_api }}drawing-item.html" class="otherLinkColour">DrawingItem</a></li>
100107
<li lang="maui"><a href="{{ site.dce_maui_api }}drawing-layer.html" class="otherLinkColour">DrawingLayer</a></li>
101108
<li lang="maui"><a href="{{ site.dce_maui_api }}feedback.html" class="otherLinkColour">Feedback</a></li>
@@ -756,3 +763,19 @@
756763
</li>
757764
<li lang="maui"><a href="{{ site.dbr_maui }}migrate-from-xamarin-to-maui.html" class="otherLinkColour">DBR - Migrate from Xamarin to MAUI</a></li>
758765
<li lang="maui"><a href="{{ site.dcv_maui }}migrate-from-xamarin-to-maui.html" class="otherLinkColour">DDN - Migrate from Xamarin to MAUI</a></li>
766+
767+
<li lang="maui" class="category">OTHER EDITIONS</li>
768+
<li lang="maui"><a class="otherLinkColour">Choose a Language</a>
769+
<ul>
770+
<li><a target="_blank" href="{{ site.dcv_android }}" class="otherLinkColour refreshLink">Android (Java & Kotlin)</a></li>
771+
<li><a target="_blank" href="{{ site.dcv_ios }}" class="otherLinkColour refreshLink">iOS (Objective-C & Swift)</a></li>
772+
<li><a target="_blank" href="https://github.com/Dynamsoft/barcode-reader-react-native-samples" class="otherLinkColour refreshLink">React Native</a></li>
773+
<li><a target="_blank" href="{{ site.dcv_flutter }}" class="otherLinkColour refreshLink">Flutter</a></li>
774+
<li><a target="_blank" href="{{ site.dcv_cpp }}" class="otherLinkColour refreshLink">C++</a></li>
775+
<li><a target="_blank" href="{{ site.dcv_python }}" class="otherLinkColour refreshLink">Python</a></li>
776+
<li><a target="_blank" href="{{ site.dcv_java }}" class="otherLinkColour refreshLink">Java</a></li>
777+
<li><a target="_blank" href="{{ site.dcv_dotnet }}" class="otherLinkColour refreshLink">.NET</a></li>
778+
<li><a target="_blank" href="{{ site.dcv_js }}" class="otherLinkColour refreshLink">JS</a></li>
779+
</ul>
780+
</li>
781+

‎programming/maui/api-reference/capture-vision-router/multiple-file-processing.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ noTitleIndex: true
2020
| [`StopCapturing`](#stopcapturing) | Stops the capturing process. |
2121
| [`AddResultFilter`](#addresultfilter) | Adds a `CaptureResultFilter` object to filter non-essential results. |
2222
| [`RemoveResultFilter`](#removeresultfilter) | Removes the specified `CaptureResultFilter` object. |
23+
| [`SwitchCapturingTemplate`](#switchcapturingtemplate) | Switch the image processing settings with the CaptureVisionTemplate name during the image processing workflow. |
2324

2425
## SetInput
2526

@@ -127,3 +128,25 @@ void RemoveResultFilter(ICapturedResultFilter filter);
127128
**Parameters**
128129

129130
`[in] filter`: The filter object, of type [`CapturedResultFilter`]({{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/captured-result-filter.html).
131+
132+
## SwitchCapturingTemplate
133+
134+
Switch the image processing settings with the CaptureVisionTemplate name during the image processing workflow.
135+
136+
```csharp
137+
partial void SwitchCapturingTemplate(string template);
138+
```
139+
140+
**Parameters**
141+
142+
`[in] template`: The name of the new capturing template to apply.
143+
144+
**Exception**
145+
146+
| Error Code | Value | Description |
147+
| :--------- | :---- | :---------- |
148+
| EC_TEMPLATE_NAME_INVALID | -10036 | The target template name is invalid. |
149+
150+
**Remarks**
151+
152+
- Introduced in Dynamsoft Barcode Reader SDK version 11.2.3000 and Dynamsoft Capture Vision version 3.2.3000.

‎programming/maui/api-reference/capture-vision-router/settings.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ noTitleIndex: true
2020
| [`ResetSettings`](#resetsettings) | Restores all settings to their original default values. |
2121
| [`OutputSettings`](#outputsettings) | Returns an object that contains settings for the specified `CaptureVisionTemplate`. |
2222
| [`OutputSettingsToFile`](#outputsettingstofile) | Generates a JSON file download containing the settings for the specified `CaptureVisionTemplate`. |
23+
| [`ClearDLModelBuffers`](#cleardlmodelbuffers) | Clear the buffered deep learning models to release the memory. |
24+
| [`SetGlobalIntraOpNumThreads`](#setglobalintraopnumthreads) | Sets the global number of threads used internally for model execution. |
2325

2426
## InitSettings
2527

@@ -203,3 +205,31 @@ void OutputSettingsToFile(string templateName, string filePath);
203205
| :--------- | :---- | :---------- |
204206
| EC_FILE_SAVE_FAILED | -10058 | The file path is unavailable or the file can't be created for any other reasons. |
205207
| EC_CALL_REJECTED_WHEN_CAPTURING | -10062 | Function call is rejected when capturing in progress. |
208+
209+
## ClearDLModelBuffers
210+
211+
Clear the buffered deep learning models to release the memory.
212+
213+
```csharp
214+
static partial void ClearDLModelBuffers();
215+
```
216+
217+
**Remarks**
218+
219+
- Introduced in Dynamsoft Barcode Reader SDK version 11.2.3000 and Dynamsoft Capture Vision version 3.2.3000.
220+
221+
## SetGlobalIntraOpNumThreads
222+
223+
Sets the global number of threads used internally for model execution.
224+
225+
```csharp
226+
static partial void SetGlobalIntraOpNumThreads(int numThreads);
227+
```
228+
229+
**Parameters**
230+
231+
`numThreads`: Number of threads used internally for model execution. Valid range: [0, 256]. Default: 2.
232+
233+
**Remarks**
234+
235+
- Introduced in Dynamsoft Barcode Reader SDK version 11.2.3000 and Dynamsoft Capture Vision version 3.2.3000.

‎programming/maui/api-reference/utility/enum/filter-type.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ codeAutoHeight: true
1010

1111
`EnumFilterType` describes the specified image filter applied to an input image.
1212

13-
```java
13+
```csharp
1414
public enum EnumFilterType : int
1515
{
1616
HighPass,

‎programming/maui/api-reference/utility/enum/image-file-format.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: default-layout
3+
title: EnumImageFileFormat - Dynamsoft Utility MAUI Enumerations
4+
description: The enumeration EnumImageFileFormat of Dynamsoft Utility MAUI edition defines the file format of the image file.
5+
keywords: image filter
6+
codeAutoHeight: true
7+
---
8+
9+
# EnumImageFileFormat
10+
11+
`EnumImageFileFormat` defines the file format of the image file.
12+
13+
```csharp
14+
public enum EnumImageFileFormat
15+
{
16+
IFF_JPEG = 0,
17+
IFF_PNG = 1,
18+
IFF_BMP = 2,
19+
IFF_PDF = 3
20+
}
21+
```

‎programming/maui/api-reference/utility/image-io.md‎

Lines changed: 60 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,52 @@ class DMImageIO
2626

2727
| Method | Description |
2828
| ------ | ----------- |
29+
| [`ReadFromFile`](#readfromfile) | Reads an image from the specified path and format. |
30+
| [`ReadFromMemory`](#readfrommemory) | Reads an image from the memory. |
2931
| [`SaveToFile`](#savetofile) | Saves an image to the specified path and format. |
30-
| [`ReadFromFile`](#readfromfile) | Read an image from file with the file path. |
32+
| [`SaveToMemory`](#savetomemory) | Saves an image to the memory. |
3133

32-
### saveToFile
34+
### ReadFromFile
35+
36+
Read an image from file with the file path
37+
38+
```csharp
39+
ImageData? ReadFromFile(string path);
40+
```
41+
42+
**Parameters**
43+
44+
`[in] path`: The file path.
45+
46+
**Return Value**
47+
48+
The read image data of type `ImageData`.
49+
50+
### ReadFromMemory
51+
52+
Reads an image from the memory.
53+
54+
```csharp
55+
partial ImageData? ReadFromMemory(byte[] imageFileBytes);
56+
```
57+
58+
**Parameters**
59+
60+
`[in] imageFileBytes`: The image bytes.
61+
62+
**Return Value**
63+
64+
The image data of type `ImageData`.
65+
66+
**Exception**
67+
68+
| Error Code | Value | Description |
69+
| :--------- | :---- | :---------- |
70+
| EC_NULL_POINTER | -10002 | The fileBytes you input is null. |
71+
72+
- Introduced in Dynamsoft Barcode Reader SDK version 11.2.3000 and Dynamsoft Capture Vision version 3.2.3000.
73+
74+
### SaveToFile
3375

3476
Saves an image to the specified path and format. The desired file format is inferred from the file extension provided in the `path` parameter.
3577

@@ -59,18 +101,29 @@ void SaveToFile(ImageData imageData, string path, bool overWrite);
59101

60102
A boolean value that indicates whether the file is saved successfully.
61103

62-
### ReadFromFile
104+
### SaveToMemory
63105

64-
Read an image from file with the file path
106+
Saves an image to the memory.
65107

66108
```csharp
67-
ImageData? ReadFromFile(string path);
109+
partial byte[]? SaveToMemory(ImageData imageData, EnumImageFileFormat imageFileFormat);
68110
```
69111

70112
**Parameters**
71113

72-
`[in] path`: The file path.
114+
`[in] imageData`: The image to be saved, of type `ImageData`.
115+
116+
`[in] imageFileFormat`: The image format.
73117

74118
**Return Value**
75119

76-
The read image data of type `ImageData`.
120+
The image bytes.
121+
122+
**Exception**
123+
124+
| Error Code | Value | Description |
125+
| :--------- | :---- | :---------- |
126+
| EC_NULL_POINTER | -10002 | The ImageData object is null. |
127+
| EC_IMGAE_DATA_INVALID | -10069 | The input ImageData object contains invalid parameter(s). |
128+
129+
- Introduced in Dynamsoft Barcode Reader SDK version 11.2.3000 and Dynamsoft Capture Vision version 3.2.3000.

‎programming/maui/api-reference/utility/image-processor.md‎

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ class ImageProcessor
2727
| Method | Description |
2828
| ------ | ----------- |
2929
| [`CropImage`](#cropimagerect) | Crops an image based on the provided rectangle or quadrilateral. |
30-
| [`CropImage`](#cropimagequadrilateral) | Crops an image based on the provided rectangle or quadrilateral. |
30+
| [`CropAndDeskewImage(imageData,quadrilateral,dstWidth,dstHeight,padding)`](#cropanddeskewimageimagedataquadrilateraldstwidthdstheightpaddingerrorcode) | Crops and deskew an image based on the provided quadrilateral and additional information. |
31+
| [`CropAndDeskewImage(imageData,quadrilateral)`](#cropanddeskewimageimagedataquadrilateral) | Crops and deskew an image based on the provided quadrilateral. |
3132
| [`AdjustBrightness`](#adjustbrightness) | Adjusts the brightness of an image. |
3233
| [`AdjustContrast`](#adjustcontrast) | Adjusts the contrast of an image. |
3334
| [`FilterImage`](#filterimage) | Applies a filter to an image. |
@@ -56,12 +57,12 @@ ImageData? CropImage(ImageData imageData, DMRect rect);
5657

5758
The cropped `ImageData`.
5859

59-
### CropImage(quadrilateral)
60+
### CropAndDeskewImage(imageData,quadrilateral,dstWidth,dstHeight,padding,errorCode)
6061

61-
Crops an image based on the provided quadrilateral.
62+
Crops and deskews an image based on the provided quadrilateral and additional information.
6263

6364
```csharp
64-
ImageData? CropImage(ImageData imageData, Quadrilateral quadrilateral);
65+
partial ImageData? CropAndDeskewImage(ImageData imageData, Quadrilateral quadrilateral, int dstWidth, int dstHeight, int padding);
6566
```
6667

6768
**Parameters**
@@ -70,9 +71,25 @@ ImageData? CropImage(ImageData imageData, Quadrilateral quadrilateral);
7071

7172
`[in] quadrilateral`: The `Quadrilateral` specifying the region to crop.
7273

73-
**Return Value**
74+
`[in] dstWidth`: The width of the destination image.
7475

75-
The cropped `ImageData`.
76+
`[in] dstHeight`: The height of the destination image.
77+
78+
`[in] padding`: The padding value to be added to the destination image.
79+
80+
### CropAndDeskewImage(imageData,quadrilateral)
81+
82+
Crops and deskews an image based on the provided quadrilateral. The arguments dstWidth, dstHeight, and padding are set to 0.
83+
84+
```csharp
85+
partial ImageData? CropAndDeskewImage(ImageData imageData, Quadrilateral quadrilateral);
86+
```
87+
88+
**Parameters**
89+
90+
`[in] imageData`: The `ImageData` to crop.
91+
92+
`[in] quadrilateral`: The `Quadrilateral` specifying the region to crop.
7693

7794
### AdjustBrightness
7895

0 commit comments

Comments
 (0)