MLKIT Barcode scanning no beep on scan #1174

Author: EddyVerbruggen

demo-ng/app/App_Resources/iOS/build.xcconfig

@@ -9,3 +9,5 @@ IPHONEOS_DEPLOYMENT_TARGET = 10.0
 
 // Don't check this in because of CI
 // DEVELOPMENT_TEAM = 8Q5F6M3TNS
+
+DEVELOPMENT_TEAM = 8Q5F6M3TNS

demo-ng/package.json

@@ -25,7 +25,7 @@
     "nativescript-angular": "^6.1.0",
     "nativescript-camera": "~4.1.1",
     "nativescript-imagepicker": "~6.0.5",
-    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-8.0.1.tgz",
+    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-8.1.0.tgz",
     "nativescript-theme-core": "~1.0.4",
     "reflect-metadata": "~0.1.10",
     "rxjs": "~6.0.0 || >=6.1.0",
@@ -43,4 +43,4 @@
     "nativescript-dev-webpack": "^0.15.1",
     "typescript": "~2.8.0"
   }
-}
+}

demo-push/package.json

@@ -9,7 +9,7 @@
     }
   },
   "dependencies": {
-    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-8.0.1.tgz",
+    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-8.1.0.tgz",
     "nativescript-theme-core": "^1.0.4",
     "nativescript-unit-test-runner": "^0.3.4",
     "tns-core-modules": "~4.2.0"

demo-vue/package.json

@@ -14,7 +14,7 @@
     }
   },
   "dependencies": {
-    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-8.0.1.tgz",
+    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-8.1.0.tgz",
     "nativescript-theme-core": "^1.0.4",
     "nativescript-vue": "^2.0.0",
     "tns-core-modules": "^5.0.2"

demo/package.json

@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "firebase-functions": "^2.0.5",
-    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-8.0.1.tgz",
+    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-8.1.0.tgz",
     "nativescript-theme-core": "^1.0.4",
     "nativescript-unit-test-runner": "^0.3.4",
     "tns-core-modules": "~5.2.0"

src/mlkit/barcodescanning/index.android.ts

@@ -2,20 +2,60 @@ import { ImageSource } from "tns-core-modules/image-source";
 import { MLKitScanBarcodesOnDeviceOptions, MLKitScanBarcodesOnDeviceResult, MLKitScanBarcodesResultBounds } from "./";
 import { MLKitVisionOptions } from "../index";
 import { BarcodeFormat, MLKitBarcodeScanner as MLKitBarcodeScannerBase } from "./barcodescanning-common";
+import * as application from "tns-core-modules/application";
 
 export { BarcodeFormat };
 
 const gmsTasks = (<any>com.google.android.gms).tasks;
 
 export class MLKitBarcodeScanner extends MLKitBarcodeScannerBase {
 
+  private player: android.media.MediaPlayer;
+
+  disposeNativeView(): void {
+    super.disposeNativeView();
+    if (this.player) {
+      this.player.release();
+      this.player = undefined;
+    }
+  }
+
   protected createDetector(): any {
     let formats: Array<BarcodeFormat>;
     if (this.formats) {
       formats = [];
       const requestedFormats = this.formats.split(",");
       requestedFormats.forEach(format => formats.push(BarcodeFormat[format.trim().toUpperCase()]))
     }
+
+    if (this.beepOnScan) {
+      const activity = (application.android.foregroundActivity || application.android.startActivity);
+      activity.setVolumeControlStream(android.media.AudioManager.STREAM_MUSIC);
+      try {
+        const file = application.android.context.getResources().getIdentifier("beep", "raw", application.android.context.getPackageName());
+        if (file === 0) {
+          console.log("No 'beep.*' soundfile found in the resources /raw folder. There will be no audible feedback upon scanning a barcode.");
+        } else {
+          this.player = new android.media.MediaPlayer();
+          const fileDescriptor: android.content.res.AssetFileDescriptor = application.android.context.getResources().openRawResourceFd(file);
+          try {
+            this.player.setDataSource(fileDescriptor.getFileDescriptor(), fileDescriptor.getStartOffset(), fileDescriptor.getLength());
+          } finally {
+            fileDescriptor.close();
+          }
+          // this.mediaPlayer.setOnErrorListener(this);
+          this.player.setAudioStreamType(android.media.AudioManager.STREAM_MUSIC);
+          this.player.setLooping(false);
+          this.player.setVolume(0.10, 0.10);
+          this.player.prepare();
+        }
+      } catch (e) {
+        console.log(e);
+        this.player.release();
+        this.player = undefined;
+      }
+    }
+
     return getBarcodeDetector(formats);
   }
 
@@ -27,7 +67,7 @@ export class MLKitBarcodeScanner extends MLKitBarcodeScannerBase {
           barcodes: []
         };
 
-        if (barcodes) {
+        if (barcodes && barcodes.size() > 0) {
           // see https://github.com/firebase/quickstart-android/blob/0f4c86877fc5f771cac95797dffa8bd026dd9dc7/mlkit/app/src/main/java/com/google/firebase/samples/apps/mlkit/textrecognition/TextRecognitionProcessor.java#L62
           for (let i = 0; i < barcodes.size(); i++) {
             const barcode = barcodes.get(i);
@@ -38,6 +78,10 @@ export class MLKitBarcodeScanner extends MLKitBarcodeScannerBase {
               bounds: boundingBoxToBounds(barcode.getBoundingBox())
             });
           }
+
+          if (this.player) {
+            this.player.start();
+          }
         }
 
         this.notify({

src/mlkit/barcodescanning/index.d.ts

@@ -33,6 +33,18 @@ export interface MLKitScanBarcodesOnDeviceOptions extends MLKitVisionOptions {
    * If not set, we'll detect all supported formats.
    */
   formats?: Array<BarcodeFormat>;
+
+  /**
+   * Play a sound when a code was scanned.
+   * Default: true
+   */
+  beepOnScan?: boolean;
+
+  /**
+   * Wheter or not to report duplicate scan results during continuous scanning.
+   * Default false.
+   */
+  reportDuplicates?: boolean;
 }
 
 export declare function scanBarcodesOnDevice(options: MLKitScanBarcodesOnDeviceOptions): Promise<MLKitScanBarcodesOnDeviceResult>;

src/mlkit/barcodescanning/index.ios.ts

@@ -7,13 +7,28 @@ export { BarcodeFormat };
 
 export class MLKitBarcodeScanner extends MLKitBarcodeScannerBase {
 
+  private player: AVAudioPlayer;
+
   protected createDetector(): any {
     let formats: Array<BarcodeFormat>;
     if (this.formats) {
       formats = [];
       const requestedFormats = this.formats.split(",");
       requestedFormats.forEach(format => formats.push(BarcodeFormat[format.trim().toUpperCase()]))
     }
+
+    if (this.beepOnScan) {
+      // play nice with others when playing sound
+      AVAudioSession.sharedInstance().setCategoryModeOptionsError(AVAudioSessionCategoryPlayback, AVAudioSessionModeDefault, AVAudioSessionCategoryOptions.MixWithOthers)
+
+      // prepare an audio player, with a sound file bundled in our custom fwk
+      const barcodeBundlePath = NSBundle.bundleWithIdentifier("org.nativescript.plugin.firebase.MLKit").bundlePath;
+      this.player = new AVAudioPlayer({contentsOfURL: NSURL.fileURLWithPath(barcodeBundlePath + "/beep.caf")});
+      this.player.numberOfLoops = 1;
+      this.player.volume = 0.7; // this is not the actual volume, as that really depends on the device volume
+      this.player.prepareToPlay();
+    }
+
     return getBarcodeDetector(formats);
   }
 
@@ -42,6 +57,10 @@ export class MLKitBarcodeScanner extends MLKitBarcodeScannerBase {
           object: this,
           value: result
         });
+
+        if (barcodes.count > 0 && this.player) {
+          this.player.play();
+        }
       }
     }
   }

src/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nativescript-plugin-firebase",
-  "version": "8.0.1",
+  "version": "8.1.0",
   "description": "Fire. Base. Firebase!",
   "main": "firebase",
   "typings": "index.d.ts",