Table of contents

Parameter Mode Enumeration

Enumeration Description
BarcodeColourMode Describes the barcode colour mode.
BarcodeComplementMode Describes the barcode complement mode.
BinarizationMode Describes the binarization mode.
ColourClusteringMode Describes the colour clustering mode.
ColourConversionMode Describes the colour conversion mode.
ConflictMode Describes the conflict mode.
DeblurMode Describes the deblur mode.
DeformationResistingMode Describes the deformation resisting mode.
DPMCodeReadingMode Describes the DPM code reading mode.
GrayscaleTransformationMode Describes the grayscale transformation mode.
ImagePreprocessingMode Describes the image preprocessing mode.
LocalizationMode Describes the localization mode.
PDFReadingMode Describes the PDF reading mode.
RegionPredetectionMode Describes the region predetection mode.
ScaleUpMode Describes the scale up mode.
TerminatePhase Describes the terminate phase.
TextFilterMode Describes the text filter mode.
TextureDetectionMode Describes the texture detection mode.

BarcodeColourMode

Describes the barcode colour mode.

Declarations

Language Declaration
C / C++ enum BarcodeColourMode
.Net enum Dynamsoft.DBR.EnumBarcodeColourMode
JavaScript Dynamsoft.DBR.EnumBarcodeColourMode
Python class EnumBarcodeColourMode(IntEnum)
Java / Android class EnumBarcodeColourMode
ObjC / Swift enum EnumBarcodeColourMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description Valid Argument(s)
BICM_SKIP EnumBarcodeColourModeSkip skip 0x00 Skips the barcode colour operation. N/A
BICM_DARK_ON_LIGHT EnumBarcodeColourModeDarkOnLight darkOnLight 0x01 Dark items on a light background. LightReflection
BICM_LIGHT_ON_DARK EnumBarcodeColourModeLightOnDark lightOnDark 0x02 Light items on a dark background. Not supported yet. N/A
BICM_DARK_ON_DARK EnumBarcodeColourModeDarkOnDark darkOnDark 0x04 Dark items on a dark background. Not supported yet. N/A
BICM_LIGHT_ON_LIGHT EnumBarcodeColourModeLightOnLight lightOnLight 0x08 Light items on a light background. Not supported yet. N/A
BICM_DARK_LIGHT_MIXED EnumBarcodeColourModeDarkLightMixed darkLightMixed 0x10 The background is mixed by dark and light. Not supported yet. N/A
BICM_DARK_ON_LIGHT_DARK_SURROUNDING EnumBarcodeColourModeDarkOnLightDarkSurrounding darkOnLightDarkSurrounding 0x20 Dark item on a light background surrounded by dark. LightReflection

BarcodeComplementMode

Describes the barcode complement mode.

Declarations

Language Declaration
C / C++ enum BarcodeComplementMode
.Net enum Dynamsoft.DBR.EnumBarcodeComplementMode
JavaScript Dynamsoft.DBR.EnumBarcodeComplementMode
Python class EnumBarcodeComplementMode(IntEnum)
Java / Android class EnumBarcodeComplementMode
ObjC / Swift enum EnumBarcodeComplementMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description
BCM_SKIP EnumBarcodeComplementModeSkip skip 0x00 Skips the barcode complement.
BCM_AUTO EnumBarcodeComplementModeAuto auto 0x01 Not supported yet.
BCM_GENERAL EnumBarcodeComplementModeGeneral general 0x02 Complements the barcode using the general algorithm.

BinarizationMode

Describes the binarization mode.

Declarations

Language Declaration
C / C++ enum BinarizationMode
.Net enum Dynamsoft.DBR.EnumBinarizationMode
JavaScript Dynamsoft.DBR.EnumBinarizationMode
Python class EnumBinarizationMode(IntEnum)
Java / Android class EnumBinarizationMode
ObjC / Swift enum EnumBinarizationMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description Valid Argument(s)
BM_SKIP EnumBinarizationModeSkip skip 0x00 Skips the binarization. N/A
BM_AUTO EnumBinarizationModeAuto auto 0x01 Not supported yet. N/A
BM_LOCAL_BLOCK EnumBinarizationModeLocalBlock localBlock 0x02 Binarizes the image based on the local block. BlockSizeX
BlockSizeY
EnableFillBinaryVacancy
ImagePreprocessingModesIndex
ThresholdCompensation
BM_THRESHOLD EnumBinarizationModeThreshold threshold 0x04 Performs image binarization based on the given threshold. BinarizationThreshold
ImagePreprocessingModesIndex

ColourClusteringMode

Describes the colour clustering mode.

Declarations

Language Declaration
C / C++ enum ColourClusteringMode
.Net enum Dynamsoft.DBR.EnumColourClusteringMode
JavaScript Dynamsoft.DBR.EnumColourClusteringMode
Python class EnumColourClusteringMode(IntEnum)
Java / Android class EnumColourClusteringMode
ObjC / Swift enum EnumColourClusteringMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description Valid Argument(s)
CCM_SKIP EnumColourClusteringModeSkip skip 0x00 Skips the colour clustering. N/A
CCM_AUTO EnumColourClusteringModeAuto auto 0x01 Not supported yet. N/A
CCM_GENERAL_HSV EnumColourClusteringModeGeneralHSV generalHSV 0x02 Clusters colours using the general algorithm based on HSV. Sensitivity

ColourConversionMode

Describes the colour conversion mode.

Declarations

Language Declaration
C / C++ enum ColourConversionMode
.Net enum Dynamsoft.DBR.EnumColourConversionMode
JavaScript Dynamsoft.DBR.EnumColourConversionMode
Python class EnumColourConversionMode(IntEnum)
Java / Android class EnumColourConversionMode
ObjC / Swift enum EnumColourConversionMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description Valid Argument(s)
CICM_SKIP EnumColourConversionModeSkip skip 0x00 Skip the colour conversion. N/A
CICM_GENERAL EnumColourConversionModeGeneral general 0x01 Converts a colour image to a grayscale image using the general algorithm. BlueChannelWeight
GreenChannelWeight
RedChannelWeight

ConflictMode

Describes the conflict mode.

Declarations

Language Declaration
C / C++ enum ConflictMode
.Net enum Dynamsoft.DBR.EnumConflictMode
JavaScript Dynamsoft.DBR.EnumConflictMode
Python class EnumConflictMode(IntEnum)
Java / Android class EnumConflictMode
ObjC / Swift enum EnumConflictMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description
CM_IGNORE EnumConflictModeIgnore ignore 0x01 Ignores new settings and inherits the previous settings.
CM_OVERWRITE EnumConflictModeOverwrite overwrite 0x02 Overwrites the old settings with new settings.

DeblurMode

Describes the deblur mode.

Declarations

Language Declaration
C / C++ enum DeblurMode
.Net enum Dynamsoft.DBR.EnumDeblurMode
JavaScript Dynamsoft.DBR.EnumDeblurMode
Python class EnumDeblurMode(IntEnum)
Java / Android class EnumDeblurMode
ObjC / Swift enum EnumDeblurMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description
DM_SKIP EnumDeblurModeSkip skip 0x00 Skips the deblur process.
DM_DIRECT_BINARIZATION EnumDeblurModeDirectBinarization directBinarization 0x01 Performs deblur process using the direct binarization algorithm.
DM_THRESHOLD_BINARIZATION EnumDeblurModeThresholdBinarization thresholdBinarization 0x02 Performs deblur process using the threshold binarization algorithm.
DM_GRAY_EQUALIZATION EnumDeblurModeGrayEqualization grayEqualization 0x04 Performs deblur process using the gray equalization algorithm.
DM_SMOOTHING EnumDeblurModeSmoothing smoothing 0x08 Performs deblur process using the smoothing algorithm.
DM_MORPHING EnumDeblurModeMorphing morphing 0x10 Performs deblur process using the morphing algorithm.
DM_DEEP_ANALYSIS EnumDeblurModeDeepAnalysis deepAnalysis 0x20 Performs deblur process using the deep analysis algorithm.
DM_SHARPENING EnumDeblurModeSharpening sharpening 0x40 Performs deblur process using the sharpening algorithm.
DM_BASED_ON_LOC_BIN EnumDeblurModeBasedOnLocBin basedOnLocBin 0x80 Performs deblur process based on the binary image from the localization process.
DM_SHARPENING_SMOOTHING EnumDeblurModeSharpeningSmoothing sharpeningSmoothing 0x100 Performs deblur process using the sharpening and smoothing algorithm.

DeformationResistingMode

Describes the deformation resisting mode.

Declarations

Language Declaration
C / C++ enum DeformationResistingMode
.Net enum Dynamsoft.DBR.EnumDeformationResistingMode
JavaScript Dynamsoft.DBR.EnumDeformationResistingMode
Python class EnumDeformationResistingMode(IntEnum)
Java / Android class EnumDeformationResistingMode
ObjC / Swift enum EnumDeformationResistingMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description Valid Argument(s)
DRM_SKIP EnumDeformationResistingModeSkip skip 0x00 Skip the deformation resisting. N/A
DRM_AUTO EnumDeformationResistingModeAuto auto 0x01 Not supported yet. N/A
DRM_GENERAL EnumDeformationResistingModeGeneral general 0x02 Resists deformation using the general algorithm. Level
DRM_BROAD_WARP EnumDeformationResistingModeBroadWarp broadWarp 0x04 Resists deformation when the barcode is warped gently. N/A
DRM_LOCAL_REFERENCE EnumDeformationResistingModeLocalReference localReference 0x08 Resists deformation for barcodes with minor deformation in local modules. N/A
DRM_DEWRINKLE EnumDeformationResistingModeDewrinkle dewrinkle 0x10 Resists deformation for barcodes on a wrinkled surface. N/A

DPMCodeReadingMode

Describes the DPM code reading mode.

Declarations

Language Declaration
C / C++ enum DPMCodeReadingMode
.Net enum Dynamsoft.DBR.EnumDPMCodeReadingMode
JavaScript Dynamsoft.DBR.EnumDPMCodeReadingMode
Python class EnumDPMCodeReadingMode(IntEnum)
Java / Android class EnumDPMCodeReadingMode
ObjC / Swift enum EnumDPMCodeReadingMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value  
DPMCRM_SKIP EnumDPMCodeReadingModeSkip skip 0x00 Skip the DPM code reading.
DPMCRM_AUTO EnumDPMCodeReadingModeAuto auto 0x01 Not supported yet.
DPMCRM_GENERAL EnumDPMCodeReadingModeGeneral general 0x02 Reads DPM code using the general algorithm.

GrayscaleTransformationMode

Describes the grayscale transformation mode.

Declarations

Language Declaration
C / C++ enum GrayscaleTransformationMode
.Net enum Dynamsoft.DBR.EnumGrayscaleTransformationMode
JavaScript Dynamsoft.DBR.EnumGrayscaleTransformationMode
Python class EnumGrayscaleTransformationMode(IntEnum)
Java / Android class EnumGrayscaleTransformationMode
ObjC / Swift enum EnumGrayscaleTransformationMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description
GTM_SKIP EnumGrayscaleTransformationModeSkip skip 0x00 Skips grayscale transformation.
GTM_INVERTED EnumGrayscaleTransformationModeInverted inverted 0x01 Transforms to inverted grayscale. Recommended for light on dark images.
GTM_ORIGINAL EnumGrayscaleTransformationModeOriginal original 0x02 Keeps the original grayscale. Recommended for dark on light images.

ImagePreprocessingMode

Describes the image preprocessing mode.

Declarations

Language Declaration
C / C++ enum ImagePreprocessingMode
.Net enum Dynamsoft.DBR.EnumImagePreprocessingMode
JavaScript Dynamsoft.DBR.EnumImagePreprocessingMode
Python class EnumImagePreprocessingMode(IntEnum)
Java / Android class EnumImagePreprocessingMode
ObjC / Swift enum EnumImagePreprocessingMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description Valid Argument(s)
IPM_SKIP EnumImagePreprocessingModeSkip skip 0x00 Skips image preprocessing. N/A
IPM_AUTO EnumImagePreprocessingModeAuto auto 0x01 Not supported yet. N/A
IPM_GENERAL EnumImagePreprocessingModeGeneral general 0x02 Takes the unpreprocessed image for following operations. N/A
IPM_GRAY_EQUALIZE EnumImagePreprocessingModeGrayEqualize grayEqualize 0x04 Preprocesses the image using the gray equalization algorithm. Sensitivity
IPM_GRAY_SMOOTH EnumImagePreprocessingModeGraySmooth graySmooth 0x08 Preprocesses the image using the gray smoothing algorithm. SmoothBlockSizeX
SmoothBlockSizeY
IPM_SHARPEN_SMOOTH EnumImagePreprocessingModeSharpenSmooth sharpenSmooth 0x10 Preprocesses the image using the sharpening and smoothing algorithm. SmoothBlockSizeX
SmoothBlockSizeY
SharpenBlockSizeX
SharpenBlockSizeY
IPM_MORPHOLOGY EnumImagePreprocessingModeMorphology morphology 0x20 Preprocesses the image using the morphology algorithm. MorphOperation
MorphShape
MorphOperationKernelSizeX
MorphOperationKernelSizeY

LocalizationMode

Describes the localization mode.

Declarations

Language Declaration
C / C++ enum LocalizationMode
.Net enum Dynamsoft.DBR.EnumLocalizationMode
JavaScript Dynamsoft.DBR.EnumLocalizationMode
Python class EnumLocalizationMode(IntEnum)
Java / Android class EnumLocalizationMode
ObjC / Swift enum EnumLocalizationMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description Valid Argument(s)
LM_SKIP EnumLocalizationModeSkip skip 0x00 Skips localization. N/A
LM_AUTO EnumLocalizationModeAuto auto 0x01 Not supported yet. N/A
LM_CONNECTED_BLOCKS EnumLocalizationModeConnectedBlocks connectedBlocks 0x02 Localizes barcodes by searching for connected blocks. This algorithm usually gives best result and it is recommended to set ConnectedBlocks to the highest priority. N/A
LM_STATISTICS EnumLocalizationModeStatistics statistics 0x04 Localizes barcodes by groups of contiguous black-white regions. This is optimized for QRCode and DataMatrix. N/A
LM_LINES EnumLocalizationModeLines lines 0x08 Localizes barcodes by searching for groups of lines. This is optimized for 1D and PDF417 barcodes. N/A
LM_SCAN_DIRECTLY EnumLocalizationModeScanDirectly scanDirectly 0x10 Localizes barcodes quickly. This mode is recommended in interactive scenario. ScanStride
ScanDirection
LM_STATISTICS_MARKS EnumLocalizationModeStatisticsMarks statisticsMarks 0x20 Localizes barcodes by groups of marks.This is optimized for DPM codes. N/A
LM_STATISTICS_POSTAL_CODE EnumLocalizationModeStatisticsPostalCode statisticsPostalCode 0x40 Localizes barcodes by groups of connected blocks and lines.This is optimized for postal codes. N/A
LM_CENTRE EnumLocalizationModeCentre centre 0x80 Localizes barcodes from the centre of the image. N/A
LM_ONED_FAST_SCAN EnumLocalizationModeOneDFastScan oneDFastScan 0x100 Localizes 1D barcodes in a fast mode. ScanStride
ScanDirection
ConfidenceThreshold

PDFReadingMode

Describes the PDF reading mode.

Declarations

Language Declaration
C / C++ enum PDFReadingMode
.Net enum Dynamsoft.DBR.EnumPDFReadingMode
JavaScript Dynamsoft.DBR.EnumPDFReadingMode
Python class EnumPDFReadingMode(IntEnum)
Java / Android class EnumPDFReadingMode
ObjC / Swift enum EnumPDFReadingMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description
PDFRM_AUTO EnumPDFReadingModeAuto auto 0x01 Lets the library choose the reading mode automatically.
PDFRM_VECTOR EnumPDFReadingModeVector vector 0x02 Detects barcode from vector data in PDF file.
PDFRM_RASTER EnumPDFReadingModeRaster raster 0x04 Converts the PDF file to image(s) first, then perform barcode recognition.

RegionPredetectionMode

Describes the region predetection mode.

Declarations

Language Declaration
C / C++ enum RegionPredetectionMode
.Net enum Dynamsoft.DBR.EnumRegionPredetectionMode
JavaScript Dynamsoft.DBR.EnumRegionPredetectionMode
Python class EnumRegionPredetectionMode(IntEnum)
Java / Android class EnumRegionPredetectionMode
ObjC / Swift enum EnumRegionPredetectionMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description Valid Argument(s)
RPM_SKIP EnumRegionPredetectionModeSkip skip 0x00 Skips region detection. N/A
RPM_AUTO EnumRegionPredetectionModeAuto auto 0x01 Lets the library choose an algorithm automatically to detect region. N/A
RPM_GENERAL EnumRegionPredetectionModeGeneral general 0x02 Takes the whole image as a region. N/A
RPM_GENERAL_RGB_CONTRAST EnumRegionPredetectionModeGeneralRGBContrast generalRGBContrast 0x04 Detects region using the general algorithm based on RGB colour contrast. MinImageDimension
Sensitivity
SpatialIndexBlockSize
RPM_GENERAL_GRAY_CONTRAST EnumRegionPredetectionModeGeneralGrayContrast generalGrayContrast 0x08 Detects region using the general algorithm based on gray contrast. MinImageDimension
Sensitivity
SpatialIndexBlockSize
RPM_GENERAL_HSV_CONTRAST EnumRegionPredetectionModeGeneralHSVContrast generalHSVContrast 0x10 Detects region using the general algorithm based on HSV colour contrast. AspectRatioRange
FindAccurateBoundary
ForeAndBackgroundColours
HeightRange
MinImageDimension
RelativeBarcodeRegions
Sensitivity
SpatialIndexBlockSize
WidthRange

ScaleUpMode

Describes the scale up mode.

Declarations

Language Declaration
C / C++ enum ScaleUpMode
.Net enum Dynamsoft.DBR.EnumScaleUpMode
JavaScript Dynamsoft.DBR.EnumScaleUpMode
Python class EnumScaleUpMode(IntEnum)
Java / Android class EnumScaleUpMode
ObjC / Swift enum EnumScaleUpMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description Valid Argument(s)
SUM_SKIP EnumScaleUpModeSkip skip 0x00 Skip the scale-up process. N/A
SUM_AUTO EnumScaleUpModeAuto auto 0x01 The library chooses an interpolation method automatically to scale up. N/A
SUM_LINEAR_INTERPOLATION EnumScaleUpModeLinearInterpolation linearInterpolation 0x02 Scales up using the linear interpolation method. AcuteAngleWithXThreshold
ModuleSizeThreshold
TargetModuleSize
SUM_NEAREST_NEIGHBOUR_INTERPOLATION EnumScaleUpModeNearestNeighbourInterpolation nearestNeighbourInterpolation 0x04 Scales up using the nearest-neighbour interpolation method. AcuteAngleWithXThreshold
ModuleSizeThreshold
TargetModuleSize

TerminatePhase

Describes the terminate phase.

Declarations

Language Declaration
C / C++ enum TerminatePhase
.Net enum Dynamsoft.DBR.EnumTerminatePhase
JavaScript Dynamsoft.DBR.EnumTerminatePhase
Python class EnumTerminatePhase(IntEnum)
Java / Android class EnumTerminatePhase
ObjC / Swift enum EnumTerminatePhase

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description
TP_REGION_PREDETECTED EnumTerminatePhasePredetected predetected 0x01 Exits the barcode reading algorithm after the region predetection is done.
TP_IMAGE_PREPROCESSED EnumTerminatePhasePreprocecessed preprocecessed 0x02 Exits the barcode reading algorithm after the region predetection and image pre-processing is done.
TP_IMAGE_BINARIZED EnumTerminatePhaseBinarized binarized 0x04 Exits the barcode reading algorithm after the region predetection, image pre-processing, and image binarization are done.
TP_BARCODE_LOCALIZED EnumTerminatePhaseLocalized localized 0x08 Exits the barcode reading algorithm after the region predetection, image pre-processing, image binarization, and barcode localization are done.
TP_BARCODE_TYPE_DETERMINED EnumTerminatePhaseDetermined determined 0x10 Exits the barcode reading algorithm after the region predetection, image pre-processing, image binarization, barcode localization, and barcode type determining are done.
TP_BARCODE_RECOGNIZED EnumTerminatePhaseRecognized recognized 0x20 Exits the barcode reading algorithm after the region predetection, image pre-processing, image binarization, barcode localization, barcode type determining, and barcode recognition are done.

TextFilterMode

Describes the text filter mode.

Declarations

Language Declaration
C / C++ enum TextFilterMode
.Net enum Dynamsoft.DBR.EnumTextFilterMode
JavaScript Dynamsoft.DBR.EnumTextFilterMode
Python class EnumTextFilterMode(IntEnum)
Java / Android class EnumTextFilterMode
ObjC / Swift enum EnumTextFilterMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description Valid Argument(s)
TFM_SKIP EnumTextFilterModeSkip skip 0x00 Skip the text filtering. N/A
TFM_AUTO EnumTextFilterModeAuto auto 0x01 Not supported yet. N/A
TFM_GENERAL_CONTOUR EnumTextFilterModeGeneralContour generalContour 0x02 Filters text using the general algorithm based on contour. MinImageDimension
Sensitivity

TextureDetectionMode

Describes the texture detection mode.

Declarations

Language Declaration
C / C++ enum TextureDetectionMode
.Net enum Dynamsoft.DBR.EnumTextureDetectionMode
JavaScript Dynamsoft.DBR.EnumTextureDetectionMode
Python class EnumTextureDetectionMode(IntEnum)
Java / Android class EnumTextureDetectionMode
ObjC / Swift enum EnumTextureDetectionMode

Members

Member (except ObjC/Swift) Member (ObjC) Member (Swift) Value Description Valid Argument(s)
TDM_SKIP EnumTextureDetectionModeSkip skip 0x00 Skips texture detection. N/A
TDM_AUTO EnumTextureDetectionModeAuto auto 0x01 Not supported yet. N/A
TDM_GENERAL_WIDTH_CONCENTRATION EnumTextureDetectionModeGeneralWidthConcentration generalWidthConcentration 0x02 Detects texture using the general algorithm. Sensitivity

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article: