Download 30-Day Trial GetPricing
Table of contents
Swift
Objective-C

iOS API Reference

DynamsoftBarcodeReader Class

Initialize

Method Description
init Create an instance of Dynamsoft Barcode Reader.

 

Video decoding Methods

Method Description
setCameraEnhancer Bind a Camera Enhancer instance to the Barcode Reader.
startScanning Start the barcode reading thread.
stopScanning Stop the barcode reading thread.
setDBRTextResultListener Set callback function to process text results generated during frame decoding.
setDBRIntermediateResultListener Set callback function to process intermediate results generated during frame decoding.
Property Description
enableResultVerification Enable Result Verification feature to improve the accuracy of barcode results for video streaming barcode decoding.
enableDuplicateFilter Enable Duplicate Filter feature to filter out the duplicate results in the period of 3000ms for video barcode decoding.

Note:

  • setDBRTextResultDelegate is deprecated, please use setDBRTextResultListener instead.
  • setDBRIntermediateResultDelegate is deprecated, please use setDBRIntermediateResultListener instead.

 

Image decoding Methods

Method Description
decodeBuffer Decode barcodes from raw buffer.
decodeFileWithName Decode barcodes from a specified image file.
decodeImage Decode barcodes from an image file in memory.
decodeBase64 Decode barcodes from a base64 encoded string.

 

License

Method Description
initLicense Read product key and activate the SDK.

Note:

The following license activation methods are deprecated:

  • license
  • outputLicenseToString
  • initLicenseFromDLS
  • initWithLicenseFromServer

Please use initLicense to activate the license.

 

Parameter and Runtime Settings

Basic

Method Description
getRuntimeSettings Get current runtime settings.
updateRuntimeSettings (with struct) Modify and update the current runtime settings.
updateRuntimeSettings (with preset template) Update runtime settings from one of the preset templates.
resetRuntimeSettings Reset runtime settings to default.

Advanced

Method Description
initRuntimeSettingsWithFile Initialize runtime settings with the settings in a given JSON file.
initRuntimeSettingsWithString Initialize runtime settings with the settings in a given JSON string.
appendTplFileToRuntimeSettings Append a new template file to the current runtime settings.
appendTplStringToRuntimeSettings Append a new template string to the current runtime settings.
allParameterTemplateNames Get the count of the parameter templates.
outputSettingsToFile Output runtime settings to a settings file (JSON file).
outputSettingsToString Output runtime settings to a string.
setModeArgument Set argument value for the specified mode parameter.
getModeArgument Get argument value for the specified mode parameter.

 

Result

Method Description
createIntermediateResult Inits an intermediateResult struct with default values.
getIntermediateResult Get intermediate results.
decodeIntermediateResults Decodes barcode from intermediate results.

 

Status Retrieval

Method Description
getVersion Get version information of SDK.

 

Auxiliary Classes

Note:

  • iDMDLSConnectionParameters is deprecated due to the update of the license. Please use the method initLicense to activate the license instead.

 

Protocol

Protocol Description
DBRTextResultListener Protocol for a delegate to handle callback when text result returned.
DBRIntermediateResultListener Protocol for a delegate to handle callback when intermediate result returned.
DBRLicenseVerificationDelegate Protocol for a delegate to handle callback when license verification message returned.

Note:

 

Enumerations

Note:

The following Enumerations are deprecated and will be removed in the future.

  • EnumProduct
  • EnumDMChargeWay
  • EnumDMLicenseModule
  • EnumDMUUIDGenerationMethod

 

Others

View the Error Code

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article: