Skip to content

Commit 359fa76

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #109 from dynamsoft-docs/preview
update to internal commit 2631a6c3
2 parents 60767a4 + fd6e292 commit 359fa76

File tree

7 files changed

+309
-59
lines changed

7 files changed

+309
-59
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@
138138
<li><a href="{{ site.dbr_dotnet_release_notes }}dotnet-7.html" class="otherLinkColour">Version 7.6.0 and below</a></li>
139139
</ul>
140140
</li>
141+
<li lang="dotnet"><a href="{{ site.dbr_dotnet }}upgrade-instruction.html" class="otherLinkColour">Upgrade Instructions</a></li>
141142
<li lang="dotnet"><a href="{{ site.license_activation }}index.html" class="otherLinkColour">License Initialization</a></li>
142143
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath lang=include.lang targetRelativePath="sidelist-faq.html" -%}
143144

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@
132132
<li><a href="{{ site.dbr_python_release_notes }}python-7.html" class="otherLinkColour">Version 7.6.0 and below</a></li>
133133
</ul>
134134
</li>
135+
<li lang="python"><a href="{{ site.dbr_python }}upgrade-instruction.html" class="otherLinkColour">Upgrade Instructions</a></li>
135136
<li lang="python"><a href="{{ site.license_activation }}index.html" class="otherLinkColour">License Initialization</a></li>
136137
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath lang=include.lang targetRelativePath="sidelist-faq.html" -%}
137138

‎_layouts/home-page.html‎

Lines changed: 0 additions & 50 deletions
This file was deleted.

‎index.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
---
22
layout: home-page
3-
title: Dynamsoft Barcode Reader SDK Documentation
3+
title: Dynamsoft Barcode Reader Server SDK Documentation
44
keywords: dynamsoft barcode reader, dbr, documentation
55
breadcrumbText: HomePage
6-
description: Dynamsoft Barcode Reader SDK Documentation Homepage
6+
description: Dynamsoft Barcode Reader Server SDK Documentation Homepage
77
---
88

9-
# Dynamsoft Barcode Reader Documentation
9+
# Dynamsoft Barcode Reader Server Documentation
1010

1111
Learn how to use Dynamsoft Barcode Reader SDK in different programming languages:
1212

13-
- [Python]({{ site.dbr_python }})
14-
- [C]({{ site.dbr_c }})
15-
- [C++]({{ site.dbr_cpp }})
16-
- [.NET]({{ site.dbr_dotnet }})
17-
- [Java]({{ site.dbr_java }})
13+
<div class="archivedEditionList"></div>
14+
15+
- ![Python Icon]({{site.assets}}img-icon/homepage/Python.svg){:class="python"} [Python]({{ site.dbr_python }})
16+
- ![Java Icon]({{site.assets}}img-icon/homepage/java.svg){:class="java"} [Java]({{ site.dbr_java }})
17+
- ![.NET Icon]({{site.assets}}img-icon/homepage/dotnet.svg){:class="dotnet"} [.NET]({{ site.dbr_dotnet }})
18+
- ![C Icon]({{site.assets}}img-icon/homepage/c.svg){:class="c"} [C]({{ site.dbr_c }})
19+
- ![C++ Icon]({{site.assets}}img-icon/homepage/cplusplus.svg){:class="cplusplus"} [C++]({{ site.dbr_cpp }})

‎programming/cplusplus/upgrade-instruction.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Dynamsoft Barcode Reader SDK has been refactored to integrate with [`DynamsoftCa
1515

1616
### Update the Included Headers, libs & DLLs
1717

18-
Since the SDK architecture is changed, you have to change you code for including the headers, libs and DLLs. You can use the following code to replace your previous code.
18+
Since the SDK architecture is changed, you have to change your code for including the headers, libs and DLLs. You can use the following code to replace your previous code.
1919

2020
```cpp
2121
#include "[INSTALLATION FOLDER]/Include/DynamsoftCaptureVisionRouter.h"

‎programming/dotnet/upgrade-instruction.md‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,155 @@ needGenerateH3Content: true
1212

1313
Dynamsoft Barcode Reader SDK has been refactored to integrate with [`DynamsoftCaptureVision (DCV)`]({{ site.dcvb_architecture }}) architecture. To upgrade from version 9.x or earlier to 10.x, we recommend you to follow the [User Guide]({{ site.dbr_dotnet}}user-guide.html) and re-write your codes.
1414

15+
16+
### Migrate to New Package
17+
18+
As of version 10.0, the nuget package `Dynamsoft.DotNet.Barcode` has been renamed to `Dynamsoft.DotNet.BarcodeReader.Bundle` to reflect changes in both architecture and API design. Start command prompt and run the following command to install the new package.
19+
20+
```
21+
NuGet\Install-Package Dynamsoft.DotNet.BarcodeReader.Bundle
22+
```
23+
24+
### Update the License Activation Code
25+
26+
Starting from 10.0, we have unified the API for setting licenses across different Dynamsoft products.
27+
28+
| Old APIs | New APIs |
29+
| :----------- | :------- |
30+
| `BarcodeReader.InitLicense` | `CLicenseManager.InitLicense` |
31+
32+
### Update Single Image Decoding APIs
33+
34+
The APIs for decoding single image has been adjusted as follows:
35+
36+
| Old APIs | New APIs |
37+
| :----------- | :------- |
38+
| `BarcodeReader.DecodeFile` | `CaptureVisionRouter.Capture(string filePath, string templateName="")` |
39+
| `BarcodeReader.DecodeFileInMemory` | `CaptureVisionRouter.Capture(byte[] fileBytes, string templateName="")` |
40+
| `BarcodeReader.DecodeBuffer` | `CaptureVisionRouter.Capture(ImageData imageData, string templateName="")` |
41+
| `class TextResult` | `class BarcodeResultItem` |
42+
| `BarcodeReader.DecodeBase64String` | **Currently not available**. |
43+
| `BarcodeReader.DecodeBitmap` | **Currently not available**. |
44+
45+
### Update Video Streaming Decoding Code
46+
47+
`ImageSourceAdapter` is added to replace the `FrameDecodeingParameters` and the previous video methods. You should implement `ImageSourceAdapter` to transfer image data from camera or video file to buffer.
48+
49+
50+
### Migrate Your Templates
51+
52+
The template system is upgraded. The template you used for the previous version can't be directly recognized by the new version. Please <a href="https://download2.dynamsoft.com/dcv/TemplateConverter.zip" target="_blank">download the TemplateConverter tool</a> or <a href="https://www.dynamsoft.com/company/customer-service/#contact" target="_blank">contact us</a> to upgrade your template.
53+
54+
The template-based APIs have been updated as follows:
55+
56+
| Old APIs | New APIs |
57+
| :----------- | :------- |
58+
| `BarcodeReader.InitRuntimeSettingsWithFile` | `CaptureVisionRouter.InitSettingsFromFile` |
59+
| `BarcodeReader.InitRuntimeSettingsWithString` | `CaptureVisionRouter.InitSettings` |
60+
| `BarcodeReader.OutputSettingsToFile` | `CaptureVisionRouter.OutputSettingsToFile` |
61+
| `BarcodeReader.OutputSettingsToString` | `CaptureVisionRouter.OutputSettings` |
62+
| `BarcodeReader.ResetRuntimeSettings` | `CaptureVisionRouter.ResetSettings` |
63+
| `BarcodeReader.AppendTplFileToRuntimeSettings` | **Not available**. |
64+
| `BarcodeReader.AppendTplStringToRuntimeSettings` | **Not available**. |
65+
| `BarcodeReader.GetAllParameterTemplateNames` | **Not available**. |
66+
67+
### Migrate Your PublicRuntimeSettings
68+
69+
The struct `PublicRuntimeSettings` has been refactored. It retains commonly used properties via `SimplifiedCaptureVisionSettings` while removing the previously complex property settings, which are now exclusively supported through templates.
70+
71+
The APIs for accessing and updating `PublicRuntimeSettings` has been adjusted as follows:
72+
73+
| Old APIs | New APIs |
74+
| :----------- | :------- |
75+
| `BarcodeReader.GetRuntimeSettings` | `CaptureVisionRouter.GetSimplifiedSettings` |
76+
| `BarcodeReader.UpdateRuntimeSettings` | `CaptureVisionRouter.UpdateSettings` |
77+
78+
#### Migrate to SimplifiedCaptureVisionSettings
79+
80+
The following properties are replaced by similar properties under `SimplifiedCaptureVisionSettings`. They can also be set via a template file(String).
81+
82+
| PublicRuntimeSettings Property | SimplifiedCaptureVisionSettings Parameter | Template File Parameter |
83+
| ------------------------------- | ----------------------------------------- | ----------------------- |
84+
| `Region` | [`roi`]({{ site.dcvb_dotnet_api }}capture-vision-router/structs/simplified-capture-vision-settings.html#roi) & [`roiMeasuredInPercentage`]({{ site.dcvb_dotnet_api }}capture-vision-router/structs/simplified-capture-vision-settings.html#roimeasuredinpercentage) | [`TargetROIDef.Location.Offset`]({{ site.dcvb_parameters_reference }}target-roi-def/location.html) |
85+
| `Timeout` | [`timeout`]({{ site.dcvb_dotnet_api }}capture-vision-router/structs/simplified-capture-vision-settings.html#timeout) | [`CaptureVisionTemplates.Timeout`]({{ site.dcvb_parameters_reference }}capture-vision-template/timeout.html) |
86+
87+
#### Migrate to SimplifiedBarcodeReaderSettings
88+
89+
The following properties are replaced by similar properties under `SimplifiedBarcodeReaderSettings`. The majority of them can also be set via a template file(String).
90+
91+
| PublicRuntimeSettings Property | SimplifiedBarcodeReaderSettings Property | Template File Parameter |
92+
| ------------------------------- | ----------------------------------------- | ----------------------- |
93+
| `MinBarcodeTextLength` | [`minBarcodeTextLength`]({{ site.dbr_dotnet_api }}simplified-barcode-reader-settings.html#minbarcodetextlength) | [`BarcodeFormatSpecification.BarcodeTextLengthRangeArray`]({{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-text-length-range-array.html) |
94+
| `MinResultConfidence` | [`minResultConfidence`]({{ site.dbr_dotnet_api }}simplified-barcode-reader-settings.html#minresultconfidence) | [`BarcodeFormatSpecification.MinResultConfidence`]({{ site.dcvb_parameters_reference }}barcode-format-specification/min-result-confidence.html) |
95+
| `LocalizationModes` | [`localizationModes`]({{ site.dbr_dotnet_api }}simplified-barcode-reader-settings.html#localizationmodes) | [`BarcodeReaderTaskSetting.LocationModes`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/localization-modes.html) |
96+
| `ExpectedBarcodesCount` | [`expectedBarcodesCount`]({{ site.dbr_dotnet_api }}simplified-barcode-reader-settings.html#expectedbarcodescount) | [`BarcodeReaderTaskSetting.ExpectedBarcodesCount`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/expected-barcodes-count.html) |
97+
| `BarcodeFormatIds` | [`barcodeFormatIds`]({{ site.dbr_dotnet_api }}simplified-barcode-reader-settings.html#barcodeformatids) | [`BarcodeReaderTaskSetting.BarcodeFormatIds`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/barcode-format-ids.html) |
98+
| `BarcodeFormatIds_2` | [`barcodeFormatIds`]({{ site.dbr_dotnet_api }}simplified-barcode-reader-settings.html#barcodeformatids) | [`BarcodeReaderTaskSetting.BarcodeFormatIds`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/barcode-format-ids.html) |
99+
| `DeblurModes` | [`deblurModes`]({{ site.dbr_dotnet_api }}simplified-barcode-reader-settings.html#deblurmodes) | [`BarcodeReaderTaskSetting.DeblurModes`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/deblur-modes.html) |
100+
| `DeblurLevel` | [`deblurModes`]({{ site.dbr_dotnet_api }}simplified-barcode-reader-settings.html#deblurmodes) | [`BarcodeReaderTaskSetting.DeblurModes`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/deblur-modes.html) |
101+
| `MaxAlgorithmThreadCount` | [`maxThreadsInOneTask`]({{ site.dbr_dotnet_api }}simplified-barcode-reader-settings.html#maxthreadsinonetask) | [`BarcodeReaderTaskSetting.MaxThreadsInOneTask`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/max-threads-in-one-task.html) |
102+
103+
> Remarks:
104+
>
105+
> * The 2 groups of barcode formats are merged.
106+
> * `DeblurLevel` is deprecated. You can use `DeblurModes` instead.
107+
108+
| FurtherModes Property | SimplifiedBarcodeReaderSettings Property | Template File Parameter |
109+
| ---------------------- | ----------------------------------------- | ----------------------- |
110+
| `GrayscaleTransformationModes` | [`grayscaleTransformationModes`]({{ site.dbr_dotnet_api }}simplified-barcode-reader-settings.html#grayscaletransformationmodes) | [`ImageParameter.GrayscaleTransformationModes`]({{ site.dcvb_parameters_reference }}image-parameter/grayscale-enhancement-modes.html) |
111+
| `ImagePreprocessingModes` | [`grayscaleEnhancementModes`]({{ site.dbr_dotnet_api }}simplified-barcode-reader-settings.html#grayscaleenhancementmodes) | [`ImageParameter.GrayscaleEnhancementModes`]({{ site.dcvb_parameters_reference }}image-parameter/grayscale-transformation-modes.html) |
112+
113+
> Remarks: The mode `IPM_MORPHOLOGY` of `ImagePreprocessingModes` is migrated to `BinarizationModes`. The mode arguments `MorphOperation`, `MorphOperationKernelSizeX`, `MorphOperationKernelSizeY`, `MorphShape` are now available for all modes of `BinarizationModes`.
114+
115+
#### Migrate to Template File
116+
117+
The following properties can only be set via a template file. Please [contact us](https://www.dynamsoft.com/company/customer-service/#contact){:target="_blank"} so that we can help you to transform your current settings to a new template file.
118+
119+
| PublicRuntimeSettings Property | Template File Parameter |
120+
| ------------------------------- | ----------------------- |
121+
| `ScaleDownThreshold` | [`ImageParameter.ScaleDownThreshold`]({{ site.dcvb_parameters_reference }}image-parameter/scale-down-threshold.html) |
122+
| `BinarizationModes` | [`ImageParameter.BinarizationModes`]({{ site.dcvb_parameters_reference }}image-parameter/binarization-modes.html) |
123+
| `TextResultOrderModes` | [`BarcodeReaderTaskSetting.TextResultOrderModes`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/text-result-order-modes.html) |
124+
| `ReturnBarcodeZoneClarity` | [`BarcodeReaderTaskSetting.ReturnBarcodeZoneClarity`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/return-barcode-zone-clarity.html) |
125+
| `ScaleUpModes` | [`ImageParameter.ScaleUpModes`]({{ site.dcvb_parameters_reference }}image-parameter/scale-up-modes.html) |
126+
| `BarcodeZoneMinDistanceToImageBorders` | [`BarcodeFormatSpecification.BarcodeZoneMinDistanceToImageBorders`]({{ site.dcvb_parameters_reference }}barcode-format-specification/barcode-zone-min-distance-to-image-borders.html) |
127+
| `TerminatePhase` | [`BarcodeReaderTaskSetting.TerminateSettings`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/terminate-setting.html) |
128+
129+
| FurtherModes Property | Template File Parameter |
130+
| ---------------------- | ----------------------- |
131+
| `ColourConversionModes` | [`ImageParameter.ColourConversionModes`]({{ site.dcvb_parameters_reference }}image-parameter/colour-conversion-modes.html) |
132+
| `RegionPredetectionModes` | [`ImageParameter.RegionPredetectionModes`]({{ site.dcvb_parameters_reference }}image-parameter/region-predetection-modes.html) |
133+
| `TextureDetectionModes` | [`ImageParameter.TextureDetectionModes`]({{ site.dcvb_parameters_reference }}image-parameter/texture-detection-modes.html) |
134+
| `TextFilterModes` | [`ImageParameter.TextDetectionMode`]({{ site.dcvb_parameters_reference }}image-parameter/text-detection-mode.html) & [`ImageParameter.IfEraseTextZone`]({{ site.dcvb_parameters_reference }}image-parameter/if-erase-text-zone.html) |
135+
| `DPMCodeReadingModes` | [`BarcodeReaderTaskSetting.DPMCodeReadingModes`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/dpm-code-reading-modes.html) |
136+
| `DeformationResistingModes` | [`BarcodeReaderTaskSetting.DeformationResistingModes`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/deformation-resisting-modes.html) |
137+
| `BarcodeComplementModes` | [`BarcodeReaderTaskSetting.BarcodeComplementModes`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/barcode-complement-modes.html) |
138+
| `BarcodeColourModes` | [`BarcodeReaderTaskSetting.BarcodeColourModes`]({{ site.dcvb_parameters_reference }}barcode-reader-task-settings/barcode-colour-modes.html) |
139+
140+
#### Migrate to Other APIs
141+
142+
The PDF properties of PublicRuntimeSettings are moved to set via the `setPDFReadingParameter` method of `DirectoryFetcher` and `FileFetcher` with a [`PDFReadingParameter`]({{ site.dcvb_dotnet_api }}core/basic-structures/pdf-reading-parameter.html) parameter.
143+
144+
| PublicRuntimeSettings Property |
145+
| --------------------------------------- |
146+
| `PDFReadingMode` |
147+
| `PDFRasterDPI` |
148+
149+
The `Intermediate Result` system is redesigned and the following properties are deprecated.
150+
151+
| PublicRuntimeSettings Property |
152+
| --------------------- |
153+
| `IntermediateResultTypes` |
154+
| `IntermediateResultSavingMode` |
155+
156+
#### Removed
157+
158+
The following properties are removed.
159+
160+
| PublicRuntimeSettings Property|
161+
| --------------------- |
162+
| `ResultCoordinateType` |
163+
164+
| FurtherModes Property|
165+
| --------------------- |
166+
| `ColourClusteringModes` |

0 commit comments

Comments
 (0)