Skip to content

Commit 6b266d9

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #73 from dynamsoft-docs/preview
update to internal commit b49400e2
2 parents b06e9f8 + 2bde760 commit 6b266d9

19 files changed

+151
-68
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,7 @@ int StartCapturing(const char* templateName = "", bool waitForThreadExit = false
256256
**Remarks**
257257
258258
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_cpp_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettingsfromfile).
259+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
259260
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
260261
- If parameter `templateName` is not specified, the preset one named 'Default' will be used. However, if the preset ones have been overwritten as described above, the first `CaptureVisionTemplate` from the user's own settings will be used instead.
261262

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

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -97,12 +97,19 @@ char* OutputSettings(const char* templateName, bool includeDefaultValues = false
9797
9898
**Parameters**
9999
100-
`[in] templateName` The name of the template to export.
100+
`[in] templateName` The name of the `CaptureVisionTemplate` to export.
101101
102102
`[in] includeDefaultValues` Specifies whether to include default values in the exported template.
103103
104104
`[out] pErrorCode` An error code.
105105
106+
**Remarks**
107+
108+
- It is supported to export all loaded templates by specifying the `templateName` as '*'.
109+
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_cpp_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettingsfromfile).
110+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
111+
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
112+
106113
**Return value**
107114
108115
Returns a string containing the exported template. The string is allocated by the SDK and must be freed by calling [`CoreModule::FreeBytes`]({{ site.dcvb_cpp_api }}core/basic-structures/core-module.html#freebytes).
@@ -111,9 +118,6 @@ Returns a string containing the exported template. The string is allocated by th
111118
| :--------- | :---- | :---------- |
112119
| EC_TEMPLATE_NAME_INVALID | -10036 | The target template name is invalid. |
113120
114-
**Remarks**
115-
116-
It is supported to export all loaded templates by specifying the `templateName` as '*'.
117121
118122
## OutputSettingsToFile
119123
@@ -125,12 +129,19 @@ int OutputSettingsToFile(const char* templateName, const char* filePath, bool in
125129

126130
**Parameters**
127131

128-
`[in] templateName` The name of the template to export.
132+
`[in] templateName` The name of the `CaptureVisionTemplate` to export.
129133

130134
`[in] filePath` The path to the output file.
131135

132136
`[in] includeDefaultValues` Specifies whether to include default values in the exported template.
133137

138+
**Remarks**
139+
140+
- It is supported to export all loaded templates by specifying the `templateName` as '*'.
141+
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_cpp_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettingsfromfile).
142+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
143+
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
144+
134145
**Return value**
135146

136147
Returns an error code. Zero indicates success.
@@ -139,10 +150,6 @@ Returns an error code. Zero indicates success.
139150
| :--------- | :---- | :---------- |
140151
| EC_FILE_SAVE_FAILED | -10058 | The file path is unavailable or the file can't be created for any other reasons. |
141152

142-
**Remarks**
143-
144-
It is supported to export all loaded templates by specifying the `templateName` as '*'.
145-
146153
## GetSimplifiedSettings
147154

148155
Retrieves a simplified version of the capture settings for a specific template.
@@ -153,10 +160,16 @@ int GetSimplifiedSettings(const char* templateName, SimplifiedCaptureVisionSetti
153160
154161
**Parameters**
155162
156-
`[in] templateName` The name of the template.
163+
`[in] templateName` The name of the `CaptureVisionTemplate`.
157164
158165
`[out] settings` A pointer to a `SimplifiedCaptureVisionSettings` object.
159166
167+
**Remarks**
168+
169+
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_cpp_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettingsfromfile).
170+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
171+
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
172+
160173
**Return value**
161174
162175
Returns an error code. Zero indicates success.
@@ -181,14 +194,20 @@ int UpdateSettings(const char* templateName, const SimplifiedCaptureVisionSettin
181194

182195
**Parameters**
183196

184-
`[in] templateName` The name of the template to update.
197+
`[in] templateName` The name of the `CaptureVisionTemplate` to update.
185198

186199
`[in] settings` A pointer to a `SimplifiedCaptureVisionSettings` object.
187200

188201
`[in] errorMsgBuffer` A buffer for error messages.
189202

190203
`[in] errorMsgBufferLen` The length of the error message buffer.
191204

205+
**Remarks**
206+
207+
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_cpp_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettingsfromfile).
208+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
209+
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
210+
192211
**Return value**
193212

194213
Returns an error code. Zero indicates success.

‎programming/cplusplus/api-reference/capture-vision-router/single-file-processing-v2.6.1000.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ CCapturedResult* Capture(const CImageData* pImageData, const char* templateName=
3939
**Remarks**
4040
4141
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_cpp_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettingsfromfile).
42+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
4243
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
4344
- If parameter `templateName` is not specified, the preset one named 'Default' will be used. However, if the preset ones have been overwritten as described above, the first `CaptureVisionTemplate` from the user's own settings will be used instead.
4445

‎programming/cplusplus/api-reference/capture-vision-router/single-file-processing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ CCapturedResult* Capture(const CImageData* pImageData, const char* templateName=
4040
**Remarks**
4141
4242
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_cpp_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettingsfromfile).
43+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
4344
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
4445
- If parameter `templateName` is not specified, the preset one named 'Default' will be used. However, if the preset ones have been overwritten as described above, the first `CaptureVisionTemplate` from the user's own settings will be used instead.
4546
@@ -102,6 +103,7 @@ CCapturedResultArray* CaptureMultiPages(const unsigned char *fileBytes, int file
102103
**Remarks**
103104
104105
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_cpp_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettingsfromfile).
106+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
105107
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
106108
- If parameter `templateName` is not specified, the preset one named 'Default' will be used. However, if the preset ones have been overwritten as described above, the first `CaptureVisionTemplate` from the user's own settings will be used instead.
107109

‎programming/cplusplus/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ The best way to begin with Dynamsoft Capture Vision C++ Edition is to follow the
4949
- Supported Versions: 10.15+
5050
- Architecture: x64 and ARM 64-bit
5151

52+
- For Embedded Devices:
53+
For embedded or ARM-based platforms, we recommend using a device with performance equivalent to or better than a Raspberry Pi 4 Model B (4GB RAM). Minimum recommended specs:
54+
- Quad-core ARM Cortex-A72 processor (or equivalent)
55+
- 4 GB RAM
56+
- Linux-based OS (e.g., Raspberry Pi OS, Ubuntu Server)
57+
5258
## API Reference
5359

5460
For an overview of the APIs, see the [API Reference]({{ site.dcvb_cpp_api }}).

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,7 @@ int StartCapturing(string templateName, bool waitForThreadExit, out string error
253253
**Remarks**
254254

255255
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_dotnet_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettingsfromfile).
256+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
256257
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
257258
- If parameter `templateName` is not specified, the preset one named 'Default' will be used. However, if the preset ones have been overwritten as described above, the first `CaptureVisionTemplate` from the user's own settings will be used instead.
258259

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

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,17 @@ string OutputSettings(string templateName, out int errorCode)
9090

9191
**Parameters**
9292

93-
`[in] templateName` The name of the template to export.
93+
`[in] templateName` The name of the `CaptureVisionTemplate` to export.
9494

9595
`[out] errorCode` An error code generated during the process.
9696

97+
**Remarks**
98+
99+
- It is supported to export all loaded templates by specifying the `templateName` as '*'.
100+
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_dotnet_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettingsfromfile).
101+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
102+
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
103+
97104
**Return Value**
98105

99106
Returns a string containing the exported template.
@@ -103,10 +110,6 @@ Returns a string containing the exported template.
103110
| EC_TEMPLATE_NAME_INVALID | -10036 | The target template name is invalid. |
104111
| EC_CALL_REJECTED_WHEN_CAPTURING | -10062 | Function call is rejected when capturing in progress. |
105112

106-
**Remarks**
107-
108-
It is supported to export all loaded templates by specifying the `templateName` as '*'.
109-
110113
## OutputSettingsToFile
111114

112115
Exports a specific template to a file.
@@ -117,10 +120,17 @@ int OutputSettingsToFile(string templateName, string filePath)
117120

118121
**Parameters**
119122

120-
`[in] templateName` The name of the template to export.
123+
`[in] templateName` The name of the `CaptureVisionTemplate` to export.
121124

122125
`[in] filePath` The path to the output file.
123126

127+
**Remarks**
128+
129+
- It is supported to export all loaded templates by specifying the `templateName` as '*'.
130+
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_dotnet_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettingsfromfile).
131+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
132+
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
133+
124134
**Return Value**
125135

126136
Returns an error code. Zero indicates success.
@@ -130,10 +140,6 @@ Returns an error code. Zero indicates success.
130140
| EC_FILE_SAVE_FAILED | -10058 | The file path is unavailable or the file can't be created for any other reasons. |
131141
| EC_CALL_REJECTED_WHEN_CAPTURING | -10062 | Function call is rejected when capturing in progress. |
132142

133-
**Remarks**
134-
135-
It is supported to export all loaded templates by specifying the `templateName` as '*'.
136-
137143
## GetSimplifiedSettings
138144

139145
Retrieves a simplified version of the capture settings for a specific template.
@@ -144,10 +150,16 @@ int GetSimplifiedSettings(string templateName, out SimplifiedCaptureVisionSettin
144150

145151
**Parameters**
146152

147-
`[in] templateName` The name of the template.
153+
`[in] templateName` The name of the `CaptureVisionTemplate`.
148154

149155
`[out] settings` A `SimplifiedCaptureVisionSettings` object.
150156

157+
**Remarks**
158+
159+
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_dotnet_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettingsfromfile).
160+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
161+
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
162+
151163
**Return Value**
152164

153165
Returns an error code. Zero indicates success.
@@ -172,12 +184,18 @@ int UpdateSettings(string templateName, SimplifiedCaptureVisionSettings settings
172184

173185
**Parameters**
174186

175-
`[in] templateName` The name of the template to update.
187+
`[in] templateName` The name of the `CaptureVisionTemplate` to update.
176188

177189
`[in] settings` A `SimplifiedCaptureVisionSettings` object.
178190

179191
`[out] errorMsg` Stores any error messages generated during the process.
180192

193+
**Remarks**
194+
195+
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_dotnet_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettingsfromfile).
196+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
197+
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
198+
181199
**Return Value**
182200

183201
Returns an error code. Zero indicates success.

‎programming/dotnet/api-reference/capture-vision-router/single-file-processing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ CapturedResult Capture(ImageData imageData, string templateName="");
3636
**Remarks**
3737

3838
- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_dotnet_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettingsfromfile).
39+
- When using a custom template, the parameter `templateName` should be the name of the [`CaptureVisionTemplate` object]({{ site.dcvb_parameters }}file/capture-vision-template.html) in the JSON template file.
3940
- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
4041
- If parameter `templateName` is not specified, the preset one named 'Default' will be used. However, if the preset ones have been overwritten as described above, the first `CaptureVisionTemplate` from the user's own settings will be used instead.
4142

0 commit comments

Comments
 (0)