Global Functions

Initialize and Destroy

Function	Description
DBR_CreateInstance	Create an instance of Dynamsoft Barcode Reader.
DBR_DestroyInstance	Destroy the instance of Dynamsoft Barcode Reader.
DBR_GetInstance	Gets an idle Dynamsoft Barcode Reader instance running on concurrent instance mode.
DBR_RecycleInstance	Recycles a Dynamsoft Barcode Reader instance running on concurrent instance mode.

License

Function	Description
DBR_InitLicense	Initializes license key and activate the SDK.
DBR_GetDeviceUUID	Gets the device uuid used for license activating.
DBR_IsInstanceValid	Gets whether the instance is valid when charging by concurrent instances count.
DBR_SetDeviceFriendlyName	Sets a human-readable name that identifies the device.
DBR_SetLicenseCachePath	Sets a directory path for saving the license cache.
DBR_SetMaxConcurrentInstanceCount	Sets the max concurrent instance count used for current device and process.
DBR_GetIdleInstancesCount	Deprecated
DBR_InitLicenseFromServer	Deprecated
DBR_InitLicenseFromLicenseContent	Deprecated
DBR_OutputLicenseToString	Deprecated
DBR_OutputLicenseToStringPtr	Deprecated
DBR_FreeLicenseString	Deprecated
DBR_InitDLSConnectionParameters	Deprecated
DBR_InitLicenseFromDLS	Deprecated
DBR_InitLTSConnectionParameters	Deprecated
DBR_InitLicenseFromLTS	Deprecated

Decode

Function	Description
DBR_DecodeFile	Decode barcodes from a specified image file.
DBR_DecodeFileInMemory	Decode barcodes from an image file in memory.
DBR_DecodeBuffer	Decode barcodes from raw buffer.
DBR_DecodeImageData	Decode barcodes from source image defined as ImageData.
DBR_DecodeBase64String	Decode barcodes from a base64 encoded string.
DBR_DecodeDIB	Decode barcode from a handle of device-independent bitmap (DIB).
DBR_InitIntermediateResult	Inits an intermediateResult struct with default values.
DBR_DecodeIntermediateResults	Decodes barcode from intermediate results.

Basic Settings Functions

Function	Description
DBR_SetModeArgument	Set argument value for the specified mode parameter.
DBR_GetModeArgument	Get argument value for the specified mode parameter.
DBR_GetRuntimeSettings	Get current runtime settings.
DBR_UpdateRuntimeSettings	Modify and update the current runtime settings.
DBR_ResetRuntimeSettings	Reset runtime settings to default.

Advanced Settings Functions

Function	Description
DBR_InitRuntimeSettingsWithFile	Initialize runtime settings with the settings in a given JSON file.
DBR_InitRuntimeSettingsWithString	Initialize runtime settings with the settings in a given JSON string.
DBR_AppendTplFileToRuntimeSettings	Append a new template file to the current runtime settings.
DBR_AppendTplStringToRuntimeSettings	Append a new template string to the current runtime settings.
DBR_GetParameterTemplateCount	Get the count of the parameter templates.
DBR_GetParameterTemplateName	Get the parameter template name by index.
DBR_OutputSettingsToFile	Output runtime settings to a settings file (JSON file).
DBR_OutputSettingsToString	Output runtime settings to a string.
DBR_OutputSettingsToStringPtr	Output runtime settings to a string.
DBR_FreeSettingsString	Free memory allocated for runtime settings string.

Result

Function	Description
DBR_GetAllTextResults	Get all recognized barcode results.
DBR_FreeTextResults	Free memory allocated for text results.
DBR_GetIntermediateResults	Get intermediate results.
DBR_FreeIntermediateResults	Free memory allocated for the intermediate results.

General

Function	Description
DBR_GetErrorString	Get error message by error code.
DBR_GetVersion	Get version information of SDK.
DBR_TransformCoordinates	Transform the coordinates of a point based on the given transformation matrix.
DBR_FreeString	Free memory allocated for string.

Video

Decode

Function	Description
DBR_StartFrameDecoding	Decode barcodes from inner frame queue.
DBR_StartFrameDecodingEx	Decode barcodes from inner frame queue.
DBR_AppendFrame	Append a frame image buffer to the inner frame queue.
DBR_StopFrameDecoding	Stop thread used for frame decoding.

Parameter

Function	Description
DBR_InitFrameDecodingParameters	Initialize frame decoding parameter.

Callback

Function	Description
DBR_SetErrorCallback	Set callback function to process errors which is triggered when the library finishes decoding a frame.
DBR_SetTextResultCallback	Set callback function to process text results which is triggered when the library finishes decoding a frame.
DBR_SetUniqueBarcodeCallback	Set callback function to process text results which is triggered when the library finishes decoding a frame and finds unique barcodes.
DBR_SetIntermediateResultCallback	Set callback function to process intermediate results which is triggered when the library finishes decoding a frame.

Status retrieval

Function	Description
DBR_GetLengthOfFrameQueue	Get length of current inner frame queue.