API Overview
Dynamsoft Barcode Reader (DBR) SDK is built on the Dynamsoft Capture Vision (DCV) architecture.
Main APIs
| Category | Library | Description |
|---|---|---|
| Orchestration | DynamsoftCaptureVisionRouter | Core Capture Vision Router APIs for configuring settings, starting or stopping capture, and registering receivers. |
| Input & UI Enhancement | DynamsoftCameraEnhancer | APIs for camera control, image enhancement, and camera UI. |
| Functional Modules | DynamsoftBarcodeReader DynamsoftCodeParser |
APIs for functional modules, mainly for decoded results and result processing. |
| Infrastructure & Utility | DynamsoftLicense DynamsoftCore DynamsoftUtility |
Licensing, basic structures, intermediate results, and utility APIs. |
CaptureVisionRouter
The main class CaptureVisionRouter acts as the SDK entry point and provides the following essential APIs:
Configure Settings
| API | Description |
|---|---|
initSettingsFromFile |
Load settings from a custom template file. |
SimplifiedCaptureVisionSettings |
Access commonly used settings through a SimplifiedCaptureVisionSettings object. |
Start/Stop Capture
| API | Description |
|---|---|
startCapturing |
Start processing input frames with the selected template. |
stopCapturing |
Stop the current capture process. |
Receive Results
Implement CapturedResultReceiver to receive capture results.
| API | Description |
|---|---|
onDecodedBarcodesReceived |
Callback for receiving barcode decoding results as a DecodedBarcodesResult object. |
onParsedResultReceived |
Callback for receiving parsed results as a ParsedResult object. |
onCapturedResultReceived |
Callback for receiving all result types as a CapturedResult object. |
Input - CameraEnhancer
CameraEnhancer is a built-in implementation of ImageSourceAdapter. It combines camera control, image enhancement, and a UI system designed for the Dynamsoft Capture Vision architecture.
Result
| Result | Basic Item | Type |
|---|---|---|
DecodedBarcodesResult |
BarcodeResultItem |
CRIT_BARCODE |
ParsedResult |
ParsedResultItem |
CRIT_PARSED_RESULT |