flutter_barcode_sdk

pub.dev

The Flutter barcode SDK plugin is a wrapper for Dynamsoft Barcode Reader SDK. It aims to cover Android, iOS, Web, Windows, Linux and macOS, supporting linear barcode, QR Code, DataMatrix, MaxiCode, PDF417, etc.

What You Should Know About Dynamsoft Barcode SDK

Build Configuration

Android

Change the minimum Android sdk version to 21 (or higher) in your android/app/build.gradle file.

minSdkVersion 21

iOS

Add the keys to ios/Runner/Info.plist to make camera work:

<key>NSCameraUsageDescription</key>
<string>Can I use the camera please?</string>
<key>NSMicrophoneUsageDescription</key>
<string>Can I use the mic please?</string>

Desktop

Windows & Linux

Install CMake and platform-specific C++ compiler.

macOS

Install Xcode.

To make the demo app work on macOS:

  • Disable com.apple.security.app-sandbox and enable com.apple.security.files.user-selected.read-write in example/macos/Runner/DebugProfile.entitlements:

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
    <plist version="1.0">
    <dict>
      <key>com.apple.security.app-sandbox</key>
      <false/>
      <key>com.apple.security.cs.allow-jit</key>
      <true/>
      <key>com.apple.security.network.server</key>
      <true/>
      <key>com.apple.security.files.user-selected.read-write</key>
      <true/>
    </dict>
    </plist>
    
  • Import DynamsoftBarcodeReader.h to the bridging header file.

    macOS bridging header

Web

Include <script src="https://cdn.jsdelivr.net/npm/dynamsoft-javascript-barcode@8.2.3/dist/dbr.js" data-productKeys="PRODUCT-KEYS"></script> to index.html.

There are two editions: compact edition and full edtion. The compact edition is used as the default. To enable the full edition, you need to add the following line to index.html after including the JS library.

<script>
  Dynamsoft.DBR.BarcodeReader._bUseFullFeature = true;
</script>

Try Barcode Decoding Example

Mobile

The example allows users to scan barcodes via the camera video stream in real-time or read barcodes by taking a picture.

cd example
flutter run -d <device>

Video Scan

flutter barcode scanner

Picture Scan

flutter barcode reader

For building Android release app, configure build.gradle and corresponding proguard file:

build.gradle

buildTypes {
        release {
            // TODO: Add your own signing config for the release build.
            // Signing with the debug keys for now, so `flutter run --release` works.
            signingConfig signingConfigs.debug
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }

proguard-rules.pro

-keep class com.dynamsoft.dbr.** { *; }

Windows, Linux and macOS Desktop

Input a valid image path for barcode decoding.

flutter windows barcode reader

  • Windows

    cd example
    flutter run -d windows
    
  • Linux

    cd example
    flutter run -d linux
    
  • macOS

    cd example
    flutter run -d macos
    

Web Browser

cd example
flutter run -d chrome

Barcode Reader

flutter web barcode reader

Barcode Scanner

flutter web barcode scanner

Currently Supported Platforms

  • Android
  • iOS
  • Windows
  • Linux
  • macOS
  • Web

API Compatibility

MethodsAndroidiOSWindowsLinuxmacOSWeb
Future<void> setLicense(String license) async:heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark::x:
Future<List<BarcodeResult>> decodeFile(String filename) async:heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark:
Future<List<BarcodeResult>> decodeFileBytes(Uint8List bytes) async:heavy_check_mark::x::heavy_check_mark::heavy_check_mark::x::x:
Future<List<BarcodeResult>> decodeImageBuffer(Uint8List bytes, int width, int height, int stride, int format) async:heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark::x::x:
Future<void> decodeVideo(Function callback) async:x::x::x::x::x::heavy_check_mark:
Future<void> closeVideo() async:x::x::x::x::x::heavy_check_mark:
Future<int> setBarcodeFormats(int formats) async:heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark:
Future<String> getParameters() async:heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark:
Future<int> setParameters(String params) async:heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark::heavy_check_mark:

Supported Barcode Symbologies

  • Linear Barcodes (1D)

    • Code 39 (including Code 39 Extended)
    • Code 93
    • Code 128
    • Codabar
    • Interleaved 2 of 5
    • EAN-8
    • EAN-13
    • UPC-A
    • UPC-E
    • Industrial 2 of 5
  • 2D Barcodes

    • QR Code (including Micro QR Code and Model 1)
    • Data Matrix
    • PDF417 (including Micro PDF417)
    • Aztec Code
    • MaxiCode (mode 2-5)
    • DotCode
  • Patch Code

  • GS1 Composite Code

  • GS1 DataBar

    • Omnidirectional,
    • Truncated, Stacked, Stacked
    • Omnidirectional, Limited,
    • Expanded, Expanded Stacked
  • Postal Codes

    • USPS Intelligent Mail
    • Postnet
    • Planet
    • Australian Post
    • UK Royal Mail

Usage

  • Initialize Flutter barcode sdk:

    // Windows, Linux, macOS, iOS and Android
    _barcodeReader = FlutterBarcodeSdk();
    
    // Web
    _barcodeReader = FlutterBarcodeSdk();
    await _barcodeReader.init();
    
  • Set a license key:

    _barcodeReader.setLicense('LICENSE-KEY');
    
  • Read barcodes from an image file:

    List<BarcodeResult> results = await _barcodeReader.decodeFile(image-path);
    
  • Read barcodes from image file bytes:

    Uint8List bytes = await File(image-path).readAsBytes();
    List<BarcodeResult> results = await _barcodeReader.decodeFileBytes(bytes);
    
  • Read barcodes from video stream CameraImage:

    CameraImage availableImage;
    int format = FlutterBarcodeSdk.IF_UNKNOWN;
    
    switch (availableImage.format.group) {
      case ImageFormatGroup.yuv420:
        format = FlutterBarcodeSdk.IF_YUV420;
        break;
      case ImageFormatGroup.bgra8888:
        format = FlutterBarcodeSdk.IF_BRGA8888;
        break;
      default:
        format = FlutterBarcodeSdk.IF_UNKNOWN;
    }
    
    List<BarcodeResult> results = _barcodeReader.decodeImageBuffer(
                  availableImage.planes[0].bytes,
                  availableImage.width,
                  availableImage.height,
                  availableImage.planes[0].bytesPerRow,
                  format);
    
  • Read barcodes from web browser video stream:

    _barcodeReader.decodeVideo(
                                (results) => {updateResults(results)});
    
  • Set barcode formats:

    await _barcodeReader.setBarcodeFormats(BarcodeFormat.ALL);
    
  • Get current barcode detection parameters:

    String params = await _barcodeReader.getParameters();
    // Convert parameters to a JSON object.
    dynamic obj = jsonDecode(params);
    // Modify parameters.
    if (obj['ImageParameter'] != null) {
      obj['ImageParameter']['DeblurLevel'] = 5;
    } else
      obj['deblurLevel'] = 5;
    
  • Set barcode detection parameters:

    int ret = await _barcodeReader.setParameters(json.encode(obj));
    

How to Use the License Key

Mobile

No license required. Instead, you need to get an private organization ID and update the plugin code:

parameters.organizationID = "200001";

By default, the public organization ID 200001 authorize developers to use the SDK for 7 days.

Desktop

Invoke the setLicense() method:

_barcodeReader.setLicense('LICENSE-KEY');

Web

Update the PRODUCT-KEYS :

<script src="https://cdn.jsdelivr.net/npm/dynamsoft-javascript-barcode@8.2.3/dist/dbr.js" data-productKeys="PRODUCT-KEYS"></script>
<script>
  Dynamsoft.DBR.BarcodeReader._bUseFullFeature = true;
</script>

License Agreement

https://www.dynamsoft.com/Products/barcode-reader-license-agreement.aspx

Contact Us

support@dynamsoft.com

Libraries

dynamsoft
dynamsoft_barcode
flutter_barcode_sdk
flutter_barcode_sdk_web
global
utils