p-hatan / mirrormirror.p-hatan.com

Viewing version 7.3.0. Open the latest package page.

mobile_scanner

7.3.0

A universal Flutter barcode and QR code scanner using CameraX/ML Kit for Android, AVFoundation/Apple Vision for iOS & macOS, and ZXing for web.

Download archive

Readme

mobile_scanner

Pub Version Pub Version Prerelease Build Status Style: Very Good Analysis Codecov GitHub Sponsors

A fast and lightweight Flutter plugin for scanning barcodes and QR codes using the device’s camera. It supports multiple barcode formats, real-time detection, and customization options for an optimized scanning experience on multiple platforms.

Features

  • Fast barcode and QR code scanning
  • Supports multiple barcode formats
  • Real-time detection
  • Customizable camera and scanner behavior

See the examples for runnable examples of various usages, such as the basic usage, applying a scan window, or retrieving images from the barcodes.

Platform Support

Android iOS macOS Web Linux Windows
✔ ✔ ✔ ✔ :x: :x:

Features Supported

See the example app for detailed implementation information.

Features Android iOS macOS Web
analyzeImage :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :x:
returnImage :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :x:
scanWindow :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :x:
autoZoom :heavy_check_mark: :x: :x: :x:
lensType :heavy_check_mark: :heavy_check_mark: :x: :x:

Installation

Add the dependency in your pubspec.yaml file:

dependencies:
  mobile_scanner: ^<latest_version>

Then run:

flutter pub get

Configuration

Android

This package uses by default the bundled version of MLKit Barcode-scanning for Android. This version is immediately available to the device. But it will increase the size of the app by approximately 3 to 10 MB.

The alternative is to use the unbundled version of MLKit Barcode-scanning for Android. This version is downloaded on first use via Google Play Services. It increases the app size by around 600KB.

You can read more about the difference between the two versions here.

To use the unbundled version of the MLKit Barcode-scanning, add the following line to your /android/gradle.properties file:

dev.steenbakker.mobile_scanner.useUnbundled=true

iOS

Since the scanner needs to use the camera, add the following keys to your Info.plist file. (located in /ios/Runner/Info.plist)

NSCameraUsageDescription - describe why your app needs access to the camera. This is called Privacy - Camera Usage Description in the visual editor.

If you want to use the local gallery feature from image_picker, you also need to add the following key.

NSPhotoLibraryUsageDescription - describe why your app needs permission for the photo library. This is called Privacy - Photo Library Usage Description in the visual editor.

Example,

<key>NSCameraUsageDescription</key>
<string>This app needs camera access to scan QR codes</string>

<key>NSPhotoLibraryUsageDescription</key>
<string>This app needs photos access to get QR code from photo library</string>

macOS

Ensure that you granted camera permission in XCode -> Signing & Capabilities:

Web

As of version 5.0.0 adding the barcode scanning library script to the index.html is no longer required, as the script is automatically loaded on first use.

Detection backends

The web implementation supports three barcode detection backends. The active backend is selected via MobileScannerPlatform.instance.setWebBarcodeReader(reader) before starting the scanner.

Auto (default)

Uses the native BarcodeDetector API when the browser supports it, and falls back to zxing-wasm otherwise. This is the recommended setting for most apps.

Native BarcodeDetector

Uses the W3C Shape Detection API, which is built into the browser. No external library is loaded. This is the fastest option because detection runs natively without any JavaScript or WebAssembly overhead.

Available in Chrome 83+, Edge 83+, and Safari 17+. Not supported in Firefox.

zxing-wasm

Uses zxing-wasm, a WebAssembly port of the ZXing C++ library. The WASM binary (~2 MB) is loaded from the jsDelivr CDN on first use. Offers good performance and works in all modern browsers, including Firefox.

ZXing-js (legacy)

Uses the ZXing JavaScript library, a pure-JavaScript port of ZXing. Loaded from the unpkg CDN. This backend is slower than the WASM alternative and is provided for backward compatibility and comparison purposes only.

Backend comparison

Feature Native BarcodeDetector zxing-wasm ZXing-js (legacy)
Performance Fastest (native) Fast (WASM) Slow (pure JS)
Firefox :x: :heavy_check_mark: :heavy_check_mark:
Chrome / Edge :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
Safari 17+ :heavy_check_mark: :heavy_check_mark:
External dependency None ~2 MB WASM (CDN) ~600 KB JS (CDN)
Supported formats Browser-dependent Most 1D and 2D formats Most 1D and 2D formats

Barcode format support per backend

BarcodeFormat Native BarcodeDetector ¹ zxing-wasm ZXing-js (legacy)
aztec :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: ³
codabar :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
code39 :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
code93 :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
code128 :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
dataMatrix :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
ean8 :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
ean13 :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
itf ² :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
pdf417 :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: ³
qrCode :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
upcA :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
upcE :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
maxiCode :x: :heavy_check_mark: :heavy_check_mark:
microQrCode :x: :heavy_check_mark: :heavy_check_mark:
dataBar ⁴ :x: :heavy_check_mark: :heavy_check_mark:
dataBarExpanded ⁴ :x: :heavy_check_mark: :heavy_check_mark:
dataBarLimited ⁴ :x: :heavy_check_mark: :x:

¹ The BarcodeDetector API defines all formats listed, but the formats that are actually detected vary per browser and operating system. Use BarcodeDetector.getSupportedFormats() to query the current browser. In WebBarcodeReader.auto mode, mobile_scanner falls back to zxing-wasm when the browser reports no supported formats at all.

² The itf2of5 and itf2of5WithChecksum variants are decoded as plain ITF on all web backends; no length or checksum validation is applied. The itf14 variant is supported as a distinct format by zxing-wasm, and decoded as plain ITF by the other backends.

³ The upstream zxing-js library marks Aztec as "needs testing" and PDF417 as "not production ready".

⁴ GS1 DataBar (RSS-14) is also supported on iOS 15+ and macOS 12+ via Apple Vision.

zxing-wasm supports additional formats (such as rMQR Code), but only the formats listed above are exposed through BarcodeFormat.

Providing a mirror for the barcode scanning library

If a different mirror is needed to load the barcode scanning library, the source URL can be set beforehand.

import 'package:flutter/foundation.dart';
import 'package:mobile_scanner/mobile_scanner.dart';

final String scriptUrl = // ...

if (kIsWeb) {
  MobileScannerPlatform.instance.setBarcodeLibraryScriptUrl(scriptUrl);
}

Usage

Simple

Import the package with package:mobile_scanner/mobile_scanner.dart. The only required parameter is onDetect, which returns the scanned barcode or qr code.

MobileScanner(
  onDetect: (result) {
    print(result.barcodes.first.rawValue);
  },
),

Advanced

If you want more control over the scanner, you need to create a new MobileScannerController controller. The controller contains multiple parameters to adjust the scanner.

final MobileScannerController controller = MobileScannerController(
  cameraResolution: size,
  detectionSpeed: detectionSpeed,
  detectionTimeoutMs: detectionTimeout,
  formats: selectedFormats,
  returnImage: returnImage,
  torchEnabled: true,
  invertImage: invertImage,
  autoZoom: autoZoom,
);

MobileScanner(
  controller: controller,
  onDetect: (result) {
    print(result.barcodes.first.rawValue);
  },
);

Switching lens types

On devices with multiple cameras (normal, wide, zoom), you can switch between lens types:

// Toggle through available lens types (normal -> wide -> zoom -> normal)
await controller.switchCamera(const ToggleLensType());

// Or select a specific lens type
await controller.switchCamera(
  const SelectCamera(lensType: CameraLensType.wide),
);

// Get supported lens types for the current camera
final Set<CameraLensType> supportedLenses = await controller.getSupportedLenses();

Lifecycle changes

If you want to pause the scanner when the app is inactive, you need to use WidgetsBindingObserver.

First, provide a StreamSubscription for the barcode events. Also, make sure to create a MobileScannerController with autoStart set to false, since we will be handling the lifecycle ourself.

final MobileScannerController controller = MobileScannerController(
  autoStart: false,
);

StreamSubscription<Object?>? _subscription;

Then, ensure that your State class mixes in WidgetsBindingObserver, to handle lifecyle changes, and add the required logic to the didChangeAppLifecycleState function:

class MyState extends State<MyStatefulWidget> with WidgetsBindingObserver {
  // ...

  @override
  void didChangeAppLifecycleState(AppLifecycleState state) {
    // If the controller is not ready, do not try to start or stop it.
    // Permission dialogs can trigger lifecycle changes before the controller is ready.
    if (!controller.value.hasCameraPermission) {
      return;
    }

    switch (state) {
      case AppLifecycleState.detached:
      case AppLifecycleState.hidden:
      case AppLifecycleState.paused:
        return;
      case AppLifecycleState.resumed:
        // Restart the scanner when the app is resumed.
        // Don't forget to resume listening to the barcode events.
        _subscription = controller.barcodes.listen(_handleBarcode);

        unawaited(controller.start());
      case AppLifecycleState.inactive:
        // Stop the scanner when the app is paused.
        // Also stop the barcode events subscription.
        unawaited(_subscription?.cancel());
        _subscription = null;
        unawaited(controller.stop());
    }
  }

  // ...
}

Then, start the scanner in void initState():

@override
void initState() {
  super.initState();
  // Start listening to lifecycle changes.
  WidgetsBinding.instance.addObserver(this);

  // Start listening to the barcode events.
  _subscription = controller.barcodes.listen(_handleBarcode);

  // Finally, start the scanner itself.
  unawaited(controller.start());
}

Finally, dispose of the the MobileScannerController when you are done with it.

@override
Future<void> dispose() async {
  // Stop listening to lifecycle changes.
  WidgetsBinding.instance.removeObserver(this);
  // Stop listening to the barcode events.
  unawaited(_subscription?.cancel());
  _subscription = null;
  // Dispose the widget itself.
  super.dispose();
  // Finally, dispose of the controller.
  await controller.dispose();
}

Known Limitations

rawBytes on iOS and macOS

Apple's Vision framework does not provide a direct API for reading the raw payload bytes of a scanned barcode. The rawBytes field is populated on a best-effort basis using two strategies, each with constraints.

QR codes

Two strategies are used in combination. For Byte-mode segments the error-corrected bit stream from CIQRCodeDescriptor is parsed directly. For all other modes the decoded string from payloadStringValue is re-encoded to Latin-1 as a fallback.

Scenario rawBytes result
Byte mode (UTF-8, arbitrary binary data) Correct — parsed directly from bit stream
Numeric mode (digits only) Correct — recovered via string fallback
Alphanumeric mode (uppercase + allowed symbols) Correct — recovered via string fallback
Kanji mode null — Japanese characters cannot round-trip through Latin-1

Aztec, DataMatrix, PDF417 and linear formats (Code 128, EAN, etc.)

Apple Vision decodes the payload as a string internally using a Latin-1 (ISO-8859-1) interpretation of the raw bytes. rawBytes is recovered by re-encoding that string back to Latin-1.

Byte value range rawBytes result
0x00–0x7F (ASCII) Correct
0xA0–0xFF (upper Latin-1, includes ø, é, ü, etc.) Correct
0x80–0x9F (Windows-1252 special range) null — Apple maps these to Unicode code points above U+00FF, which cannot be round-tripped through Latin-1

This means arbitrary binary payloads that happen to contain bytes in the 0x80–0x9F range will result in rawBytes being null for those formats.

Android and Web

On Android, rawBytes is fully supported for all formats and encoding modes via MLKit.

On Web, support depends on the active detection backend:

Backend rawBytes support
Native BarcodeDetector :x: Not available (browser API returns decoded text only)
zxing-wasm :heavy_check_mark: Fully supported
ZXing-js (legacy) :heavy_check_mark: Fully supported
Changelog

7.3.0

New features

  • [Web] Added support for multiple barcode detection backends, selectable via MobileScannerPlatform.instance.setWebBarcodeReader(WebBarcodeReader reader):
    • WebBarcodeReader.auto (default), uses the native BarcodeDetector API when available, and falls back to zxing-wasm otherwise.
    • WebBarcodeReader.barcodeDetector, uses the W3C Shape Detection API (Chrome 83+, Edge 83+, Safari 17+). No external library is loaded.
    • WebBarcodeReader.zxingWasm, uses zxing-wasm (ZXing C++ compiled to WebAssembly), which works in all modern browsers including Firefox.
    • WebBarcodeReader.zxingJs, the legacy ZXing JavaScript backend, retained for backward compatibility.
  • [Web] Added MobileScannerPlatform.instance.activeWebReader to query which backend is currently active.
  • Added BarcodeFormat.maxiCode and BarcodeFormat.microQrCode, supported by the WebBarcodeReader.zxingJs and WebBarcodeReader.zxingWasm backends.
  • Added BarcodeFormat.dataBar, BarcodeFormat.dataBarExpanded and BarcodeFormat.dataBarLimited (GS1 DataBar / RSS-14), supported by the WebBarcodeReader.zxingJs and WebBarcodeReader.zxingWasm backends (DataBar and DataBar Expanded only for zxingJs), and by Apple Vision on iOS 15+ / macOS 12+.

Improvements

  • [Web] Bumped @zxing/library (the WebBarcodeReader.zxingJs backend) from 0.21.3 to 0.23.0.

Bug Fixes

  • Fixed disposing a MobileScannerController also disposing the platform resources of a different controller. Disposing a controller that does not hold the active camera session no longer tears down the camera of the controller that does. (#1631)
  • Fixed a subscription leak where a controller that was disposed without being stopped kept its internal event stream subscriptions alive.
  • Fixed an issue when running the plugin using AGP 9.

7.2.1

Improvements

  • [Web] The preferred camera device ID is now persisted in localStorage and reused on the next start.
  • [Web] Focus, exposure, and white-balance constraints are now applied automatically when supported by the browser (Image Capture API).
  • [Web] The camera now uses StartOptions.cameraResolution as the ideal resolution, falling back to 1920×1080.
  • [Web] The barcode overlay is now mirrored when the video preview is mirrored (e.g. front camera).
  • [Web] The scan window is now supported. Barcodes detected outside the scan window are ignored.
  • [Android] Laid groundwork for Android Gradle Plugin (AGP) 9 compatibility by conditionally applying the kotlin-android plugin only on AGP versions below 9, while remaining compatible with older AGP versions.

Bug Fixes

  • [Apple] Fixed a race condition in captureOutput where latestBuffer was read on a background thread after being deallocated on the main thread, causing a crash in VTCreateCGImageFromCVPixelBuffer.
  • [Apple] Fixed an issue where captureOutput was being processed on the main thread, causing overheating issues on device.
  • [Android] Fixed start() not resuming the camera after pause(), caused by the isPaused flag being reset before the paused-state check.
  • [Android] Fixed ProGuard/R8 full mode (default since AGP 8.0) stripping or obfuscating MLKit classes by widening the keep rule to com.google.mlkit.**.

7.2.0

Highlights

  • Added support for switching between lens types (normal, wide, zoom) using the switchCamera() method with ToggleLensType or SelectCamera options.
  • Added rawDecodedBytes field to Barcode which replaces Barcode.rawBytes. On Apple platforms, this returns a DecodedVisionBarcodeBytes containing bytes (decoded payload, without header/padding) and rawBytes (full raw payload, available on iOS 17.0+ / macOS 14.0+). On Android and web, this returns a DecodedBarcodeBytes containing bytes.

Improvements

  • [Android] Migrated barcode bounding box from boundingBox to cornerPoints for more accurate scan window detection.
  • Added support for ITF-Two-of-Five.
  • Added constants for testing the method channel methods in MobileScannerMethods and MobileScannerEvents.
  • The global method calculateBoxFitRatio() is now deprecated.

Bug Fixes

  • [Android] Fixed incorrect texture size on orientation change.
  • [Android] Fixed a bug where the isPaused flag was not reset when start() was called.
  • [Android] Fixed imageAnalysis not being unbound on dispose.
  • [Android] Fixed an issue where the app orientation handling was not respecting auto-rotate settings
  • [Apple] Fixed rawBytes returning incorrect data for barcodes containing non-ASCII characters (e.g. ø). For QR codes, bytes are now extracted directly from the error-corrected bit stream via CIQRCodeDescriptor, bypassing the Vision string API entirely. For Aztec, DataMatrix, PDF417 and linear formats, the ISO-Latin-1 round-trip is used to recover the original bytes from payloadStringValue.
  • [Apple] Fixed displayValue returning a garbled Latin-1 string (e.g. hellø) for barcodes with non-ASCII UTF-8 content. It is now correctly decoded to UTF-8 (e.g. hellø).
  • [Apple] Fixed a bug where the barcode type results did not have a value.
  • [Apple] Fixed camera rotating, even when rotation is locked.
  • [macOS] Fixed barcode overlay text displaying upside down.
  • Fixed barcode overlay rendering at wrong position after orientation change.
  • Fixed a bug where taps were ignored on the scanner widget.
  • Fixed a bug where a controller that was only disposed would throw an incorrect error code.

7.1.4

  • [Apple] Fixed crash on iPhone 17 when starting MobileScanner by checking available pixel formats before setting video output settings. (#1578)

7.1.3

  • Overlay: Updated BarcodePainter to receive deviceOrientation and dynamically adjust cameraPreviewSize, fixing barcode overlay misalignment during device rotation changes .

  • [Android] Refactored orientation detection to use OrientationEventListener instead of BroadcastReceiver for ACTION_CONFIGURATION_CHANGED, ensuring physical device orientation is captured correctly and preventing unwanted screen rotations on MobileScanner initialization .

  • [Android] Changed minSDK from 21 to 23 in line with Flutter requirements.

  • [Android] Removed deprecated renderscript api's, improved performance for analysis.

  • [Apple] Prevent half-stopped camera state causing false ALREADY_STARTED.

  • [Apple] Fixed a bug where invalid images would cause crashes when processing them with CoreVideo.

7.1.2

  • Fixed an issue with the initialZoom parameter.

7.1.1

  • Fixed missing import of 'package:meta/meta.dart' on older Flutter sdk's

7.1.0

Highlights

  • [Apple & Android] Added tap to focus functionality. You can enable it in the MobileScanner widget.
  • [Apple & Android] You can now set the initial zoom factor using the initialZoom parameter in the startOptions.

Bug Fixes and Improvements

  • [iOS] Increased minimum os level to 13 due to Flutter requirements.
  • [macOS] Increased minimum os level to 10.15 due to Flutter requirements.
  • [Android] Update to Java 17, and update other dependencies.
  • [Apple] Improved fallback for when camera is not found.
  • Added a Barcode.scaleCorners() method.

7.0.1

  • Added error handling for when MobileScannerController.start is called without an active MobileScanner widget.

7.0.0

This version finalizes all changes from the beta and release candidate cycles and introduces major improvements, bug fixes, and breaking changes.

BREAKING CHANGES

  • Requires Flutter 3.29.0 or higher.
  • The initial camera facing direction in MobileScannerState is now CameraFacing.unknown.
  • Removed the deprecated EncryptionType.none. Use EncryptionType.unknown instead.
  • The errorBuilder and placeholderBuilder no longer have a Widget argument.
  • Removed the MobileScannerErrorBuilder typedef.

Highlights

  • [iOS/macOS] Migrated to the Vision API with a unified Apple codebase.
  • [iOS] Minimum iOS version changed from 15 to 12.
  • [Android] Removed dependency on kotlin-bom and updated CameraX and camera-camera2 dependencies.
  • Support for pause/resume functionality across platforms.
  • MobileScannerErrorCode now includes readable error messages in debug mode.
  • Hot-restart during development now works correctly.
  • Added overlay widgets for barcode and scan window visualization.
  • Exposed new API parameters like autoZoom, invertImage, and lifecycle handling.

Bug Fixes and Improvements

  • [Apple]
    • Fixed rotation, orientation, and zoom behavior.
    • Resolved incorrect barcode overlay dimensions and corner coordinates.
    • Fixed a crash when stopping the camera with a nil device.
    • Fixed build issues including optional chaining on non-optional values.
  • [Android]
    • Fixed rotation and orientation issues.
    • Resolved timing issues in SurfaceProducer with Kotlin 1.8+.
    • Fixed resource leaks and improved image analysis compatibility.
    • Improved logging behavior (CameraX logs only errors).
  • [macOS]
    • Fixed mirrored images and build issues.
  • [Web]
    • Fixed barcode overlay not displaying due to incorrect corner point data.

7.0.0-rc.2

Bugs fixed:

  • [Apple] Fixed build issues "Cannot use optional chaining on non-optional value".

7.0.0-rc.1

After six months of development, Version 7.0.0 is finally moving out of beta with this release candidate! A stable release is scheduled for next week.

Improvements:

  • [Android] Remove the dependency on org.jetbrains.kotlin:kotlin-bom.
  • [Android] Updated camerax dependencies.
  • Hot-restart for development purposes is now working correctly
  • Added message to MobileScannerErrorCode, which will be shown if kDebugMode is true. Otherwise, a generic error message will appear.
  • Fixed issues regarding initialization of the MobileScannerController, which could result in a black screen without error message.

Bugs fixed:

  • [Android] Fixed rotation & orientation issues.
  • [Apple] Fixed rotation & orientation issues.
  • [Apple] Fixed a crash when stopping the camera when the camera device is nil.
  • [macOS] Fixed image not being mirrored.
  • [Web] Fixed barcode corners not being passed correctly resulting in no overlay being drawn.

7.0.0-beta.9

BREAKING CHANGES:

  • This release requires Flutter 3.29.0 or higher.

Bugs fixed:

  • [Android] Fixed a timing issue for the SurfaceProducer implementation, by switching to the onSurfaceCleanup callback.

7.0.0-beta.8

Improvements:

  • Updated examples in example app.
  • Added [useAppLifecycleState] parameter to enable or disable handling of lifecycle state when no controller is passed.
  • Dispose function of [MobileScanner] is now async.
  • The [BarcodeOverlay] now correctly disposes the text painter.

Bugs fixed:

  • [Apple] Fixed barcode corners representation for barcode overlay.
  • [Apple] Fixed zoom callback not working.
  • [Apple] Updated zoom scale factor to match Android implementation.
  • Fixed build issues on older kotlin versions.

7.0.0-beta.7

BREAKING CHANGES:

  • The initial state of the MobileScannerState camera facing direction is changed to CameraFacing.unknown.

Improvements:

  • [Android] Turn off logging for CameraX, except for the Log.ERROR logging level.
  • Added CameraFacing.external and CameraFacing.unknown enum values.

Bugs fixed:

  • [Android] Fixed an issue when compiling with Kotlin 1.8.0 or higher.

7.0.0-beta.6

BREAKING CHANGES:

  • This release requires Flutter 3.27.0 or higher.

Improvements:

  • [Android] Added support for Impeller.
  • [Apple] Added support for rawBytes from the Vision API observations.
  • Export the MobileScannerViewAttributes and StartOptions types, to allow them in tests.

Bugs fixed:

  • [Apple] Fixed a bug that caused a crash when the capture session could not add the video input.

7.0.0-beta.5

Improvements:

  • [Android] Added autoZoom parameter to auto zoom if the detected code is to far from the camera.
  • [Android] Added invertImage parameter to invert image colors for analyzer to support white-on-black barcodes, which are not supported by MLKit.
  • [Android] Updated camera-camera2 dependencies.
  • Added pause functionality to all platforms.

Bugs fixed:

  • [Android] Fixed resources not being closed.

7.0.0-beta.4

BREAKING CHANGES:

  • The updateScanWindow method is now private. Instead, update the scan window in the MobileScanner widget directly.
  • The deprecated EncryptionType.none constant has been removed. Use EncryptionType.unknown instead.
  • The errorBuilder and placeholderBuilder of the MobileScanner widget no longer take a Widget argument, as it was unused.
  • The MobileScannerErrorBuilder typedef has been removed.

Bugs fixed:

  • [Apple] Fixed an issue which caused the scanWindow to always be present, even when reset to no value.
  • [Apple] Fixed an issue that caused the barcode size to report the wrong height.
  • [Apple] Fixed a bug that caused the corner points to not be returned in clockwise orientation.
  • [Apple] Fixed an issue where analyzeImage would not throw an error if no valid image is provided as argument.
  • [Apple] Fixed an issue where analyzeImage would not return if no barcodes are found in the image.
  • [Apple] Fixed an issue where the iOS Simulator did not report that analyzing images from a file is unsupported.
  • [Android] Fixed an issue where analyzeImage would not return if no valid image is provided as argument.

Improvements:

  • Added a basic barcode overlay widget, for use with the camera preview.
  • Added a basic scan window overlay widget, for use with the camera preview.
  • Update the bundled MLKit model for Android to version 17.3.0.
  • Added documentation in places where it was missing.
  • Added color and style properties to the BarcodePainter widget.
  • Enabled Swift Package Manager for the example app.

7.0.0-beta.3

  • Fixed a build issue on macOS.

7.0.0-beta.2

Bugs fixed:

  • [Apple] Fixed an issue with the zoom slider being non-functional.
  • [Apple] Fixed an issue where the flash would briefly show when the camera is turned on.
  • [Apple] Fixed an issue that prevented the scan window from working.
  • [Apple] Fixed an issue that caused the barcode overlay to use the wrong dimensions.

Improvements:

  • [iOS] Adds support for Swift Package Manager.

Known issues:

  • BoxFit.cover & BoxFit.fitHeight produce the wrong width in the barcode overlay.

7.0.0-beta.1

Improvements:

  • [iOS] Migrate to the Vision API.
  • [iOS] Updated the minimum iOS version back down to 12.0.
  • [Apple] Merged the iOS and MacOS sources.

Known issues:

  • [Apple] The zoom slider does not work correctly.
  • [Apple] The scan window does not work correctly.
  • [Apple] The camera flash briefly shows when the camera is started.

6.0.11

  • [Android] Update camerax dependencies to support 16KB pages sizes.

6.0.10

  • [Apple] Fixed a crash when stopping the camera when the camera device is nil.

6.0.9

Fixed onDetect not working when a MobileScannerController is provided.

6.0.8

Improvements:

  • [Android] Remove the dependency on org.jetbrains.kotlin:kotlin-bom.
  • Hot-restart for development purposes is now working correctly
  • Added message to MobileScannerErrorCode, which will be shown if kDebugMode is true. Otherwise, a generic error message will appear.
  • Fixed issues regarding initialization of the MobileScannerController, which could result in a black screen without error message.

6.0.7

Improvements:

  • [Android] Updated bundled barcode scanning library to v17.3.0

6.0.6

Bugs fixed:

  • [web] Fixed a bug that prevented color inverted barcodes from being scanned.

Improvements:

  • [web] Bump ZXingJS from version 0.19.1 to 0.21.3.

6.0.5

Bugs fixed:

  • [Android] Fixed crash due to imageProxy being closed too early.

6.0.4

Bugs fixed:

  • [Android] Fixed UI stutter when returnImage is true.

6.0.3

New features:

  • Adds pause function to pause the camera but keep textures in place.

6.0.2

Bugs fixed:

  • Fixed a bug that prevented analyzeImage from actually accepting the configured formats.

Improvements:

  • [iOS] Excluded the arm64 architecture for Simulators, which is unsupported by MLKit 7.0.0.

6.0.1

Bugs fixed:

  • Fixed a bug that would cause onDetect to not handle errors.

Improvements:

  • [iOS] Excluded the armv7 architecture, which is unsupported by MLKit 7.0.0.
  • Added a new onDetectError error handler to the MobileScanner widget, for use with onDetect.

6.0.0

BREAKING CHANGES:

  • [iOS] iOS 15.5.0 is now the minimum supported iOS version.
  • [iOS] Updates MLKit to version 7.0.0.
  • [iOS] Updates the minimum supported XCode version to 15.3.0.

Improvements:

  • [MacOS] Added the corners and size information to barcode results.
  • [MacOS] Added support for analyzeImage.
  • [MacOS] Added a Privacy Manifest.
  • [web] Added the size information to barcode results.
  • [web] Added the video output size information to barcode capture.
  • Added support for barcode formats to image analysis.
  • Updated the scanner to report any scanning errors that were encountered during processing.
  • Introduced a new getter hasCameraPermission for the MobileScannerState.
  • Fixed a bug in the lifecycle handling sample. Now instead of checking isInitialized, the sample recommends using hasCameraPermission, which also guards against camera permission errors.
  • Updated the behavior of returnImage to only determine if the camera output bytes should be sent.
  • Updated the behavior of BarcodeCapture.size to always be provided when available, regardless of returnImage.

Bugs fixed:

  • Fixed a bug that would cause the scanner to emit an error when it was already started. Now it ignores any calls to start while it is starting.
  • [MacOS] Fixed a bug that prevented the anaylzeImage() sample from working properly.

5.2.3

Deprecations:

  • The EncryptionType.none constant has been deprecated, as its name was misleading. Use EncryptionType.unknown instead.

Bugs fixed:

  • Fixed EncryptionType throwing on invalid SAE encryption type.
  • [web] Removed the controls attribute on the video preview.

Improvements:

  • All enum types for barcode data (i.e. Wifi type or email type) now return unknown for unrecognized values.

5.2.2

Improvements:

  • [MacOS] Adds Swift Package Manager support.
  • [MacOS] Adds support for returnImage.
  • Added a new size property to Barcode, that denotes the bounding box of the barcode.

Bugs fixed:

  • Fixed some documentation errors for the size and image of BarcodeCapture.
  • [iOS] Fixed a bug with returnImage.
  • [Android/iOS] Adjusted the raw barcode scan value to pass the raw event data, like on MacOS.

5.2.1

  • Updates the package:web dependency to use a version range.

5.2.0

This release requires Flutter 3.22.0 and Dart 3.4.

  • [Android] Fixed a leak of the barcode scanner.
  • [Android] Fixed a crash when encountering invalid numbers for the scan window.
  • [Web] Migrates package:web to 1.0.0.

5.1.1

  • This release fixes an issue with automatic starts in the examples.

5.1.0

This updates reverts a few breaking changes made in v5.0.0 in order to keep things simple.

  • The onDetect method has been reinstated in the MobileScanner widget, but is nullable. You can still listen to MobileScannerController.barcodes directly by passing null to this parameter.
  • The autoStart attribute has been reinstated in the MobileScannerController and defaults to true. However, if you want to control which camera is used on start, or you want to manage the lifecycle yourself, you should set autoStart to false and manually call MobileScannerController.start({CameraFacing? cameraDirection}).
  • The controller is no longer required in the MobileScanner widget. However if provided, the user should take care of disposing it.
  • [Android] Revert Gradle 8 back to Gradle 7, to be inline with most Flutter plugins and prevent build issues.
  • [Android] Revert Kotlin back from 1.9 to 1.7 to be inline with most Flutter plugins. Special 1.9 functionality has been refactored to be compatible with 1.7.

5.0.2

Bugs fixed:

  • Fixed a crash when the controller is disposed while it is still starting. #1036 (thanks @EArminjon !)
  • Fixed an issue that causes the initial torch state to be out of sync.

Improvements:

  • Updated the lifeycle code sample to handle not-initialized controllers.

5.0.1

Improvements:

  • Adjusted the platform checks to use the defaultTargetPlatform API, so that tests can use the correct platform overrides.

5.0.0

This major release contains all the changes from the 5.0.0 beta releases, along with the following changes:

Improvements:

  • [Android] Remove the Kotlin Standard Library from the dependencies, as it is automatically included in Kotlin 1.4+

5.0.0-beta.3

BREAKING CHANGES:

  • Flutter 3.19.0 is now required.
  • [iOS] iOS 12.0 is now the minimum supported iOS version.
  • [iOS] Adds a Privacy Manifest.

Bugs fixed:

  • Fixed an issue where the camera preview and barcode scanner did not work the second time on web.

Improvements:

  • [web] Migrates to extension types. (thanks @koji-1009 !)

5.0.0-beta.2

Bugs fixed:

  • Fixed an issue where the scan window was not updated when its size was changed. (thanks @navaronbracke !)

5.0.0-beta.1

BREAKING CHANGES:

  • The width and height of BarcodeCapture have been removed, in favor of size.
  • The raw attribute is now Object? instead of dynamic, so that it participates in type promotion.
  • The MobileScannerArguments class has been removed from the public API, as it is an internal type.
  • The cameraFacingOverride named argument for the start() method has been renamed to cameraDirection.
  • The analyzeImage function now correctly returns a BarcodeCapture? instead of a boolean.
  • The formats attribute of the MobileScannerController is now non-null.
  • The MobileScannerState enum has been renamed to MobileScannerAuthorizationState.
  • The various ValueNotifiers for the camera state have been removed. Use the value of the MobileScannerController instead.
  • The hasTorch getter has been removed. Instead, use the torch state of the controller's value. The TorchState enum now provides a new value for unavailable flashlights.
  • The autoStart attribute has been removed from the MobileScannerController. The controller should be manually started on-demand.
  • A controller is now required for the MobileScanner widget.
  • The onPermissionSet, onStart and onScannerStarted methods have been removed from the MobileScanner widget. Instead, await MobileScannerController.start().
  • The startDelay has been removed from the MobileScanner widget. Instead, use a delay between manual starts of one or more controllers.
  • The onDetect method has been removed from the MobileScanner widget. Instead, listen to MobileScannerController.barcodes directly.
  • The overlay widget of the MobileScanner has been replaced by a new property, overlayBuilder, which provides the constraints for the overlay.
  • The torch can no longer be toggled on the web, as this is only available for image tracks and not video tracks. As a result the torch state for the web will always be TorchState.unavailable.
  • The zoom scale can no longer be modified on the web, as this is only available for image tracks and not video tracks. As a result, the zoom scale will always be 1.0.

Improvements:

  • The MobileScannerController is now a ChangeNotifier, with MobileScannerState as its model.
  • The web implementation now supports alternate URLs for loading the barcode library.

4.0.1

Bugs fixed:

  • [iOS] Fixed a crash with a nil capture session when starting the camera. (thanks @navaronbracke !)

4.0.0

BREAKING CHANGES:

  • [Android] compileSdk has been upgraded to version 34.
  • [Android] Java version has been upgraded to version 17.

3.5.7

Improvements:

  • Updated js dependency together with other dependencies.
  • Reverted compileSdk version to 33 on Android. This update will be released under version 4.0.0.

3.5.6

Bugs fixed:

  • [web] Fixed a crash with the ZXing barcode format (thanks @hazzo!)
  • [web] Fixed stream controller not being closed on web.
  • [iOS] Fixed a crash with unsupported torch modes. (thanks @navaronbracke !)
  • [iOS] Fixed a crash with the camera discovery session. (thanks @navaronbracke !)

Improvements:

  • Upgrade camera dependencies on Android.
  • Upgrade compileSdk version to 34 on Android.
  • Add numberOfCameras parameter in MobileScannerArguments callback, which shows how many cameras there are available on Android.
  • [Android] Migrated to ResolutionSelector with ResolutionStrategy. You can opt in into the new selector by setting [useNewCameraSelector] in the [MobileScannerController] to true.

3.5.5

Bugs fixed:

  • Fixed a bug where the scanner would get stuck after denying permissions on Android. (thanks @navaronbracke !)

3.5.4

Bugs fixed:

  • Fixed a bug with an implicit conversion to integer for the scan timeout for iOS. (thanks @EArminjon !)

3.5.2

Improvements:

  • Updated to play-services-mlkit-barcode-scanning version 18.3.0

Bugs fixed:

  • Fixed the updateScanWindow() function not completing on Android and MacOS. (thanks @navaronbracke !)
  • Fixed some camera access issues, when the camera could have been null on Android. (thanks @navaronbracke !)
  • Fixed a crash on Android when there is no camera. (thanks @navaronbracke !)
  • Fixed a bug with the noDuplicates detection speed. (thanks @pgeof !)
  • Fixed a synchronization issue for the torch state. (thanks @navaronbracke !)

3.5.1

Improvements:

  • The type of an Address is now non-null.
  • The type of an Email is now non-null.
  • The phoneNumber of an SMS is now non-null.
  • The latitude and longitude of a GeoPoint are now non-null.
  • The phones and urls of ContactInfo are now non-null.
  • The url of a UrlBookmark is now non-null.
  • The type of Phone is now non-null.
  • The width and height of BarcodeCapture are now non-null.
  • The BarcodeCapture class now exposes a size.
  • The list of corners of a Barcode is now non-null.

Bugs fixed:

  • Fixed the default values for the format and type arguments of the Barcode constructor. These now use BarcodeFormat.unknown and BarcodeType.unknown, rather than BarcodeFormat.ean13 and BarcodeType.text. (thanks @navaronbracke !)
  • Fixed messages not being sent on the main thread for Android, iOS and MacOS. (thanks @navaronbracke !)

3.5.0

NOTE: From this version onwards, mobile_scanner requires Android projects to have a compileSdk of 34 (Android 14) or higher

New Features:

  • Added the option to switch between bundled and unbundled MLKit for Android. (thanks @woolfred !)
  • Added the option to specify the camera resolution for Android. (thanks @EArminjon !)
  • Added a sample with a scanner overlay. (thanks @Spyy004 !)

Bugs fixed:

  • Fixed the scan window calculation taking into account the widget coordinates, instead of the screen coordinates. (thanks @jlin5 !)
  • Fixed the scan window calculation returning wrong results. (thanks @MBulli !)
  • Fixed the BarcodeCapture format on MacOS. (thanks @ryanduffyne !)
  • Fixed the timeout for scanning on MacOS. (thanks @ryanduffyne !)
  • Fixed Android builds failing by downgrading from Kotlin 1.9.10 to 1.7.22. (thanks @vbuberen !)
  • Fixed images on iOS being rotated, resulting in bad detection rates. (thanks @EArminjon !)
  • Fixed scan timeout not working on iOS. (thanks @navaronbracke !)
  • Fixed a crash on iOS when the device is nil. (thanks @navaronbracke !)
  • Fixed a case of an unhandled exception when starting the scanner. (thanks @navaronbracke !)

Improvements:

  • Improved MacOS memory footprint by using a background queue. (thanks @ryanduffyne !)

3.4.1

  • Changed MediaQuery.sizeOf(context) to of(context).size for compatibility with older Flutter versions.

3.4.0

New Features:

  • This PR adds an option to add an overlay to the scanner which is only visible when the scanner has started. (thanks @svenopdehipt !)

Improvements:

  • fix a bug in the static interop binding of PhotoCapabilities (thanks @navaronbracke !)

  • [Web] add the corners from the ZXing result to the barcode on web (thanks @navaronbracke !)

  • update the example app web entrypoint to the latest template by running flutter create . --platforms=web (thanks @navaronbracke !)

  • add better handling for the case where scanning barcodes is unsupported (for example a desktop running the browser sample) (thanks @navaronbracke !)

  • [Web] fix the permission denied handling on the web, by using the NotAllowedError error message as defined by MDN (thanks @navaronbracke !)

  • add app bars with back buttons to the example app (so that you can go back easily) (thanks @navaronbracke !)

  • [iOS] Implements a fix from issue iOS After first QR Code Scan, When Scanning again, First Image stays on Camera buffer (thanks @FlockiiX !)

  • By dynamically adjusting the positioning and scaling of the scan window relative to the texture, the package ensures optimal coverage and alignment for scanning targets. (thanks @sdkysfzai !)

  • In the original package, If there are multiple barcode/qrcodes in the screen, the scan would randomly pick up any barcode/qrcode that shows in the screen, This upgrade fixes it and picks on the qrcode/barcode that is in the center of the camera. (thanks @sdkysfzai !)

  • In the original package if you changed the camera size, it would still pick scans even if the barcode are not shown in the screen, This issue is also fixed in the upgraded packaged. (thanks @sdkysfzai !)

  • [iOS] This removes a threading warning (and potentially jank). (thanks @ened !)

  • [Android] fix(ScanImage): fix android image result is not correct format and orientation (thanks @phanbaohuy96 !)

  • [iOS] Respect detectionTimeout on iOS devices, instead of arbitrarily waiting 10 frames (thanks @jorgenpt !)

  • [iOS] Don't start a second scan until the first one is done, to keep memory usage more fixed if the device is slow (thanks @jorgenpt !)

  • [Android] This PR ensure that the camera is not stopped in the callback. (thanks @g123k !)

  • [macOS] Fix some macOS build errors (thanks @svenopdehipt !)

  • [Android] Fixed an issue which caused the App Lifecycle States to not work correctly on Android. (thanks @androi7 !)

3.3.0

Bugs fixed:

  • Fixed bug where onDetect method was being called multiple times
  • [Android] Fix Gradle 8 compatibility by adding the namespace attribute to the build.gradle.

Improvements:

  • [Android] Upgraded camera2 dependency
  • Added zoomScale value notifier in MobileScannerController for the application to know the zoom scale value set actually. The value is notified from the native SDK(CameraX/AVFoundation).
  • Added resetZoomScale() in MobileScannerController to reset zoom ratio with 1x. Both Android and iOS, if the device have ultra-wide camera, calling setZoomScale with small value causes to use ultra-wide camera and may be diffcult to detect barcodes. resetZoomScale() is useful to use standard camera with zoom 1x. setZoomScale() with the specific value can realize same effect, but added resetZoomScale for avoiding floating point errors. The application can know what zoom scale value is selected actually by subscribing zoomScale above after calling resetZoomScale.
  • [iOS] Call resetZoomScale while starting scan. Android camera is initialized with a zoom of 1x, whereas iOS is initialized with the minimum zoom value, which causes to select the ultra-wide camera unintentionally ([iOS] Impossible to focus and scan the QR code due to picking the wide back camera #554). Fixed this issue by calling resetZoomScale
  • [iOS] Remove zoom animation with ramp function to match Android behavior.

3.2.0

Improvements:

  • [iOS] Updated GoogleMLKit/BarcodeScanning to 4.0.0
  • [Android] Updated com.google.mlkit:barcode-scanning from 17.0.3 to 17.1.0

Bugs fixed:

  • Fixed onDetect not working with analyzeImage when autoStart is false in MobileScannerController
  • [iOS] Explicit returned type for compactMap

3.1.1

Bugs fixed:

  • [iOS] Fixed a bug that caused a crash when switching from camera.

3.1.0

Improvements:

  • [iOS] No longer automatically focus on faces.
  • [iOS] Fixed build error.
  • [Web] Waiting for js libs to load.
  • Do not returnImage if not specified.
  • Added raw data in barcode object.
  • Fixed several bugs.

3.0.0

This big release contains all improvements from the beta releases. In addition to that, this release contains:

Improvements:

  • Fixed an issue in which the scanner would freeze if two scanner widgets where placed in a page view, and the paged was swiped. An example has been added in the example app. You need to set startDelay: true if used in a page view.
  • [Web] Automatically inject js libraries.
  • [macOS] The minimum build version is now macOS 10.14 in according to the latest Flutter version.
  • [Android] Fixed an issue in which the scanWindow would remain even after disposing the scanner.
  • Updated dependencies.

3.0.0-beta.4

Fixes:

  • Fixes a permission bug on Android where denying the permission would cause an infinite loop of permission requests.
  • Updates the example app to handle permission errors with the new builder parameter. Now it no longer throws uncaught exceptions when the permission is denied.
  • Updated several dependencies

Features:

  • Added a new errorBuilder to the MobileScanner widget that can be used to customize the error state of the preview. (Thanks @navaronbracke !)

3.0.0-beta.3

Deprecated:

  • The onStart method has been renamed to onScannerStarted.
  • The onPermissionSet argument of the MobileScannerController is now deprecated.

BREAKING CHANGES:

  • MobileScannerException now uses an errorCode instead of a message.
  • MobileScannerException now contains additional details from the original error.
  • Refactored MobileScannerController.start() to throw MobileScannerExceptions with consistent error codes, rather than string messages. To handle permission errors, consider catching the result of MobileScannerController.start().
  • The autoResume attribute has been removed from the MobileScanner widget. The controller already automatically resumes, so it had no effect.
  • Removed MobileScannerCallback and MobileScannerArgumentsCallback typedef.
  • [Web] Replaced jsqr library with zxing-js for full barcode support.

Improvements:

  • Toggling the device torch now does nothing if the device has no torch, rather than throwing an error.
  • Removed called stop while already stopped messages.

Features:

  • You can now provide a scanWindow to the MobileScanner() widget.
  • You can now draw an overlay over the scanned barcode. See the barcode scanner window in the example app for more information.
  • Added a new placeholderBuilder function to the MobileScanner widget to customize the preview placeholder.
  • Added autoStart parameter to MobileScannerController(). If set to false, controller won't start automatically.
  • Added hasTorch function on MobileScannerController(). After starting the controller, you can check if the device has a torch.
  • [iOS] Support torchEnabled parameter from MobileScannerController() on iOS
  • [Web] Added ability to use custom barcode scanning js libraries by extending WebBarcodeReaderBase class and changing barCodeReader property in MobileScannerWebPlugin

Fixes:

  • Fixes the missing gradle setup for the Android project, which prevented gradle sync from working.
  • Fixes MobileScannerController.stop() throwing when already stopped.
  • Fixes MobileScannerController.toggleTorch() throwing if the device has no torch. Now it does nothing if the torch is not available.
  • Fixes a memory leak where the MobileScanner would keep listening to the barcode events.
  • Fixes the MobileScanner preview depending on all attributes of MediaQueryData. Now it only depends on its layout constraints.
  • Fixed a potential crash when the scanner is restarted due to the app being resumed.
  • [iOS] Fix crash when changing torch state

3.0.0-beta.2

BREAKING CHANGES:

  • The arguments parameter of onDetect is removed. The data is now returned by the onStart callback in the MobileScanner widget.
  • onDetect now returns the object BarcodeCapture, which contains a List of barcodes and, if enabled, an image.
  • allowDuplicates is removed and replaced by MobileScannerSpeed enum.
  • onPermissionSet in MobileScanner widget is deprecated and will be removed. Use the onPermissionSet onPermissionSet callback in MobileScannerController instead.
  • [iOS] The minimum deployment target is now 11.0 or higher.

Features:

  • The returnImage is working for both iOS and Android. You can enable it in the MobileScannerController. The image will be returned in the BarcodeCapture object provided by onDetect.
  • You can now control the DetectionSpeed, as well as the timeout of the DetectionSpeed. For more info see the DetectionSpeed documentation. This replaces the allowDuplicates function.

Other improvements:

  • Both the [iOS] and [Android] codebases have been refactored completely.
  • [iOS] Updated POD dependencies

3.0.0-beta.1

BREAKING CHANGES:

  • [Android] SDK updated to SDK 33.

Features:

  • [Web] Add binaryData for raw value.
  • [iOS] Captures the last scanned barcode with Barcode.image.
  • [iOS] Add support for multiple formats on iOS with BarcodeScannerOptions.
  • Add displayValue which returns barcode value in a user-friendly format.
  • Add autoResume option to MobileScannerController which automatically resumes the camera when the application is resumed

Other changes:

  • [Android] Revert camera2 dependency to stable release
  • [iOS] Update barcode scanning library to latest version
  • Several minor code improvements

2.0.0

BREAKING CHANGES:

This version is only compatible with flutter 3.0.0 and later.

1.1.2-play-services

This version uses the MLKit play-services model on Android in order to save space. With the example app, this version reduces the release version from 14.9MB to 7MB. More information: https://developers.google.com/ml-kit/vision/barcode-scanning/android

1.1.2

This version is the last version that will run on Flutter 2.x

Bugfixes:

  • Changed onDetect to be mandatory.

1.1.1-play-services

This version uses the MLKit play-services model on Android in order to save space. With the example app, this version reduces the release version from 14.9MB to 7MB. More information: https://developers.google.com/ml-kit/vision/barcode-scanning/android

1.1.1

Bugfixes:

  • Add null checks for Android.
  • Update camera dependency for Android.
  • Fix return type for analyzeImage.
  • Add fixes for Flutter 3.

1.1.0

Bugfixes:

  • Fix for 'stream already listened to' exception.
  • Fix building on Android with latest Flutter version.
  • Add several WEB improvements.
  • Upgraded several dependencies.

1.0.0

BREAKING CHANGES:

This version adds a new allowDuplicates option which now defaults to FALSE. this means that it will only call onDetect once after a scan. If you still want duplicates, you can set allowDuplicates to true. This also means that you don't have to check for duplicates yourself anymore.

New features:

  • We now have web support! Keep in mind that only QR codes are supported right now.

Bugfixes:

  • Fixed hot reload not working.
  • Fixed Navigator.of(context).pop() not working in the example app due to duplicate MaterialApp declaration.
  • Fixed iOS MLKit version not resolving the latest version.
  • Updated all dependencies

0.2.0

You can provide a path to controller.analyzeImage(path) in order to scan a local photo from the gallery! Check out the example app to see how you can use the image_picker plugin to retrieve a photo from the gallery. Please keep in mind that this feature is only supported on Android and iOS.

Another feature that has been added is a format selector! Just keep in mind that iOS for now only supports 1 selected barcode.

0.1.3

  • Fixed crash after asking permission. #29
  • Upgraded cameraX from 1.1.0-beta01 to 1.1.0-beta02

0.1.2

  • MobileScannerArguments is now exported. #7

Bugfixes:

  • Fixed application crashing when stop() or start() is called multiple times. #5
  • Fixes controller not being disposed correctly. #23
  • Catch error when no camera is found. #19

0.1.1

mobile_scanner is now compatible with sdk >= 2.12 and flutter >= 2.2.0

0.1.0

We now have MacOS support using Apple's Vision framework! Keep in mind that for now, only the raw value of the barcode object is supported.

Bugfixes:

  • Fixed a crash when dispose is called in a overridden method. #5

0.0.3

  • Added some API docs and README
  • Updated the example app

0.0.2

Fixed on iOS:

  • You can now set the torch
  • You can select the camera you want to use

0.0.1

Initial release! Things working on Android:

  • Scanning barcodes using the latest version of MLKit and CameraX!
  • Switching camera's
  • Toggling of the torch (flash)

Things working on iOS:

  • Scanning barcodes using the latest version of MLKit and AVFoundation!

Installing

export PUB_HOSTED_URL=https://pub.mirror.p-hatan.com
flutter pub add 'mobile_scanner:7.3.0'
pubspec.yaml
name: mobile_scanner
description: A universal Flutter barcode and QR code scanner using CameraX/ML Kit for Android, AVFoundation/Apple Vision for iOS & macOS, and ZXing for web.
version: 7.3.0
repository: https://github.com/juliansteenbakker/mobile_scanner

screenshots:
- description: 'Mobile Scanner Example'
  path: example/screenshots/example_advanced.png
- description: 'Mobile Scanner Example Settings'
  path: example/screenshots/example_advanced_settings.png
- description: 'Mobile Scanner Example Homepage'
  path: example/screenshots/homepage.png

environment:
  sdk: ">=3.7.0 <4.0.0"
  flutter: ">=3.29.0"

dependencies:
  collection: ">=1.15.0 <2.0.0"
  flutter:
    sdk: flutter
  flutter_web_plugins:
    sdk: flutter
  meta: ">=1.16.0 <2.0.0"
  plugin_platform_interface: ^2.0.2
  web: ">=0.5.1 <2.0.0"

dev_dependencies:
  flutter_test:
    sdk: flutter
  very_good_analysis: ">=8.0.0 <11.0.0"

flutter:
  plugin:
    platforms:
      android:
        package: dev.steenbakker.mobile_scanner
        pluginClass: MobileScannerPlugin
      ios:
        pluginClass: MobileScannerPlugin
        sharedDarwinSource: true
      macos:
        pluginClass: MobileScannerPlugin
        sharedDarwinSource: true
      web:
        pluginClass: MobileScannerWeb
        fileName: src/web/mobile_scanner_web.dart

Version history

VersionPublishedArchiveSHA-256
0.0.1On demandDownload3231c903…23f381
0.0.2On demandDownload6653efdf…44da88
0.0.3On demandDownloada15dd2f3…3b7b10
0.1.0On demandDownloadba638fdc…0e0cc9
0.1.1On demandDownloadbf2def43…573a15
0.1.2On demandDownload21e678cd…92fe9f
0.1.3On demandDownload8c9eecda…1fb477
0.2.0On demandDownload8d32ad18…41edee
1.0.0On demandDownload84b493ce…c6a4c4
1.1.0On demandDownloadff3a7194…228f19
1.1.1-play-servicesOn demandDownload37749ed3…66bd76
1.1.1On demandDownloadc55f64de…356076
1.1.2-play-servicesOn demandDownload52c6faec…68780c
1.1.2On demandDownload8c88f807…f77363
2.0.0-play-servicesOn demandDownloadb6d5dc68…92e6c8
2.0.0On demandDownload9831cd34…985963
2.1.0On demandDownload53172545…113928
3.0.0-beta.1On demandDownload5005bbfa…229547
3.0.0-beta.2On demandDownload65400553…ced4ad
3.0.0-beta.3On demandDownload889c43af…f11f96
3.0.0-beta.4On demandDownloadd0824e90…d66704
3.0.0On demandDownload4045e844…687345
3.1.0On demandDownload441ac8d3…8f838a
3.1.1On demandDownloadbcc0926b…293b3a
3.2.0On demandDownloadda55204e…2d296f
3.3.0On demandDownload54dd914e…344c4b
3.4.0On demandDownload9b3d6fb0…d6eca9
3.4.1On demandDownload2fbc3914…5d44ff
3.5.0On demandDownloadd1ce638a…4afe54
3.5.1On demandDownloadc7b81985…ebfe99
3.5.2On demandDownloadcf978740…bc42ee
3.5.3On demandDownloadbcaf6a6b…ea5805
3.5.4On demandDownloadc9ed2bb1…9b3a23
3.5.5On demandDownloadc3e5bba1…ff9b74
3.5.6On demandDownload190506c3…bf20d0
3.5.7On demandDownload1b60b8f9…e0d5b3
4.0.0On demandDownload619ed5fd…9d49dc
4.0.1On demandDownload827765af…336312
5.0.0-beta.1On demandDownload57173d1c…c77c54
5.0.0-beta.2On demandDownload9b52f2ff…37f883
5.0.0-beta.3On demandDownload2c36ff10…6f0d83
5.0.0On demandDownload3e11ee91…3bedd1
5.0.1On demandDownloadf34c8319…b96be4
5.0.2On demandDownload75bb4f87…8f0a7b
5.1.0On demandDownload4e30d37f…8e3835
5.1.1On demandDownloadb8c0e9af…607926
5.2.0On demandDownload2c0ef178…26ad9f
5.2.1On demandDownload6ac2913a…1e9ee1
5.2.2On demandDownload82c9beb8…5acd9b
5.2.3On demandDownloadd234581c…9fb760
6.0.0On demandDownload145500ef…fd8b40
6.0.1On demandDownloade9346129…3767d6
6.0.2On demandDownload728828a7…6cdaad
6.0.3On demandDownload57d6269d…40a319
6.0.4On demandDownload7b3b0314…e1a853
6.0.5On demandDownload8b4d42bb…7014f0
6.0.6On demandDownload91d28b82…2130fd
6.0.7On demandDownload9cb9e371…35dbd1
6.0.8On demandDownloadc146c012…159453
6.0.9On demandDownloadf3091326…6cce2f
6.0.10On demandDownloadf536c5b8…666826
6.0.11On demandDownload0b466a0a…ba3173
7.0.0-beta.1On demandDownload1eff721c…c06c26
7.0.0-beta.2On demandDownload0bcadbd7…b639e3
7.0.0-beta.3On demandDownloaddd2d1638…93b48e
7.0.0-beta.4On demandDownload1779bf86…2dd01e
7.0.0-beta.5On demandDownloadf2f76d06…dad15b
7.0.0-beta.6On demandDownload16a892a9…7ec1f8
7.0.0-beta.7On demandDownloadf4880270…e9a5cc
7.0.0-beta.8On demandDownloade301258b…46f09c
7.0.0-beta.9On demandDownload8676156e…0bc917
7.0.0-rc.1On demandDownload1e2888e6…54180d
7.0.0-rc.2On demandDownload4ef3eb57…441c59
7.0.0On demandDownload72f06a07…033a8c
7.0.1On demandDownload54005bde…4ebc95
7.1.0On demandDownloadcafc6f1c…41efe9
7.1.1On demandDownload985159e9…e0b3a8
7.1.2On demandDownload5e7e09d9…e62ecf
7.1.3On demandDownload023a71af…69c5f2
7.1.4On demandDownloadc6184bf2…d41044
7.2.0On demandDownloadc92c26bf…6171ce
7.2.1On demandDownload30f7dc34…7d1615
7.3.0Cached · Upstream SHA-256 matchedDownload59ad810a…82ba4b
7.4.0On demandDownloadce3f059e…d55bce
7.4.1On demandDownload6b943ee3…d2286f
7.4.2On demandDownload5a51ea79…0bade0
7.4.3On demandDownload5ef34347…650050

Dependencies

collection "\u003e=1.15.0 \u003c2.0.0"

flutter { "sdk": "flutter" }

flutter_web_plugins { "sdk": "flutter" }

meta "\u003e=1.16.0 \u003c2.0.0"

plugin_platform_interface "^2.0.2"

web "\u003e=0.5.1 \u003c2.0.0"