Skip to content

Commit 4c1a13a

Browse files
Update index.md
1 parent eb6595a commit 4c1a13a

1 file changed

Lines changed: 36 additions & 28 deletions

File tree

  • programming/android/api-reference

programming/android/api-reference/index.md

Lines changed: 36 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,7 @@ description: Main API reference page for Dynamsoft Barcode Reader SDK for Androi
55
keywords: BarcodeReader, api reference, Android
66
---
77

8-
# SDK Overview: Modules and Main APIs
9-
10-
This page summarizes the SDK modules and core APIs of Dynamsoft Barcode Reader.
11-
12-
## Modules Summary
8+
# API Overview
139

1410
Dynamsoft Barcode Reader (DBR) SDK is built on the Dynamsoft Capture Vision (DCV) architecture.
1511

@@ -44,8 +40,13 @@ Dynamsoft Barcode Reader (DBR) SDK is built on the Dynamsoft Capture Vision (DCV
4440
</a>
4541
<a href="{{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html">
4642
<rect class="clickable"
47-
x="970" y="310"
48-
width="330" height="230" />
43+
x="1005" y="360"
44+
width="120" height="160" />
45+
</a>
46+
<a href="{{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html">
47+
<rect class="clickable"
48+
x="1150" y="360"
49+
width="120" height="160" />
4950
</a>
5051
<a href="{{ site.dbr_android_api }}">
5152
<rect class="clickable"
@@ -59,51 +60,58 @@ Dynamsoft Barcode Reader (DBR) SDK is built on the Dynamsoft Capture Vision (DCV
5960
</a>
6061
<a href="{{ site.dcvb_android_api }}capture-vision-router/settings.html">
6162
<rect class="clickable"
62-
x="510" y="60"
63-
width="320" height="200" />
63+
x="520" y="90"
64+
width="140" height="170" />
65+
</a>
66+
<a href="{{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html">
67+
<rect class="clickable"
68+
x="680" y="90"
69+
width="140" height="170" />
6470
</a>
6571
</svg>
6672

6773
## Main APIs
6874

6975
| Category | Library | Description |
70-
| -------- | --- | ----------- |
76+
| -------- | ------- | ----------- |
7177
| Orchestration | DynamsoftCaptureVisionRouter | Core Capture Vision Router APIs for configuring settings, starting or stopping capture, and registering receivers. |
72-
| Functional Modules | DynamsoftBarcodeReader<br>DynamsoftCodeParser | APIs for functional modules, mainly for decoded results and result processing. |
7378
| Input & UI Enhancement | DynamsoftCameraEnhancer | APIs for camera control, image enhancement, and camera UI. |
79+
| Functional Modules | DynamsoftBarcodeReader<br>DynamsoftCodeParser | APIs for functional modules, mainly for decoded results and result processing. |
7480
| Infrastructure & Utility | DynamsoftLicense<br>DynamsoftCore<br>DynamsoftUtility | Licensing, basic structures, intermediate results, and utility APIs. |
7581

76-
### Capture Vision Router
82+
### CaptureVisionRouter
7783

7884
The main class [`CaptureVisionRouter`]({{ site.dcvb_android_api }}capture-vision-router/capture-vision-router.html) acts as the SDK entry point and provides the following essential APIs:
7985

80-
- [Set input]({{ site.dcvb_android_api }}capture-vision-router/multiple-file-processing.html#setinput)
81-
- [Configure barcode reader settings]({{ site.dcvb_android_api }}capture-vision-router/settings.html)
82-
- [Add result receiver]({{ site.dcvb_android_api }}capture-vision-router/multiple-file-processing.html#addresultreceiver)
83-
- [Start barcode capture from a video stream]({{ site.dcvb_android_api }}capture-vision-router/multiple-file-processing.html#startcapturing)
84-
85-
### Image Source
86+
#### Configure Settings
8687

87-
Implement [`ImageSourceAdapter`]({{ site.dcvb_android_api }}core/basic-structures/image-source-adapter.html) and bind it to [`CaptureVisionRouter`]({{ site.dcvb_android_api }}capture-vision-router/capture-vision-router.html) so the SDK can continuously receive images.
88+
| API | Description |
89+
| --- | ----------- |
90+
| [`initSettingsFromFile`]({{ site.dcvb_android_api }}capture-vision-router/settings.html#initsettingsfromfile) | Load settings from a custom template file. |
91+
| [`SimplifiedCaptureVisionSettings`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html) | Access commonly used settings through a `SimplifiedCaptureVisionSettings` object. |
8892

89-
Built-in implementations include:
93+
#### Start/Stop Capture
9094

91-
- [`CameraEnhancer`]({{ site.dce_android }}primary-api/camera-enhancer.html) for video streams. [`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html) provides the corresponding camera UI.
92-
- [`DirectoryFetcher`]({{ site.dcvb_android_api }}utility/directory-fetcher.html) for files or folders.
93-
94-
### Result
95+
| API | Description |
96+
| --- | ----------- |
97+
| [`startCapturing`]({{ site.dcvb_android_api }}capture-vision-router/multiple-file-processing.html#startcapturing) | Start processing input frames with the selected template. |
98+
| [`stopCapturing`]({{ site.dcvb_android_api }}capture-vision-router/multiple-file-processing.html#stopcapturing) | Stop the current capture process. |
9599

96-
#### Receiver and Callbacks
100+
#### Receive Results
97101

98102
Implement [`CapturedResultReceiver`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) to receive capture results.
99103

100-
| Callback | Description |
101-
| -------- | ----------- |
104+
| API | Description |
105+
| --- | ----------- |
102106
| [`onDecodedBarcodesReceived`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html#ondecodedbarcodesreceived) | Callback for receiving barcode decoding results as a [`DecodedBarcodesResult`](decoded-barcodes-result.md) object. |
103107
| [`onParsedResultReceived`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html#onparsedresultreceived) | Callback for receiving parsed results as a [`ParsedResult`]({{ site.dcp_android_api }}parsed-result.html) object. |
104108
| [`onCapturedResultReceived`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html#oncapturedresultreceived) | Callback for receiving all result types as a [`CapturedResult`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result.html) object. |
105109

106-
#### Result Objects
110+
### Input - CameraEnhancer
111+
112+
[`CameraEnhancer`]({{ site.dce_android }}primary-api/camera-enhancer.html) is a built-in implementation of [`ImageSourceAdapter`]({{ site.dcvb_android_api }}core/basic-structures/image-source-adapter.html). It combines camera control, image enhancement, and a UI system designed for the Dynamsoft Capture Vision architecture.
113+
114+
### Result
107115

108116
| Result | Basic Item | Type |
109117
| ------ | ---------- | ---- |

0 commit comments

Comments
 (0)