---
layout: default-layout
title: Dynamsoft Barcode Reader Android API Reference - Main Page
description: Main API reference page for Dynamsoft Barcode Reader SDK for Android.
keywords: BarcodeReader, api reference, Android
noTitleIndex: false
needGenerateH3Content: true
needAutoGenerateSidebar: true
---

# API Overview

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

<style>
  svg {
    max-width: 100%;
    height: auto;
  }

  .clickable {
    fill: transparent;
    cursor: pointer;
  }

  .clickable:hover {
    fill: rgba(0, 123, 255, 0.2);
    stroke: #007bff;
    stroke-width: 2;
  }
</style>
<svg viewBox="0 0 1397 768">
  <image href="../../assets/architecture-cvr.png" width="1397" height="768"/>
  <a href="{{ site.dce_android }}primary-api/camera-enhancer.html">
    <rect class="clickable"
          x="110" y="310"
          width="305" height="180" />
  </a>
  <a href="{{ site.dcvb_android_api }}capture-vision-router/capture-vision-router.html">
    <rect class="clickable"
          x="500" y="350"
          width="370" height="105" />
  </a>
  <a href="{{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html">
    <rect class="clickable"
          x="1005" y="360"
          width="120" height="160" />
  </a>
  <a href="{{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html">
    <rect class="clickable"
          x="1150" y="360"
          width="120" height="160" />
  </a>
  <a href="{{ site.dbr_android_api }}dbr-index.html">
    <rect class="clickable"
          x="480" y="570"
          width="210" height="150" />
  </a>
  <a href="{{ site.dcp_android_api }}code-parser.html">
    <rect class="clickable"
          x="700" y="570"
          width="210" height="150" />
  </a>
  <a href="{{ site.dcvb_android_api }}capture-vision-router/settings.html">
    <rect class="clickable"
          x="520" y="90"
          width="140" height="170" />
  </a>
  <a href="{{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html">
    <rect class="clickable"
          x="680" y="90"
          width="140" height="170" />
  </a>
</svg>

## 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<br>DynamsoftCodeParser | APIs for functional modules, mainly for decoded results and result processing. |
| Infrastructure & Utility | DynamsoftLicense<br>DynamsoftCore<br>DynamsoftUtility | Licensing, basic structures, intermediate results, and utility APIs. |

### CaptureVisionRouter

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:

#### Configure Settings

| API | Description |
| --- | ----------- |
| [`initSettingsFromFile`]({{ site.dcvb_android_api }}capture-vision-router/settings.html#initsettingsfromfile) | Load settings from a custom template file. |
| [`SimplifiedCaptureVisionSettings`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html) | Access commonly used settings through a `SimplifiedCaptureVisionSettings` object. |

#### Start/Stop Capture

| API | Description |
| --- | ----------- |
| [`startCapturing`]({{ site.dcvb_android_api }}capture-vision-router/multiple-file-processing.html#startcapturing) | Start processing input frames with the selected template. |
| [`stopCapturing`]({{ site.dcvb_android_api }}capture-vision-router/multiple-file-processing.html#stopcapturing) | Stop the current capture process. |

#### Receive Results

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

| API | Description |
| --- | ----------- |
| [`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. |
| [`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. |
| [`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. |

### Input - CameraEnhancer

[`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.

### Result

| Result | Basic Item | Type |
| ------ | ---------- | ---- |
| [`DecodedBarcodesResult`](decoded-barcodes-result.md) | [`BarcodeResultItem`](barcode-result-item.md) | `CRIT_BARCODE` |
| [`ParsedResult`]({{ site.dcp_android_api }}parsed-result.html) | [`ParsedResultItem`]({{ site.dcp_android_api }}parsed-result-item.html) | `CRIT_PARSED_RESULT` |