imp: add docs, update flutter side to match native code.

-## NEXT
+## 3.0.0-beta.2
 Breaking changes:
 Breaking changes:
+* The arguments parameter of onDetect is removed. The data is now returned by the onStart callback
+in the MobileScanner widget.
+* 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.
 * [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
 * [iOS] Updated POD dependencies
 
 
 ## 3.0.0-beta.1
 ## 3.0.0-beta.1

@@ -19,6 +19,12 @@ class _BarcodeListScannerWithControllerState
     torchEnabled: true,
     torchEnabled: true,
     // formats: [BarcodeFormat.qrCode]
     // formats: [BarcodeFormat.qrCode]
     // facing: CameraFacing.front,
     // facing: CameraFacing.front,
+    onPermissionSet: (hasPermission) {
+      // Do something with permission callback
+    },
+    // detectionSpeed: DetectionSpeed.normal
+    // detectionTimeoutMs: 1000,
+    // returnImage: false,
   );
   );
 
 
   bool isStarted = true;
   bool isStarted = true;
@@ -34,16 +40,18 @@ class _BarcodeListScannerWithControllerState
               MobileScanner(
               MobileScanner(
                 controller: controller,
                 controller: controller,
                 fit: BoxFit.contain,
                 fit: BoxFit.contain,
-                // allowDuplicates: true,
                 // controller: MobileScannerController(
                 // controller: MobileScannerController(
                 //   torchEnabled: true,
                 //   torchEnabled: true,
                 //   facing: CameraFacing.front,
                 //   facing: CameraFacing.front,
                 // ),
                 // ),
-                onDetect: (barcodeCapture, arguments) {
+                onDetect: (barcodeCapture) {
                   setState(() {
                   setState(() {
                     this.barcodeCapture = barcodeCapture;
                     this.barcodeCapture = barcodeCapture;
                   });
                   });
                 },
                 },
+                onStart: (arguments) {
+                  // Do something with start arguments
+                },
               ),
               ),
               Align(
               Align(
                 alignment: Alignment.bottomCenter,
                 alignment: Alignment.bottomCenter,

@@ -16,9 +16,15 @@ class _BarcodeScannerWithControllerState
   BarcodeCapture? barcode;
   BarcodeCapture? barcode;
 
 
   MobileScannerController controller = MobileScannerController(
   MobileScannerController controller = MobileScannerController(
-    torchEnabled: true, detectionSpeed: DetectionSpeed.unrestricted,
+    torchEnabled: true,
     // formats: [BarcodeFormat.qrCode]
     // formats: [BarcodeFormat.qrCode]
     // facing: CameraFacing.front,
     // facing: CameraFacing.front,
+    onPermissionSet: (hasPermission) {
+      // Do something with permission callback
+    },
+    // detectionSpeed: DetectionSpeed.normal
+    // detectionTimeoutMs: 1000,
+    // returnImage: false,
   );
   );
 
 
   bool isStarted = true;
   bool isStarted = true;
@@ -34,12 +40,11 @@ class _BarcodeScannerWithControllerState
               MobileScanner(
               MobileScanner(
                 controller: controller,
                 controller: controller,
                 fit: BoxFit.contain,
                 fit: BoxFit.contain,
-                // allowDuplicates: true,
                 // controller: MobileScannerController(
                 // controller: MobileScannerController(
                 //   torchEnabled: true,
                 //   torchEnabled: true,
                 //   facing: CameraFacing.front,
                 //   facing: CameraFacing.front,
                 // ),
                 // ),
-                onDetect: (barcode, args) {
+                onDetect: (barcode) {
                   setState(() {
                   setState(() {
                     this.barcode = barcode;
                     this.barcode = barcode;
                   });
                   });

@@ -18,10 +18,15 @@ class _BarcodeScannerReturningImageState
   MobileScannerArguments? arguments;
   MobileScannerArguments? arguments;
 
 
   MobileScannerController controller = MobileScannerController(
   MobileScannerController controller = MobileScannerController(
-    // torchEnabled: true,
-    returnImage: true,
+    torchEnabled: true,
     // formats: [BarcodeFormat.qrCode]
     // formats: [BarcodeFormat.qrCode]
     // facing: CameraFacing.front,
     // facing: CameraFacing.front,
+    onPermissionSet: (hasPermission) {
+      // Do something with permission callback
+    },
+    // detectionSpeed: DetectionSpeed.normal
+    // detectionTimeoutMs: 1000,
+    returnImage: true,
   );
   );
 
 
   bool isStarted = true;
   bool isStarted = true;
@@ -29,15 +34,10 @@ class _BarcodeScannerReturningImageState
   @override
   @override
   Widget build(BuildContext context) {
   Widget build(BuildContext context) {
     return Scaffold(
     return Scaffold(
-      backgroundColor: Colors.black,
-      body: Builder(
-        builder: (context) {
-          return Column(
+        body: SafeArea(
+      child: Column(
         children: [
         children: [
-              Container(
-                color: Colors.blueGrey,
-                width: double.infinity,
-                height: 0.33 * MediaQuery.of(context).size.height,
+          Expanded(
             child: barcode?.image != null
             child: barcode?.image != null
                 ? Transform.rotate(
                 ? Transform.rotate(
                     angle: 90 * pi / 180,
                     angle: 90 * pi / 180,
@@ -47,31 +47,27 @@ class _BarcodeScannerReturningImageState
                       fit: BoxFit.contain,
                       fit: BoxFit.contain,
                     ),
                     ),
                   )
                   )
-                    : const ColoredBox(
-                        color: Colors.white,
-                        child: Center(
+                : const Center(
                     child: Text(
                     child: Text(
                       'Your scanned barcode will appear here!',
                       'Your scanned barcode will appear here!',
                     ),
                     ),
                   ),
                   ),
           ),
           ),
-              ),
-              Container(
-                height: 0.66 * MediaQuery.of(context).size.height,
+          Expanded(
+            flex: 2,
+            child: ColoredBox(
               color: Colors.grey,
               color: Colors.grey,
               child: Stack(
               child: Stack(
                 children: [
                 children: [
                   MobileScanner(
                   MobileScanner(
                     controller: controller,
                     controller: controller,
                     fit: BoxFit.contain,
                     fit: BoxFit.contain,
-                      // allowDuplicates: true,
                     // controller: MobileScannerController(
                     // controller: MobileScannerController(
                     //   torchEnabled: true,
                     //   torchEnabled: true,
                     //   facing: CameraFacing.front,
                     //   facing: CameraFacing.front,
                     // ),
                     // ),
-                      onDetect: (barcode, arguments) {
+                    onDetect: (barcode) {
                       setState(() {
                       setState(() {
-                          this.arguments = arguments;
                         this.barcode = barcode;
                         this.barcode = barcode;
                       });
                       });
                     },
                     },
@@ -169,10 +165,9 @@ class _BarcodeScannerReturningImageState
                 ],
                 ],
               ),
               ),
             ),
             ),
+          ),
         ],
         ],
-          );
-        },
       ),
       ),
-    );
+    ),);
   }
   }
 }
 }

@@ -24,8 +24,7 @@ class _BarcodeScannerWithoutControllerState
             children: [
             children: [
               MobileScanner(
               MobileScanner(
                 fit: BoxFit.contain,
                 fit: BoxFit.contain,
-                // allowDuplicates: false,
-                onDetect: (capture, arguments) {
+                onDetect: (capture) {
                   setState(() {
                   setState(() {
                     this.capture = capture;
                     this.capture = capture;
                   });
                   });

 library mobile_scanner;
 library mobile_scanner;
 
 
-export 'src/barcode.dart';
-export 'src/barcode_capture.dart';
 export 'src/enums/camera_facing.dart';
 export 'src/enums/camera_facing.dart';
 export 'src/enums/detection_speed.dart';
 export 'src/enums/detection_speed.dart';
 export 'src/enums/mobile_scanner_state.dart';
 export 'src/enums/mobile_scanner_state.dart';
 export 'src/enums/ratio.dart';
 export 'src/enums/ratio.dart';
 export 'src/enums/torch_state.dart';
 export 'src/enums/torch_state.dart';
 export 'src/mobile_scanner.dart';
 export 'src/mobile_scanner.dart';
-export 'src/mobile_scanner_arguments.dart';
 export 'src/mobile_scanner_controller.dart';
 export 'src/mobile_scanner_controller.dart';
+export 'src/objects/barcode.dart';
+export 'src/objects/barcode_capture.dart';
+export 'src/objects/mobile_scanner_arguments.dart';

@@ -2,11 +2,19 @@
 enum DetectionSpeed {
 enum DetectionSpeed {
   /// The scanner will only scan a barcode once, and never again until another
   /// The scanner will only scan a barcode once, and never again until another
   /// barcode has been scanned.
   /// barcode has been scanned.
+  ///
+  /// NOTE: This mode does analyze every frame in order to check if the value
+  /// has changed.
   noDuplicates,
   noDuplicates,
 
 
-  /// The barcode scanner will wait
+  /// The barcode scanner will scan one barcode, and wait 250 Miliseconds before
+  /// scanning again. This will prevent memory issues on older devices.
+  ///
+  /// You can change the timeout duration with [detectionTimeout] parameter.
   normal,
   normal,
 
 
-  /// Back facing camera.
+  /// Let the scanner detect barcodes without restriction.
+  ///
+  /// NOTE: This can cause memory issues with older devices.
   unrestricted,
   unrestricted,
 }
 }

-enum MobileScannerState { undetermined, authorized, denied }
+/// The authorization state of the scanner.
+enum MobileScannerState {
+  /// The scanner has yet to request weather it is [authorized] or [denied]
+  undetermined,
+
+  /// The scanner has the required permissions.
+  authorized,
+
+  /// The user denied the required permissions.
+  denied
+}

-enum Ratio { ratio_4_3, ratio_16_9 }
+// This enum is not used yet
+// enum Ratio { ratio_4_3, ratio_16_9 }

 import 'package:flutter/foundation.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/material.dart';
-import 'package:mobile_scanner/src/barcode_capture.dart';
-import 'package:mobile_scanner/src/mobile_scanner_arguments.dart';
 import 'package:mobile_scanner/src/mobile_scanner_controller.dart';
 import 'package:mobile_scanner/src/mobile_scanner_controller.dart';
+import 'package:mobile_scanner/src/objects/barcode_capture.dart';
+import 'package:mobile_scanner/src/objects/mobile_scanner_arguments.dart';
+
+typedef MobileScannerCallback = void Function(BarcodeCapture barcodes);
+typedef MobileScannerArgumentsCallback = void Function(
+  MobileScannerArguments? arguments,
+);
 
 
 /// A widget showing a live camera preview.
 /// A widget showing a live camera preview.
 class MobileScanner extends StatefulWidget {
 class MobileScanner extends StatefulWidget {
@@ -10,14 +15,21 @@ class MobileScanner extends StatefulWidget {
   final MobileScannerController? controller;
   final MobileScannerController? controller;
 
 
   /// Calls the provided [onPermissionSet] callback when the permission is set.
   /// Calls the provided [onPermissionSet] callback when the permission is set.
+  // @Deprecated('Use the [onPermissionSet] paremeter in the [MobileScannerController] instead.')
+  // ignore: deprecated_consistency
   final Function(bool permissionGranted)? onPermissionSet;
   final Function(bool permissionGranted)? onPermissionSet;
 
 
   /// Function that gets called when a Barcode is detected.
   /// Function that gets called when a Barcode is detected.
   ///
   ///
   /// [barcode] The barcode object with all information about the scanned code.
   /// [barcode] The barcode object with all information about the scanned code.
-  /// [startArguments] Information about the state of the MobileScanner widget
-  final Function(BarcodeCapture capture, MobileScannerArguments? arguments)
-      onDetect;
+  /// [startInternalArguments] Information about the state of the MobileScanner widget
+  final MobileScannerCallback onDetect;
+
+  /// Function that gets called when the scanner is started.
+  ///
+  /// [arguments] The start arguments of the scanner. This contains the size of
+  /// the scanner which can be used to draw a box over the scanner.
+  final MobileScannerArgumentsCallback? onStart;
 
 
   /// Handles how the widget should fit the screen.
   /// Handles how the widget should fit the screen.
   final BoxFit fit;
   final BoxFit fit;
@@ -29,9 +41,11 @@ class MobileScanner extends StatefulWidget {
   const MobileScanner({
   const MobileScanner({
     super.key,
     super.key,
     required this.onDetect,
     required this.onDetect,
+    this.onStart,
     this.controller,
     this.controller,
     this.autoResume = true,
     this.autoResume = true,
     this.fit = BoxFit.cover,
     this.fit = BoxFit.cover,
+    @Deprecated('Use the [onPermissionSet] paremeter in the [MobileScannerController] instead.')
         this.onPermissionSet,
         this.onPermissionSet,
   });
   });
 
 
@@ -49,7 +63,14 @@ class _MobileScannerState extends State<MobileScanner>
     WidgetsBinding.instance.addObserver(this);
     WidgetsBinding.instance.addObserver(this);
     controller = widget.controller ??
     controller = widget.controller ??
         MobileScannerController(onPermissionSet: widget.onPermissionSet);
         MobileScannerController(onPermissionSet: widget.onPermissionSet);
-    if (!controller.isStarting) controller.start();
+    if (!controller.isStarting) {
+      _startScanner();
+    }
+  }
+
+  Future<void> _startScanner() async {
+    final arguments = await controller.start();
+    widget.onStart?.call(arguments);
   }
   }
 
 
   bool resumeFromBackground = false;
   bool resumeFromBackground = false;
@@ -64,7 +85,7 @@ class _MobileScannerState extends State<MobileScanner>
     switch (state) {
     switch (state) {
       case AppLifecycleState.resumed:
       case AppLifecycleState.resumed:
         resumeFromBackground = false;
         resumeFromBackground = false;
-        controller.start();
+        _startScanner();
         break;
         break;
       case AppLifecycleState.paused:
       case AppLifecycleState.paused:
         resumeFromBackground = true;
         resumeFromBackground = true;
@@ -87,7 +108,7 @@ class _MobileScannerState extends State<MobileScanner>
           return const ColoredBox(color: Colors.black);
           return const ColoredBox(color: Colors.black);
         } else {
         } else {
           controller.barcodes.listen((barcode) {
           controller.barcodes.listen((barcode) {
-            widget.onDetect(barcode, value! as MobileScannerArguments);
+            widget.onDetect(barcode);
           });
           });
           return ClipRect(
           return ClipRect(
             child: SizedBox(
             child: SizedBox(

@@ -30,7 +30,8 @@ class MobileScannerController {
         .listen((data) => _handleEvent(data as Map));
         .listen((data) => _handleEvent(data as Map));
   }
   }
 
 
-  //Must be static to keep the same value on new instances
+  /// The hashcode of the controller to check if the correct object is mounted.
+  /// Must be static to keep the same value on new instances
   static int? controllerHashcode;
   static int? controllerHashcode;
 
 
   /// Select which camera should be used.
   /// Select which camera should be used.
@@ -56,6 +57,11 @@ class MobileScannerController {
   /// WARNING: DetectionSpeed.unrestricted can cause memory issues on some devices
   /// WARNING: DetectionSpeed.unrestricted can cause memory issues on some devices
   final DetectionSpeed detectionSpeed;
   final DetectionSpeed detectionSpeed;
 
 
+  /// Sets the timeout of scanner.
+  /// The timeout is set in miliseconds.
+  ///
+  /// NOTE: The timeout only works if the [detectionSpeed] is set to
+  /// [DetectionSpeed.normal] (which is the default value).
   final int detectionTimeoutMs;
   final int detectionTimeoutMs;
 
 
   /// Sets the barcode stream
   /// Sets the barcode stream
@@ -85,6 +91,7 @@ class MobileScannerController {
       ValueNotifier(facing);
       ValueNotifier(facing);
 
 
   bool isStarting = false;
   bool isStarting = false;
+
   bool? _hasTorch;
   bool? _hasTorch;
 
 
   /// Set the starting arguments for the camera
   /// Set the starting arguments for the camera
@@ -113,9 +120,9 @@ class MobileScannerController {
   Future<MobileScannerArguments?> start({
   Future<MobileScannerArguments?> start({
     CameraFacing? cameraFacingOverride,
     CameraFacing? cameraFacingOverride,
   }) async {
   }) async {
-    debugPrint('Hashcode controller: $hashCode');
     if (isStarting) {
     if (isStarting) {
       debugPrint("Called start() while starting.");
       debugPrint("Called start() while starting.");
+      return null;
     }
     }
     isStarting = true;
     isStarting = true;
 
 
@@ -152,10 +159,10 @@ class MobileScannerController {
       );
       );
     } on PlatformException catch (error) {
     } on PlatformException catch (error) {
       debugPrint('${error.code}: ${error.message}');
       debugPrint('${error.code}: ${error.message}');
-      isStarting = false;
       if (error.code == "MobileScannerWeb") {
       if (error.code == "MobileScannerWeb") {
         onPermissionSet?.call(false);
         onPermissionSet?.call(false);
       }
       }
+      isStarting = false;
       return null;
       return null;
     }
     }
 
 
@@ -172,28 +179,25 @@ class MobileScannerController {
     }
     }
 
 
     if (kIsWeb) {
     if (kIsWeb) {
+      // If we reach this line, it means camera permission has been granted
       onPermissionSet?.call(
       onPermissionSet?.call(
         true,
         true,
-      ); // If we reach this line, it means camera permission has been granted
+      );
+    }
 
 
-      startArguments.value = MobileScannerArguments(
-        webId: startResult['ViewID'] as String?,
-        size: Size(
+    isStarting = false;
+    return startArguments.value = MobileScannerArguments(
+      size: kIsWeb
+          ? Size(
               startResult['videoWidth'] as double? ?? 0,
               startResult['videoWidth'] as double? ?? 0,
               startResult['videoHeight'] as double? ?? 0,
               startResult['videoHeight'] as double? ?? 0,
-        ),
-        hasTorch: _hasTorch!,
-      );
-    } else {
-      startArguments.value = MobileScannerArguments(
-        textureId: startResult['textureId'] as int?,
-        size: toSize(startResult['size'] as Map? ?? {}),
+            )
+          : toSize(startResult['size'] as Map? ?? {}),
       hasTorch: _hasTorch!,
       hasTorch: _hasTorch!,
+      textureId: kIsWeb ? null : startResult['textureId'] as int?,
+      webId: kIsWeb ? startResult['ViewID'] as String? : null,
     );
     );
   }
   }
-    isStarting = false;
-    return startArguments.value!;
-  }
 
 
   /// Stops the camera, but does not dispose this controller.
   /// Stops the camera, but does not dispose this controller.
   Future<void> stop() async {
   Future<void> stop() async {

@@ -12,11 +12,6 @@ class Barcode {
   /// Returns null if the corner points can not be determined.
   /// Returns null if the corner points can not be determined.
   final List<Offset>? corners;
   final List<Offset>? corners;
 
 
-  /// Returns raw bytes of the image buffer
-  ///
-  /// Returns null if the image was not returned
-  final Uint8List? image;
-
   /// Returns barcode format
   /// Returns barcode format
   final BarcodeFormat format;
   final BarcodeFormat format;
 
 
@@ -79,7 +74,6 @@ class Barcode {
 
 
   Barcode({
   Barcode({
     this.corners,
     this.corners,
-    this.image,
     this.format = BarcodeFormat.ean13,
     this.format = BarcodeFormat.ean13,
     this.rawBytes,
     this.rawBytes,
     this.type = BarcodeType.text,
     this.type = BarcodeType.text,
@@ -97,7 +91,7 @@ class Barcode {
   });
   });
 
 
   /// Create a [Barcode] from native data.
   /// Create a [Barcode] from native data.
-  Barcode.fromNative(Map data, {this.image})
+  Barcode.fromNative(Map data)
       : corners = toCorners(data['corners'] as List?),
       : corners = toCorners(data['corners'] as List?),
         format = toFormat(data['format'] as int),
         format = toFormat(data['format'] as int),
         rawBytes = data['rawBytes'] as Uint8List?,
         rawBytes = data['rawBytes'] as Uint8List?,

 import 'dart:typed_data';
 import 'dart:typed_data';
 
 
-import 'package:mobile_scanner/src/barcode.dart';
+import 'package:mobile_scanner/src/objects/barcode.dart';
 
 
+/// The return object after a frame is scanned.
+///
+/// [barcodes] A list with barcodes. A scanned frame can contain multiple
+/// barcodes.
+/// [image] If enabled, an image of the scanned frame.
 class BarcodeCapture {
 class BarcodeCapture {
-  List<Barcode> barcodes;
-  Uint8List? image;
+  final List<Barcode> barcodes;
+
+  final Uint8List? image;
 
 
   BarcodeCapture({
   BarcodeCapture({
     required this.barcodes,
     required this.barcodes,

 import 'package:flutter/material.dart';
 import 'package:flutter/material.dart';
 
 
-/// Camera args for [CameraView].
+/// The start arguments of the scanner.
 class MobileScannerArguments {
 class MobileScannerArguments {
-  /// The texture id.
-  final int? textureId;
-
-  /// Size of the texture.
+  /// The output size of the camera.
+  /// This value can be used to draw a box in the image.
   final Size size;
   final Size size;
 
 
+  /// A bool which is true if the device has a torch.
   final bool hasTorch;
   final bool hasTorch;
 
 
+  /// The texture id of the capture used internally.
+  final int? textureId;
+
+  /// The texture id of the capture used internally if device is web.
   final String? webId;
   final String? webId;
 
 
-  /// Create a [MobileScannerArguments].
   MobileScannerArguments({
   MobileScannerArguments({
-    this.textureId,
     required this.size,
     required this.size,
     required this.hasTorch,
     required this.hasTorch,
+    this.textureId,
     this.webId,
     this.webId,
   });
   });
 }
 }

 name: mobile_scanner
 name: mobile_scanner
 description: A universal barcode and QR code scanner for Flutter based on MLKit. Uses CameraX on Android, AVFoundation on iOS and Apple Vision & AVFoundation on macOS.
 description: A universal barcode and QR code scanner for Flutter based on MLKit. Uses CameraX on Android, AVFoundation on iOS and Apple Vision & AVFoundation on macOS.
-version: 3.0.0-beta.1
+version: 3.0.0-beta.2
 repository: https://github.com/juliansteenbakker/mobile_scanner
 repository: https://github.com/juliansteenbakker/mobile_scanner
 
 
 environment:
 environment: