GitHub license GitHub stars Pub GitHub forks


Original barcode_scan was discontinued, so barcode_scan2 was borned with sound null safety support🎉


A flutter plugin for scanning 2D barcodes and QR codes.

This provides a simple wrapper for two commonly used iOS and Android libraries:


  • x Scan 2D barcodes
  • x Scan QR codes
  • x Control the flash while scanning
  • x Permission handling

Getting Started


For Android, you must do the following before you can use the plugin:

  • Add the camera permission to your AndroidManifest.xml

    <uses-permission android:name="android.permission.CAMERA" />

  • This plugin is written in Kotlin. Therefore, you need to add Kotlin support to your project. See installing the Kotlin plugin.

Edit your project-level build.gradle file to look like this:

buildscript {
    ext.kotlin_version = '1.3.61'
    // ...
    dependencies {
        // ...
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
// ...

Edit your app-level build.gradle file to look like this:

apply plugin: 'kotlin-android'
// ...
dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
    // ...

Now you can depend on the barcode_scan plugin in your pubspec.yaml file:

    # ...
    barcode_scan: any

Click "Packages get" in Android Studio or run flutter packages get in your project folder.


To use on iOS, you must add the the camera usage description to your Info.plist

    <!-- ... -->
    <string>Camera permission is required for barcode scanning.</string>
    <!-- ... -->


import 'package:barcode_scan/barcode_scan.dart';

void main() async {
  var result = await BarcodeScanner.scan();

  print(result.type); // The result type (barcode, cancelled, failed)
  print(result.rawContent); // The barcode content
  print(result.format); // The barcode format (as enum)
  print(result.formatNote); // If a unknown format was scanned this field contains a note

Advanced usage

You can pass options to the scan method:

import 'package:barcode_scan/barcode_scan.dart';

void main() async {

  var options = ScanOptions(
    // set the options

  var result = await BarcodeScanner.scan(options: options);

  // ...

Supported options

OptionTypeDescriptionSupported by
strings.cancelStringThe cancel button text on iOSiOS only
strings.flash_onStringThe flash on button textiOS + Android
strings.flash_offStringThe flash off button textiOS + Android
restrictFormatBarcodeFormat[]Restrict the formats which are recognizediOS + Android
useCameraintThe index of the camera which is used for scanning (See BarcodeScanner.numberOfCameras)iOS + Android
autoEnableFlashboolEnable the flash when start scanningiOS + Android
android.aspectTolerancedoubleEnable auto focus on AndroidAndroid only
android.useAutoFocusboolSet aspect ratio tolerance level used in calculating the optimal Camera preview sizeAndroid only

Development setup

Setup protobuf


$ brew install protobuf
$ brew install swift-protobuf

Windows / Linux:

Activate the protobuf dart plugin:

$ flutter pub global activate protoc_plugin

Install theProtobuf Support plugin for IDEA / Android Studio or vscode-proto3 for VS Code

If you changed the protos.proto you've to execute the ./ to update the dart / swift sources

Common problems

Android "Could not find org.jetbrains.kotlin:kotlin-stdlib-jre..."

Change org.jetbrains.kotlin:kotlin-stdlib-jre to org.jetbrains.kotlin:kotlin-stdlib-jdk (StackOverflow)