Dynamsoft Barcode Reader - API Reference
Classes | Enumerations | Functions
Dynamsoft.Barcode Namespace Reference

namespace of Dynamsoft Barcode Reader. More...

Classes

class  AztecDetails
 Stores the Aztec details More...
 
class  BarcodeReader
 Defines a class that provides functions for decoding barcodes in images. This is the main interface for recognizing barcodes. More...
 
class  BarcodeReaderException
 The exception class of Dynamsoft.BarcodeReader. More...
 
class  Contour
 Stores the contour More...
 
class  DataMatrixDetails
 Stores the DataMatrix details More...
 
class  ExtendedResult
 Stores the extended result. More...
 
class  FrameDecodingParameters
 Configures the frame decoding Parameters. More...
 
struct  FurtherModes
 Stores the FurtherModes. More...
 
class  ImageData
 Stores the image data More...
 
class  IntermediateResult
 Stores the Intermediate Result More...
 
class  LineSegment
 Stores the line segment More...
 
class  LocalizationResult
 Stores the localization results More...
 
class  OneDCodeDetails
 Stores the OneD code details More...
 
class  PDF417Details
 Stores the PDF417 details More...
 
struct  PublicRuntimeSettings
 Defines a struct to configure the barcode reading runtime settings.
These settings are used to control the barcode recognition process such as which barcode types are to be decoded. More...
 
class  QRCodeDetails
 Stores the QRCode details More...
 
class  Quadrilateral
 Stores the quadrilateral More...
 
struct  RegionDefinition
 Stores the region info. More...
 
class  RegionOfInterest
 Stores the region of interest More...
 
class  SamplingImageData
 Stores the sampling image data More...
 
class  TextResult
 Stores the text results including the barcode type, barcode text, bytes and localization result. More...
 

Enumerations

enum  EnumErrorCode {
  EnumErrorCode.DBRERR_DOTCODE_LICENSE_INVALID = -10061, EnumErrorCode.DBRERR_GS1_COMPOSITE_LICENSE_INVALID = -10059, EnumErrorCode.DBRERR_GS1_DATABAR_LICENSE_INVALID = -10058, EnumErrorCode.DBRERR_MAXICODE_LICENSE_INVALID = -10057,
  EnumErrorCode.DBRERR_IRT_LICENSE_INVALID = -10056, EnumErrorCode.DBRERR_GET_MODE_ARGUMENT_ERROR = -10055, EnumErrorCode.DBRERR_LICENSE_DEVICE_RUNS_OUT = -10054, EnumErrorCode.DBRERR_LICENSE_KEY_INVALID = -10053,
  EnumErrorCode.DBRERR_LICENSE_CONTENT_INVALID = -10052, EnumErrorCode.DBRERR_SET_MODE_ARGUMENT_ERROR = -10051, EnumErrorCode.DBRERR_STOP_DECODING_THREAD_FAILED = -10050, EnumErrorCode.DBRERR_FRAME_DECODING_THREAD_EXISTS = -10049,
  EnumErrorCode.DBRERR_DPM_LICENSE_INVALID = -10048, EnumErrorCode.DBRERR_POSTALCODE_LICENSE_INVALID = -10047, EnumErrorCode.DBRERR_PATCHCODE_LICENSE_INVALID = -10046, EnumErrorCode.DBRERR_LICENSE_INIT_FAILED = -10045,
  EnumErrorCode.DBRERR_REQUESTED_FAILED = -10044, EnumErrorCode.DBRERR_LICENSEKEY_NOT_MATCHED = -10043, EnumErrorCode.DBRERR_LICENSE_DLL_MISSING = -10042, EnumErrorCode.DBRERR_AZTEC_LICENSE_INVALID = -10041,
  EnumErrorCode.DBRERR_RESERVEDINFO_NOT_MATCHED = -10040, EnumErrorCode.DBRERR_DOMAIN_NOT_MATCHED = -10039, EnumErrorCode.DBRERR_PARAMETER_VALUE_INVALID = -10038, EnumErrorCode.DBRERR_JSON_NAME_REFERENCE_INVALID = -10037,
  EnumErrorCode.DBRERR_TEMPLATE_NAME_INVALID = -10036, EnumErrorCode.DBRERR_JSON_NAME_VALUE_DUPLICATED = -10035, EnumErrorCode.DBRERR_JSON_NAME_KEY_MISSING = -10034, EnumErrorCode.DBRERR_JSON_VALUE_INVALID = -10033,
  EnumErrorCode.DBRERR_JSON_KEY_INVALID = -10032, EnumErrorCode.DBRERR_JSON_TYPE_INVALID = -10031, EnumErrorCode.DBRERR_JSON_PARSE_FAILED = -10030, EnumErrorCode.DBRERR_RECOGNITION_TIMEOUT = -10026,
  EnumErrorCode.DBRERR_CUSTOM_MODULESIZE_INVALID = -10025, EnumErrorCode.DBRERR_CUSTOM_SIZE_INVALID = -10024, EnumErrorCode.DBRERR_PAGE_NUMBER_INVALID = -10023, EnumErrorCode.DBRERR_PDF_DLL_MISSING = -10022,
  EnumErrorCode.DBRERR_PDF_READ_FAILED = -10021, EnumErrorCode.DBRERR_DATAMATRIX_LICENSE_INVALID = -10020, EnumErrorCode.DBRERR_PDF417_LICENSE_INVALID = -10019, EnumErrorCode.DBRERR_DIB_BUFFER_INVALID = -10018,
  EnumErrorCode.DBRERR_1D_LICENSE_INVALID = -10017, EnumErrorCode.DBRERR_QR_LICENSE_INVALID = -10016, EnumErrorCode.DBRERR_TIFF_READ_FAILED = -10013, EnumErrorCode.DBRERR_IMAGE_READ_FAILED = -10012,
  EnumErrorCode.DBRERR_MAX_BARCODE_NUMBER_INVALID = -10011, EnumErrorCode.DBRERR_CUSTOM_REGION_INVALID = -10010, EnumErrorCode.DBRERR_BARCODE_FORMAT_INVALID = -10009, EnumErrorCode.DBRERR_INDEX_INVALID = -10008,
  EnumErrorCode.DBRERR_BPP_NOT_SUPPORTED = -10007, EnumErrorCode.DBRERR_FILETYPE_NOT_SUPPORTED = -10006, EnumErrorCode.DBRERR_FILE_NOT_FOUND = -10005, EnumErrorCode.DBRERR_LICENSE_EXPIRED = -10004,
  EnumErrorCode.DBRERR_LICENSE_INVALID = -10003, EnumErrorCode.DBRERR_NULL_POINTER = -10002, EnumErrorCode.DBRERR_NO_MEMORY = -10001, EnumErrorCode.DBRERR_UNKNOWN = -10000,
  EnumErrorCode.DBR_SUCCESS = 0, EnumErrorCode.DBR_SYSTEM_EXCEPTION = 1, EnumErrorCode.DBRERR_LOAD_MODULE_DLL_FAILED = 2
}
 Describes error codes. More...
 
enum  EnumBarcodeFormat {
  EnumBarcodeFormat.BF_ALL = -32505857, EnumBarcodeFormat.BF_ONED = 0x000007FF, EnumBarcodeFormat.BF_GS1_DATABAR = 0x0003F800, EnumBarcodeFormat.BF_CODE_39 = 0x1,
  EnumBarcodeFormat.BF_CODE_128 = 0x2, EnumBarcodeFormat.BF_CODE_93 = 0x4, EnumBarcodeFormat.BF_CODABAR = 0x8, EnumBarcodeFormat.BF_ITF = 0x10,
  EnumBarcodeFormat.BF_EAN_13 = 0x20, EnumBarcodeFormat.BF_EAN_8 = 0x40, EnumBarcodeFormat.BF_UPC_A = 0x80, EnumBarcodeFormat.BF_UPC_E = 0x100,
  EnumBarcodeFormat.BF_INDUSTRIAL_25 = 0x200, EnumBarcodeFormat.BF_CODE_39_EXTENDED = 0x400, EnumBarcodeFormat.BF_GS1_DATABAR_OMNIDIRECTIONAL = 0x800, EnumBarcodeFormat.BF_GS1_DATABAR_TRUNCATED = 0x1000,
  EnumBarcodeFormat.BF_GS1_DATABAR_STACKED = 0x2000, EnumBarcodeFormat.BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL = 0x4000, EnumBarcodeFormat.BF_GS1_DATABAR_EXPANDED = 0x8000, EnumBarcodeFormat.BF_GS1_DATABAR_EXPANDED_STACKED = 0x10000,
  EnumBarcodeFormat.BF_GS1_DATABAR_LIMITED = 0x20000, EnumBarcodeFormat.BF_PATCHCODE = 0x00040000, EnumBarcodeFormat.BF_PDF417 = 0x2000000, EnumBarcodeFormat.BF_QR_CODE = 0x4000000,
  EnumBarcodeFormat.BF_DATAMATRIX = 0x8000000, EnumBarcodeFormat.BF_AZTEC = 0x10000000, EnumBarcodeFormat.BF_MAXICODE = 0x20000000, EnumBarcodeFormat.BF_MICRO_QR = 0x40000000,
  EnumBarcodeFormat.BF_MICRO_PDF417 = 0x00080000, EnumBarcodeFormat.BF_GS1_COMPOSITE = -2147483648, EnumBarcodeFormat.BF_NULL = 0
}
 Describes the barcode types in BarcodeFormat group 1. All the formats can be combined, such as BF_CODE_39 | BF_CODE_128. Note: The barcode format our library will search for is composed of BarcodeFormat group 1 and BarcodeFormat group 2, so you need to specify the barcode format in group 1 and group 2 individually. More...
 
enum  EnumBarcodeFormat_2 {
  EnumBarcodeFormat_2.BF2_NULL = 0, EnumBarcodeFormat_2.BF2_POSTALCODE = 0x01F00000, EnumBarcodeFormat_2.BF2_NONSTANDARD_BARCODE = 0X01, EnumBarcodeFormat_2.BF2_USPSINTELLIGENTMAIL = 0x00100000,
  EnumBarcodeFormat_2.BF2_POSTNET = 0x00200000, EnumBarcodeFormat_2.BF2_PLANET = 0x00400000, EnumBarcodeFormat_2.BF2_AUSTRALIANPOST = 0x00800000, EnumBarcodeFormat_2.BF2_RM4SCC = 0x01000000,
  EnumBarcodeFormat_2.BF2_DOTCODE = 0x02
}
 Describes the barcode types in BarcodeFormat group 2. Note: The barcode format our library will search for is composed of BarcodeFormat group 1 and BarcodeFormat group 2, so you need to specify the barcode format in group 1 and group 2 individually. More...
 
enum  EnumConflictMode { EnumConflictMode.CM_IGNORE = 1, EnumConflictMode.CM_OVERWRITE = 2 }
 Describes the conflict mode. More...
 
enum  EnumImagePixelFormat {
  EnumImagePixelFormat.IPF_BINARY, EnumImagePixelFormat.IPF_BINARY_INVERTED, EnumImagePixelFormat.IPF_GRAYSCALED, EnumImagePixelFormat.IPF_NV21,
  EnumImagePixelFormat.IPF_RGB_565, EnumImagePixelFormat.IPF_RGB_555, EnumImagePixelFormat.IPF_RGB_888, EnumImagePixelFormat.IPF_ARGB_8888,
  EnumImagePixelFormat.IPF_RGB_161616, EnumImagePixelFormat.IPF_ARGB_16161616, EnumImagePixelFormat.IPF_ABGR_8888, EnumImagePixelFormat.IPF_ABGR_16161616,
  EnumImagePixelFormat.IPF_BGR_888
}
 Describes the image pixel format. More...
 
enum  EnumResultType { EnumResultType.RT_STANDARD_TEXT, EnumResultType.RT_RAW_TEXT, EnumResultType.RT_CANDIDATE_TEXT, EnumResultType.RT_PARTIAL_TEXT }
 Describes the extended result type. More...
 
enum  EnumTerminatePhase {
  EnumTerminatePhase.TP_REGION_PREDETECTED = 0x01, EnumTerminatePhase.TP_IMAGE_PREPROCESSED = 0x02, EnumTerminatePhase.TP_IMAGE_BINARIZED = 0x04, EnumTerminatePhase.TP_BARCODE_LOCALIZED = 0x08,
  EnumTerminatePhase.TP_BARCODE_TYPE_DETERMINED = 0x10, EnumTerminatePhase.TP_BARCODE_RECOGNIZED = 0x20
}
 Describes the terminate phase. More...
 
enum  EnumIMResultDataType {
  EnumIMResultDataType.IMRDT_IMAGE = 0x01, EnumIMResultDataType.IMRDT_CONTOUR = 0x02, EnumIMResultDataType.IMRDT_LINESEGMENT = 0x04, EnumIMResultDataType.IMRDT_LOCALIZATIONRESULT = 0x08,
  EnumIMResultDataType.IMRDT_REGIONOFINTEREST = 0x10, EnumIMResultDataType.IMRDT_QUADRILATERAL = 0x20
}
 Describes the intermediate result data type. More...
 
enum  EnumQRCodeErrorCorrectionLevel { EnumQRCodeErrorCorrectionLevel.QRECL_ERROR_CORRECTION_H, EnumQRCodeErrorCorrectionLevel.QRECL_ERROR_CORRECTION_L, EnumQRCodeErrorCorrectionLevel.QRECL_ERROR_CORRECTION_M, EnumQRCodeErrorCorrectionLevel.QRECL_ERROR_CORRECTION_Q }
 Describes the QR Code error correction level. More...
 
enum  EnumBarcodeComplementMode { EnumBarcodeComplementMode.BCM_AUTO = 0x01, EnumBarcodeComplementMode.BCM_GENERAL = 0x02, EnumBarcodeComplementMode.BCM_REV = -2147483648, EnumBarcodeComplementMode.BCM_SKIP = 0x00 }
 Describes the barcode complement mode. More...
 
enum  EnumBarcodeColourMode {
  EnumBarcodeColourMode.BICM_DARK_ON_LIGHT = 0x01, EnumBarcodeColourMode.BICM_LIGHT_ON_DARK = 0x02, EnumBarcodeColourMode.BICM_DARK_ON_DARK = 0x04, EnumBarcodeColourMode.BICM_LIGHT_ON_LIGHT = 0x08,
  EnumBarcodeColourMode.BICM_DARK_LIGHT_MIXED = 0x10, EnumBarcodeColourMode.BICM_DARK_ON_LIGHT_DARK_SURROUNDING = 0x20, EnumBarcodeColourMode.BICM_REV = -2147483648, EnumBarcodeColourMode.BICM_SKIP = 0x00
}
 Describes the barcode colour mode. More...
 
enum  EnumBinarizationMode {
  EnumBinarizationMode.BM_AUTO = 0x01, EnumBinarizationMode.BM_LOCAL_BLOCK = 0x02, EnumBinarizationMode.BM_THRESHOLD = 0x04, EnumBinarizationMode.BM_REV = -2147483648,
  EnumBinarizationMode.BM_SKIP = 0x00
}
 Describes the binarization mode. More...
 
enum  EnumColourClusteringMode { EnumColourClusteringMode.CCM_AUTO = 0x01, EnumColourClusteringMode.CCM_GENERAL_HSV = 0x02, EnumColourClusteringMode.CCM_REV = -2147483648, EnumColourClusteringMode.CCM_SKIP = 0x00 }
 Describes the colour clustering mode. Not supported yet. More...
 
enum  EnumColourConversionMode { EnumColourConversionMode.CICM_GENERAL = 0x01, EnumColourConversionMode.CICCM_REV = -2147483648, EnumColourConversionMode.CICM_SKIP = 0x00 }
 Describes the colour conversion mode. More...
 
enum  EnumDPMCodeReadingMode { EnumDPMCodeReadingMode.DPMCRM_AUTO = 0x01, EnumDPMCodeReadingMode.DPMCRM_GENERAL = 0x02, EnumDPMCodeReadingMode.DPMCRM_REV = -2147483648, EnumDPMCodeReadingMode.DPMCRM_SKIP = 0x00 }
 Describes the DPM code reading mode. More...
 
enum  EnumImagePreprocessingMode {
  EnumImagePreprocessingMode.IPM_AUTO = 0x01, EnumImagePreprocessingMode.IPM_GENERAL = 0x02, EnumImagePreprocessingMode.IPM_GRAY_EQUALIZE = 0x04, EnumImagePreprocessingMode.IPM_GRAY_SMOOTH = 0x08,
  EnumImagePreprocessingMode.IPM_SHARPEN_SMOOTH = 0x10, EnumImagePreprocessingMode.IPM_MORPHOLOGY = 0x20, EnumImagePreprocessingMode.IPM_REV = -2147483648, EnumImagePreprocessingMode.IPM_SKIP = 0x00
}
 Describes the image preprocessing mode. More...
 
enum  EnumIntermediateResultType {
  EnumIntermediateResultType.IRT_NO_RESULT = 0x00, EnumIntermediateResultType.IRT_ORIGINAL_IMAGE = 0x01, EnumIntermediateResultType.IRT_COLOUR_CLUSTERED_IMAGE = 0x02, EnumIntermediateResultType.IRT_COLOUR_CONVERTED_GRAYSCALE_IMAGE = 0x04,
  EnumIntermediateResultType.IRT_TRANSFORMED_GRAYSCALE_IMAGE = 0x08, EnumIntermediateResultType.IRT_PREDETECTED_REGION = 0x10, EnumIntermediateResultType.IRT_PREPROCESSED_IMAGE = 0x20, EnumIntermediateResultType.IRT_BINARIZED_IMAGE = 0x40,
  EnumIntermediateResultType.IRT_TEXT_ZONE = 0x80, EnumIntermediateResultType.IRT_CONTOUR = 0x100, EnumIntermediateResultType.IRT_LINE_SEGMENT = 0x200, EnumIntermediateResultType.IRT_FORM = 0x400,
  EnumIntermediateResultType.IRT_SEGMENTATION_BLOCK = 0x800, EnumIntermediateResultType.IRT_TYPED_BARCODE_ZONE = 0x1000, EnumIntermediateResultType.IRT_PREDETECTED_QUADRILATERAL = 0X2000
}
 Describes the intermediate result type. More...
 
enum  EnumLocalizationMode {
  EnumLocalizationMode.LM_AUTO = 0x01, EnumLocalizationMode.LM_CONNECTED_BLOCKS = 0x02, EnumLocalizationMode.LM_STATISTICS = 0x04, EnumLocalizationMode.LM_LINES = 0x08,
  EnumLocalizationMode.LM_SCAN_DIRECTLY = 0x10, EnumLocalizationMode.LM_STATISTICS_MARKS = 0x20, EnumLocalizationMode.LM_STATISTICS_POSTAL_CODE = 0x40, EnumLocalizationMode.LM_CENTRE = 0x80,
  EnumLocalizationMode.LM_REV = -2147483648, EnumLocalizationMode.LM_SKIP = 0x00
}
 Describes the localization mode. More...
 
enum  EnumRegionPredetectionMode {
  EnumRegionPredetectionMode.RPM_AUTO = 0x01, EnumRegionPredetectionMode.RPM_GENERAL = 0x02, EnumRegionPredetectionMode.RPM_GENERAL_RGB_CONTRAST = 0x04, EnumRegionPredetectionMode.RPM_GENERAL_GRAY_CONTRAST = 0x08,
  EnumRegionPredetectionMode.RPM_GENERAL_HSV_CONTRAST = 0x10, EnumRegionPredetectionMode.RPM_REV = -2147483648, EnumRegionPredetectionMode.RPM_SKIP = 0x00
}
 Describes the region predetection mode. More...
 
enum  EnumDeformationResistingMode { EnumDeformationResistingMode.DRM_AUTO = 0x01, EnumDeformationResistingMode.DRM_GENERAL = 0x02, EnumDeformationResistingMode.DRM_REV = -2147483648, EnumDeformationResistingMode.DRM_SKIP = 0x00 }
 Describes the deformation resisting mode. More...
 
enum  EnumTextAssistedCorrectionMode {
  EnumTextAssistedCorrectionMode.TACM_AUTO = 0x01, EnumTextAssistedCorrectionMode.TACM_VERIFYING = 0x02, EnumTextAssistedCorrectionMode.TACM_VERIFYING_PATCHING = 0x04, EnumTextAssistedCorrectionMode.TACM_REV = -2147483648,
  EnumTextAssistedCorrectionMode.TACM_SKIP = 0x00
}
 Describes the text assisted correction mode. More...
 
enum  EnumIntermediateResultSavingMode { EnumIntermediateResultSavingMode.IRSM_MEMORY = 0x01, EnumIntermediateResultSavingMode.IRSM_FILESYSTEM = 0x02, EnumIntermediateResultSavingMode.IRSM_BOTH = 0x04 }
 Describes the intermediate result saving mode. More...
 
enum  EnumTextFilterMode { EnumTextFilterMode.TFM_AUTO = 0x01, EnumTextFilterMode.TFM_GENERAL_CONTOUR = 0x02, EnumTextFilterMode.TFM_REV = -2147483648, EnumTextFilterMode.TFM_SKIP = 0x00 }
 Describes the text filter mode. More...
 
enum  EnumTextResultOrderMode {
  EnumTextResultOrderMode.TROM_CONFIDENCE = 0x01, EnumTextResultOrderMode.TROM_POSITION = 0x02, EnumTextResultOrderMode.TROM_FORMAT = 0x04, EnumTextResultOrderMode.TROM_REV = -2147483648,
  EnumTextResultOrderMode.TROM_SKIP = 0x00
}
 Describes the text result order mode. More...
 
enum  EnumTextureDetectionMode { EnumTextureDetectionMode.TDM_AUTO = 0X01, EnumTextureDetectionMode.TDM_GENERAL_WIDTH_CONCENTRATION = 0X02, EnumTextureDetectionMode.TDM_REV = -2147483648, EnumTextureDetectionMode.TDM_SKIP = 0x00 }
 Describes the texture detection mode. More...
 
enum  EnumGrayscaleTransformationMode { EnumGrayscaleTransformationMode.GTM_INVERTED = 0x01, EnumGrayscaleTransformationMode.GTM_ORIGINAL = 0x02, EnumGrayscaleTransformationMode.GTM_REV = -2147483648, EnumGrayscaleTransformationMode.GTM_SKIP = 0x00 }
 Describes the grayscale transformation mode. More...
 
enum  EnumResultCoordinateType { EnumResultCoordinateType.RCT_PIXEL = 0x01, EnumResultCoordinateType.RCT_PERCENTAGE = 0x02 }
 Describes the result coordinate type. More...
 
enum  EnumScaleUpMode {
  EnumScaleUpMode.SUM_AUTO = 0X01, EnumScaleUpMode.SUM_LINEAR_INTERPOLATION = 0x02, EnumScaleUpMode.SUM_NEAREST_NEIGHBOUR_INTERPOLATION = 0x04, EnumScaleUpMode.SUM_REV = -2147483648,
  EnumScaleUpMode.SUM_SKIP = 0x00
}
 Describes the scale up mode More...
 
enum  EnumAccompanyingTextRecognitionMode { EnumAccompanyingTextRecognitionMode.ATRM_GENERAL = 0X01, EnumAccompanyingTextRecognitionMode.ATRM_REV = -2147483648, EnumAccompanyingTextRecognitionMode.ATRM_SKIP = 0x00 }
 Describes the accompanying text recognition mode. More...
 
enum  EnumClarityCalculationMethod { EnumClarityCalculationMethod.ECCM_CONTRAST = 0x01 }
 Describes the clarity calculation method. More...
 
enum  EnumClarityFilterMode { EnumClarityFilterMode.CFM_GENERAL = 0x01 }
 Describes the clarity filter mode. More...
 
enum  EnumPDFReadingMode { EnumPDFReadingMode.PDFRM_AUTO = 0x01, EnumPDFReadingMode.PDFRM_VECTOR = 0x02, EnumPDFReadingMode.PDFRM_RASTER = 0x04, EnumPDFReadingMode.PDFRM_REV = -2147483648 }
 Describes the PDF reading mode. More...
 

Functions

delegate void CB_Error (int frameId, int errorCode, IntPtr pUser)
 Represents the method that will handle the error code returned by the SDK. More...
 
delegate void CB_TextResult (int frameId, TextResult[] textResults, IntPtr pUser)
 Represents the method that will handle the text result array returned by the SDK. More...
 
delegate void CB_IntermediateResult (int frameId, IntermediateResult[] intermediateResults, IntPtr pUser)
 Represents the method that will handle the intermediate result array returned by the SDK. More...
 

Detailed Description

namespace of Dynamsoft Barcode Reader.