MENU
Table of contents

Dynamsoft Barcode Reader SDK - Objective-C & Swift API Reference

 

Attributes

Attribute Type
license NSString*

license

Stores the license used in DynamsoftBarcodeReader.

NSString* license

 

Methods

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.

 

Parameter and Runtime Settings

Basic

Method Description
setModeArgument Set argument value for the specified mode parameter.
getModeArgument Get argument value for the specified mode parameter.
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.

 

License

Method Description
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.

 

Result

Method Description
getIntermediateResult Get 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.

Delegate

Method Description
setDBRErrorDelegate Set callback function to process errors generated during frame decoding.
setDBRTextResultDelegate Set callback function to process text results generated during frame decoding.
setDBRIntermediateResultDelegate Set callback function to process intermediate results generated during frame decoding.

Status retrieval

Method Description
getLengthOfFrameQueue Get length of current inner frame queue.

 

Error Code

 

[Classes]

 

Enumerations

Is this page helpful?

YesYes NoNo

© 2003–2020 Dynamsoft. All rights reserved.
Privacy Statement / Site Map / Home / Purchase / Support