Dev Center
Table of contents

.Net API Reference

BarcodeReader Class

BarcodeReader Attributes

Attribute Description
ProductKeys Product keys used for Dynamsoft Barcode Reader.

Constructor and Destructor

Method Description
BarcodeReader Constructor of BarcodeReader object.
Dispose Destroys an instance of Dynamsoft Barcode Reader.
GetInstance Creates an instance of Dynamsoft Barcode Reader.
Recycle Destroys an instance of Dynamsoft Barcode Reader.

License Methods

Method Description
InitLicense Initializes license key and activate the SDK.
GetDeviceUUID Gets the device uuid used for license activating.
IsInstanceValid Gets whether the instance is valid when charging by concurrent instances count.
SetDeviceFriendlyName Sets a human-readable name that identifies the device.
SetLicenseCachePath Sets a directory path for saving the license cache.
SetMaxConcurrentInstanceCount Sets the max concurrent instance count used for current device and process.
GetInstancePoolStatus Gets a class to represent the status of an instance pool
GetIdleInstancesCount Deprecated
InitLicenseFromServer Deprecated
InitLicenseFromLicenseContent Deprecated
OutputLicenseToString Deprecated
InitDLSConnectionParameters Deprecated
InitLicenseFromDLS Deprecated
InitLTSConnectionParameters Deprecated
InitLicenseFromLTS Deprecated

Decode Methods

Method Description
DecodeFile Decodes barcodes from a specified image file.
DecodeFileInMemory Decode barcodes from an image file in memory.
DecodeBuffer Decodes barcodes from the memory buffer containing image pixels in defined format.
DecodeBase64String Decodes barcodes from a base64 encoded string.
DecodeBitmap Decodes barcode from a bitmap.
InitIntermediateResult Inits an intermediateResult struct with default values.
DecodeIntermediateResults Decodes barcode from intermediate results.

Basic Settings Methods

Method Description
SetModeArgument Sets the optional argument for a specified mode in Modes parameters.
GetModeArgument Gets the optional argument for a specified mode in Modes parameters.
GetRuntimeSettings Gets current runtime settings.
UpdateRuntimeSettings Update runtime settings with a given struct.
ResetRuntimeSettings Resets all parameters to default values.

Advanced Settings Methods

Method Description
InitRuntimeSettingsWithFile Initializes runtime settings with the settings in a given JSON file.
InitRuntimeSettingsWithString Initializes runtime settings with the settings in a given JSON string.
AppendTplFileToRuntimeSettings Appends a new template file to the current runtime settings.
AppendTplStringToRuntimeSettings Appends a new template string to the current runtime settings.
GetAllParameterTemplateNames Gets the parameter templates name array.
OutputSettingsToFile Outputs runtime settings to a settings file (JSON file).
OutputSettingsToString Outputs runtime settings to a string.

General Methods

Method Description
GetVersion Gets version information of SDK.
TransformCoordinates Transform the coordinates of a point based on the given transformation matrix.

Video Methods

Decode

Method Description
StartFrameDecoding Starts a new thread to decode barcodes from the inner frame queue.
StartFrameDecodingEx Starts a new thread to decode barcodes from the inner frame queue.
AppendFrame Appends a frame image buffer to the inner frame queue.
StopFrameDecoding Stops the frame decoding thread created by StartFrameDecoding.

Parameter

Method Description
InitFrameDecodingParameters Initializes frame decoding parameters.

Callback

Method Description
SetErrorCallback Set callback function to process errors which is triggered when the library finishes decoding a frame.
SetTextResultCallback Set callback function to process text results which is triggered when the library finishes decoding a frame.
SetUniqueBarcodeCallback Set callback function to process text results which is triggered when the library finishes decoding a frame and finds unique barcodes.
SetIntermediateResultCallback Set callback function to process intermediate results which is triggered when the library finishes decoding a frame.

Status retrieval

Method Description
GetLengthOfFrameQueue Gets length of current inner frame queue.

Result Methods

Method Description
GetIntermediateResults Returns intermediate results containing the original image, the colour clustered image, the binarized Image, contours, Lines, TextBlocks, etc.

Auxiliary Classes

Structs

Enumerations

Format Enumeration

Enumeration Description
BarcodeFormat Describes the barcode types in BarcodeFormat group 1.
BarcodeFormat_2 Describes the barcode types in BarcodeFormat group 2.

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.
Enumeration Description
IMResultDataType Describes the intermediate result data type.
IntermediateResultSavingMode Describes the intermediate result saving mode.
IntermediateResultType Describes the intermediate result type.
ResultCoordinateType Describes the result coordinate type.
ResultType Describes the extended result type.
TextResultOrderMode Describes the text result order mode.

Frame Decoding Enumeration

Enumeration Description
ClarityCalculationMethod Describes the clarity calculation method.
ClarityFilterMode Describes the clarity filter mode.

Other Enumeration

Enumeration Description
DM_ChargeWay Deprecated
DM_DeploymentType Deprecated
DM_LicenseModule Deprecated
DM_UUIDGenerationMethod Deprecated
ImagePixelFormat Describes the image pixel format.
QRCodeErrorCorrectionLevel Describes the QR Code error correction level.
Product Deprecated

Error Code

Delegates

Delegate Description
CB_Error Represents the method that will handle the error code returned by the SDK.
CB_IntermediateResult Represents the method that will handle the intermediate result array returned by the SDK.
CB_TextResult Represents the method that will handle the text result array returned by the SDK.

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

In this article:

version 9.6.40

  • Latest version
  • Version 10.x
    • Version 10.2.0
    • Version 10.0.20
    • Version 10.0.10
    • Version 10.0.0
  • Version 9.x
    • Version 9.6.40
    • Version 9.6.30
    • Version 9.6.20
    • Version 9.6.10
    • Version 9.6.0
    • Version 9.4.0
    • Version 9.2.0
    • Version 9.0.0
  • Version 8.x
    • Version 8.8.0
    • Version 8.6.0
    • Version 8.4.0
    • Version 8.2.0
    • Version 8.1.2
    • Version 8.1.0
    • Version 8.0.0
  • Version 7.x
    • Version 7.6.0
    • Version 7.5.0
Change +