Download 30-Day Trial GetPricing
Table of contents

iOS API Reference

DynamsoftBarcodeReader Class

Initialize

Method Description
init Create an instance of Dynamsoft Barcode Reader.

Decode

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

Camera Enhancer

Method Description
SetCameraEnhancerParam Set the parameters for Dynamsoft Camera Enhancer in Barcode reader

License

Method Description
license Stores the license used in DynamsoftBarcodeReader.
initWithLicense Read product key and activate the SDK.
initWithLicenseFromServer Initialize license and connect to the specified server for online verification.
outputLicenseToString Output the license content to a string from the license server.
initLicenseFromLTS Initializes the barcode reader license and connects to the specified server for online verification.

Parameter and Runtime Settings

Basic

Method Description
getRuntimeSettings Get current runtime settings.
updateRuntimeSettings Modify and update the current runtime settings.
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
getIntermediateResult Get intermediate results.
createIntermediateResult Inits an intermediateResult struct with default values.
decodeIntermediateResults Decodes barcode from intermediate results.

Video

Decode

Method Description
startFrameDecoding Decode barcodes from inner frame queue.
startFrameDecodingEx Decode barcodes from inner frame queue.
appendFrame Append a frame image buffer to the inner frame queue.
stopFrameDecoding Stop thread used for frame decoding.

Parameter

Method Description
getFrameDecodingParameters Initialize frame decoding parameter.

Status retrieval

Method Description
getLengthOfFrameQueue Get length of current inner frame queue.

Error Code

Auxiliary Classes

Protocol

Protocol Description
DBRTextResultDelegate Protocol for a delegate to handle callback when text result returned.
DBRIntermediateResultDelegate Protocol for a delegate to handle callback when intermediate result returned.
DBRErrorDelegate Protocol for a delegate to handle callback when an error returned.
DBRServerLicenseVerificationDelegate Protocol for a delegate to handle callback when license verification message returned.
DMLTSLicenseVerificationDelegate Protocol for a delegate to handle callback when license verification message returned.

Enumerations

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article: