barKoder Barcode Scanner SDK for Flutter

Add an enterprise-grade barcode scanning engine in your Flutter app

The barKoder SDK Flutter plugin grants an easy to use Flutter solution with a great interface that can be integrated in both iOS and Android apps.

Integrating the barKoder Barcode Scanner SDK into your Enterprise or Consumer-facing mobile apps will instantly transform your user's smarphones and tablets into rugged barcode scanning devices without the need to procure and maintain expensive and sluggish hardware devices that have a very short life span.

The barKoder barcode scanner SDK is a relatively new product in an established market, already developed to be as advanced if not more than other competitor API's. Its robust barcode reading engine can be used to read the content of the most widely used barcodes with lightning fast speed and unprecended recognition rate:

1D - Codabar, Code 11, Code 25, Code 39, Code 93, Code 128, EAN-8, EAN-13, Interleaved 2 of 5, ITF-14, MSI Plessey, Pharmacode, Telepen, UPC-A & UPC-E

2D - Aztec Code, Aztec Compact, Data Matrix, PDF417, Micro PDF417, DotCode, QR Code & Micro QR Code

You can check out our free demo app Barcode Scanner by barKoder available both via Apple App Store & Google Play Store.

Installation & Basic usage

1. Prepare environment

Install Flutter SDK and setup your environment

2. Add our flutter package

To add the barkoder_flutter package to your project, you have two options. You can either use the barkoder_flutter package from pub.dev or from a local path.

To use the package from pub.dev, add the package name and version to your project's dependencies:

dependencies:
    flutter:
      sdk: flutter
  
    barkoder_flutter: <package version>

If you prefer to use a local package, download the package from https://barkoder.com and set the package path in your project's dependencies:

 dependencies:
       flutter:
         sdk: flutter
     
       barkoder_flutter:
         path: <package local path>

3. Install dependencies

Run flutter pub get command in terminal to install the specified dependencies in your project

4. Import package

Import the barkoder_flutter package in your project with:

 import 'package:barkoder_flutter/barkoder_flutter.dart';

5. BarkoderView

At this point the barkoder_flutter package is installed and imported in your project. Next step is to add the BarkoderView in your layout and set the licenseKey parameter and onBarkoderViewCreated callback.

 @override
   Widget build(BuildContext context) {
     return Scaffold(
       ...,
       body: BarkoderView(
                 licenseKey: 'KEY',
                 onBarkoderViewCreated: _onBarkoderViewCreated),
       ...
     );

The license key is a string that concists of alphanumerical characters. See section Section 8 to learn how to get a valid license.

6. Ready to Scan Event

Inside _onBarkoderViewCreated callback function the SDK is fully initialized and ready for configuration or to start the scanning process

 void _onBarkoderViewCreated(barkoder) {
   _barkoder = barkoder;

   _barkoder.setBarcodeTypeEnabled(BarcodeType.qr, true);
   _barkoder.setRegionOfInterestVisible(true);
 
   ...
 }

 void _scanPressed() {
   _barkoder.startScanning((result) {
     // The result from successful scan is received here
   });
 }

For the complete usage of the barkoder_flutter plugin please check our sample.

7. Camera permissions

Our SDK requires camera permission to be granted in order to use scanning features. For Android, the permission is set in the manifest from the plugin. For iOS you need to specify camera permission in Info.plist file inside your project

  <key>NSCameraUsageDescription</key>
 <string>Camera permission</string>

8. Licensing

The SDK will scan barcodes even without a valid license; however all results will be randomly masked with (*) Asterisk characters. By using our software you are agreeing to our End User License Agreement. To obtain a valid license, one should create an account here and either get a trial license (to test the software out) or procure a production license that can be used within a live app.

Full Documentation

The most up to date documentation about the barkoder-flutter plugin as well as info on other platforms and frameworks that we support can be found at https://docs.barkoder.com/en/v1/flutter-installation

Trial License

If you run the barKoder Barcode Scanner SDK without a valid trial or production license, all results upon successful barcode scans will be partially masked by asterisks (*). You can get a trial license simply by registering on the barKoder Portal and utilizing the self-service for Evaluation License Generation! Each trial license will be good for an initial duration of 30 days and can be deployed to up to 50 devices. For any custom requirements, contact our sales team via sales@barkoder.com

Note that a trial license is only supposed to be utilized in a development or staging environment. IF you decide to publish a trial license along with your app to the App Store, Play Store or any public store we won't be held accountable for any potential consequences.

Free Developer Support

Our support is completely free for integration or testing purposes and granted through the barKoder Developer Portal. After registering and logging into your account, you only need to submit a Support Issue. Alternatively, you can contact us by email via support@barkoder.com