Skip to content

Commit 4864736

Browse files
ZoroWangZoroWang
committed
Update README.md
1 parent 96b0375 commit 4864736

File tree

1 file changed

+38
-36
lines changed

1 file changed

+38
-36
lines changed

‎README.md

Lines changed: 38 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -98,19 +98,19 @@ https://www.dynamsoft.com/Products/Dynamic-Barcode-Reader-News.aspx
9898

9999

100100
- **EnumAccompanyingTextRecognitionMode** : Describes the accompanying text recognition mode.
101-
- ATRM_GENERAL : Recognizes accompanying texts using the general algorithm.
101+
- ATRM_GENERAL : Recognizes accompanying texts using the general algorithm. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
102102
- ATRM_SKIP : Skips the accompanying text recognition.
103103
- **EnumBarcodeComplementMode** : Describes the barcode complement mode.
104104
- BCM_AUTO : Not supported yet.
105105
- BCM_GENERAL : Complements the barcode using the general algorithm.
106106
- BCM_SKIP : Skips the barcode complement.
107107
- **EnumBarcodeColourMode** : Describes the barcode colour mode.
108-
- BICM_DARK_ON_LIGHT : Dark items on a light background.
109-
- BICM_LIGHT_ON_DARK : Light items on a dark background. Not supported yet.
110-
- BICM_DARK_ON_DARK : Dark items on a dark background. Not supported yet.
111-
- BICM_LIGHT_ON_LIGHT : Light items on a light background. Not supported yet.
112-
- BICM_DARK_LIGHT_MIXED : The background is mixed by dark and light. Not supported yet.
113-
- BICM_DARK_ON_LIGHT_DARK_SURROUNDING : Dark item on a light background surrounded by dark.
108+
- BICM_DARK_ON_LIGHT : Dark items on a light background. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
109+
- BICM_LIGHT_ON_DARK : Light items on a dark background. Not supported yet. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
110+
- BICM_DARK_ON_DARK : Dark items on a dark background. Not supported yet. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
111+
- BICM_LIGHT_ON_LIGHT : Light items on a light background. Not supported yet. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
112+
- BICM_DARK_LIGHT_MIXED : The background is mixed by dark and light. Not supported yet. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
113+
- BICM_DARK_ON_LIGHT_DARK_SURROUNDING : Dark item on a light background surrounded by dark. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
114114
- BICM_SKIP : Skips the barcode colour operation.
115115
- **EnumBarcodeFormat** : Describes the barcode types in BarcodeFormat group 1.
116116
- BF_ALL : All supported formats in BarcodeFormat group 1
@@ -156,21 +156,25 @@ https://www.dynamsoft.com/Products/Dynamic-Barcode-Reader-News.aspx
156156
- BF2_DOTCODE : DotCode
157157
- **EnumBinarizationMode** : Describes the binarization mode.
158158
- BM_AUTO : Not supported yet.
159-
- BM_LOCAL_BLOCK : Binarizes the image based on the local block.
159+
- BM_LOCAL_BLOCK : Binarizes the image based on the local block. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
160160
- BM_SKIP : Skips the binarization.
161+
- **EnumClarityCalculationMethod** : Describes the clarity calculation method.
162+
- ECCM_CONTRAST : Calculates clarity using the contrast method.
163+
- **EnumClarityFilterMode** : Describes the clarity filter mode.
164+
- CFM_GENERAL : The frames using the general algorithm based on calculated clarity.
161165
- **EnumColourClusteringMode** : Describes the colour clustering mode.
162166
- CCM_AUTO : Not supported yet.
163-
- CCM_GENERAL_HSV : Clusters colours using the general algorithm based on HSV.
167+
- CCM_GENERAL_HSV : Clusters colours using the general algorithm based on HSV. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
164168
- CCM_SKIP : Skips the colour clustering.
165169
- **EnumColourConversionMode** : Describes the colour conversion mode.
166-
- CICM_GENERAL : Converts a colour image to a grayscale image using the general algorithm.
170+
- CICM_GENERAL : Converts a colour image to a grayscale image using the general algorithm. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
167171
- CICM_SKIP : Skips the colour conversion.
168172
- **EnumConflictMode** : Describes the conflict mode.
169173
- CM_IGNORE : Ignores new settings and inherits the previous settings.
170174
- CM_OVERWRITE : Overwrites the old settings with new settings.
171175
- **EnumDeformationResistingMode** : Describes the deformation resisting mode.
172176
- DRM_AUTO : Not supported yet.
173-
- DRM_GENERAL : Resists deformation using the general algorithm.
177+
- DRM_GENERAL : Resists deformation using the general algorithm. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
174178
- DRM_SKIP : Skips deformation resisting.
175179
- **EnumDPMCodeReadingMode** : Describes the DPM code reading mode.
176180
- DPMCRM_AUTO : Not supported yet.
@@ -197,11 +201,11 @@ https://www.dynamsoft.com/Products/Dynamic-Barcode-Reader-News.aspx
197201
- IPF_BGR_888 : 24bit with BGR channel order stored in memory from high to low address
198202
- **EnumImagePreprocessingMode** : Describes the image preprocessing mode.
199203
- IPM_AUTO : Not supported yet.
200-
- IPM_GENERAL : Takes the unpreprocessed image for following operations.
201-
- IPM_GRAY_EQUALIZE : Preprocesses the image using the gray equalization algorithm.
202-
- IPM_GRAY_SMOOTH : Preprocesses the image using the gray smoothing algorithm.
203-
- IPM_SHARPEN_SMOOTH : Preprocesses the image using the sharpening and smoothing algorithm.
204-
- IPM_MORPHOLOGY : Preprocesses the image using the morphology algorithm.
204+
- IPM_GENERAL : Takes the unpreprocessed image for following operations. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
205+
- IPM_GRAY_EQUALIZE : Preprocesses the image using the gray equalization algorithm. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
206+
- IPM_GRAY_SMOOTH : Preprocesses the image using the gray smoothing algorithm. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
207+
- IPM_SHARPEN_SMOOTH : Preprocesses the image using the sharpening and smoothing algorithm. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
208+
- IPM_MORPHOLOGY : Preprocesses the image using the morphology algorithm. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
205209
- IPM_SKIP : Skips image preprocessing.
206210
- **EnumIMResultDataType** : Describes the intermediate result data type.
207211
- IMRDT_IMAGE : Specifies the ImageData
@@ -212,8 +216,8 @@ https://www.dynamsoft.com/Products/Dynamic-Barcode-Reader-News.aspx
212216
- IMRDT_QUADRILATERAL : Specifies the Quadrilateral
213217
- **EnumIntermediateResultSavingMode** : Describes the intermediate result saving mode.
214218
- IRSM_MEMORY : Saves intermediate results in memory.
215-
- IRSM_FILESYSTEM : Saves intermediate results in file system.
216-
- IRSM_BOTH : Saves intermediate results in both memory and file system.
219+
- IRSM_FILESYSTEM : Saves intermediate results in file system. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
220+
- IRSM_BOTH : Saves intermediate results in both memory and file system. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
217221
- **EnumIntermediateResultType** : Describes the intermediate result type.
218222
- IRT_NO_RESULT : No intermediate result
219223
- IRT_ORIGINAL_IMAGE : Original image
@@ -235,10 +239,14 @@ https://www.dynamsoft.com/Products/Dynamic-Barcode-Reader-News.aspx
235239
- LM_CONNECTED_BLOCKS : Localizes barcodes by searching for connected blocks. This algorithm usually gives best result and it is recommended to set ConnectedBlocks to the highest priority.
236240
- LM_STATISTICS : Localizes barcodes by groups of contiguous black-white regions. This is optimized for QRCode and DataMatrix.
237241
- LM_LINES : Localizes barcodes by searching for groups of lines. This is optimized for 1D and PDF417 barcodes.
238-
- LM_SCAN_DIRECTLY : Localizes barcodes quickly. This mode is recommended in interactive scenario.
242+
- LM_SCAN_DIRECTLY : Localizes barcodes quickly. This mode is recommended in interactive scenario. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
239243
- LM_STATISTICS_MARKS : Localizes barcodes by groups of marks.This is optimized for DPM codes.
240244
- LM_STATISTICS_POSTAL_CODE : Localizes barcodes by groups of connected blocks and lines.This is optimized for postal codes.
241245
- LM_SKIP : Skips localization.
246+
- **EnumPDFReadingMode** : Describes the clarity filter mode.
247+
- PDFRM_AUTO : Lets the library choose the reading mode automatically.
248+
- PDFRM_VECTOR : Detects barcode from vector data in PDF file.
249+
- PDFRM_RASTER : Converts the PDF file to image(s) first, then perform barcode recognition.
242250
- **EnumQRCodeErrorCorrectionLevel** : Describes the QR Code error correction level.
243251
- QRECL_ERROR_CORRECTION_H : Error Correction Level H (high)
244252
- QRECL_ERROR_CORRECTION_L : Error Correction Level L (low)
@@ -247,9 +255,9 @@ https://www.dynamsoft.com/Products/Dynamic-Barcode-Reader-News.aspx
247255
- **EnumRegionPredetectionMode** : Describes the region predetection mode.
248256
- RPM_AUTO : Lets the library choose an algorithm automatically to detect region.
249257
- RPM_GENERAL : Takes the whole image as a region.
250-
- RPM_GENERAL_RGB_CONTRAST : Detects region using the general algorithm based on RGB colour contrast.
251-
- RPM_GENERAL_GRAY_CONTRAST : Detects region using the general algorithm based on gray contrast.
252-
- RPM_GENERAL_HSV_CONTRAST : Detects region using the general algorithm based on HSV colour contrast.
258+
- RPM_GENERAL_RGB_CONTRAST : Detects region using the general algorithm based on RGB colour contrast. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
259+
- RPM_GENERAL_GRAY_CONTRAST : Detects region using the general algorithm based on gray contrast. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
260+
- RPM_GENERAL_HSV_CONTRAST : Detects region using the general algorithm based on HSV colour contrast. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
253261
- RPM_SKIP : Skips region detection.
254262
- **EnumResultCoordinateType** : Describes the result coordinate type.
255263
- RCT_PIXEL : Returns the coordinate in pixel value.
@@ -261,8 +269,8 @@ https://www.dynamsoft.com/Products/Dynamic-Barcode-Reader-News.aspx
261269
- RT_PARTIAL_TEXT : Specifies the partial text. This means part of the text result decoded from the barcode.
262270
- **EnumScaleUpMode** : Describes the scale up mode.
263271
- SUM_AUTO : The library chooses an interpolation method automatically to scale up.
264-
- SUM_LINEAR_INTERPOLATION : Scales up using the linear interpolation method.
265-
- SUM_NEAREST_NEIGHBOUR_INTERPOLATION : Scales up using the nearest-neighbour interpolation method.
272+
- SUM_LINEAR_INTERPOLATION : Scales up using the linear interpolation method. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
273+
- SUM_NEAREST_NEIGHBOUR_INTERPOLATION : Scales up using the nearest-neighbour interpolation method. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
266274
- SUM_SKIP : Skip the scale-up process.
267275
- **EnumTerminatePhase** : Describes the terminate phase.
268276
- TP_REGION_PREDETECTED : Exits the barcode reading algorithm after the region predetection is done.
@@ -273,12 +281,12 @@ https://www.dynamsoft.com/Products/Dynamic-Barcode-Reader-News.aspx
273281
- TP_BARCODE_RECOGNIZED : Exits the barcode reading algorithm after the region predetection, image pre-processing, image binarization, barcode localization, barcode type determining, and barcode recognition are done.
274282
- **EnumTextAssistedCorrectionMode** : Describes the text assisted correction mode.
275283
- TACM_AUTO : Not supported yet.
276-
- TACM_VERIFYING : Uses the accompanying text to verify the decoded barcode result.
277-
- TACM_VERIFYING_PATCHING : Uses the accompanying text to verify and patch the decoded barcode result.
284+
- TACM_VERIFYING : Uses the accompanying text to verify the decoded barcode result. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
285+
- TACM_VERIFYING_PATCHING : Uses the accompanying text to verify and patch the decoded barcode result. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
278286
- TACM_SKIP : Skips the text assisted correction.
279287
- **EnumTextFilterMode** : Describes the text filter mode.
280288
- TFM_AUTO : Not supported yet.
281-
- TFM_GENERAL_CONTOUR : Filters text using the general algorithm based on contour.
289+
- TFM_GENERAL_CONTOUR : Filters text using the general algorithm based on contour. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
282290
- TFM_SKIP : Skips text filtering.
283291
- **EnumTextResultOrderMode** : Describes the text result order mode.
284292
- TROM_CONFIDENCE : Returns the text results in descending order by confidence.
@@ -287,16 +295,10 @@ https://www.dynamsoft.com/Products/Dynamic-Barcode-Reader-News.aspx
287295
- TROM_SKIP : Skips the result ordering operation.
288296
- **EnumTextureDetectionMode** : Describes the texture detection mode.
289297
- TDM_AUTO : Not supported yet.
290-
- TDM_GENERAL_WIDTH_CONCENTRATION : Detects texture using the general algorithm.
298+
- TDM_GENERAL_WIDTH_CONCENTRATION : Detects texture using the general algorithm. Check [Mode Argument List](#Mode-Argument-List) for available argument settings.
291299
- TDM_SKIP : Skips texture detection.
292-
- **EnumClarityCalculationMethod** : Describes the clarity calculation method.
293-
- ECCM_CONTRAST : Calculates clarity using the contrast method.
294-
- **EnumClarityFilterMode** : Describes the clarity filter mode.
295-
- CFM_GENERAL : The frames using the general algorithm based on calculated clarity.
296-
- **EnumPDFReadingMode** : Describes the clarity filter mode.
297-
- PDFRM_AUTO : Lets the library choose the reading mode automatically.
298-
- PDFRM_VECTOR : Detects barcode from vector data in PDF file.
299-
- PDFRM_RASTER : Converts the PDF file to image(s) first, then perform barcode recognition.
300+
301+
300302

301303

302304
#### Struct Interfaces

0 commit comments

Comments
 (0)