@gueshbzh-perso/scanner 0.8.0 → 0.10.0

package/src/types.ts

@@ -23,8 +23,10 @@ export interface Detection {
   /** Symbology, e.g. `"qr_code"`, `"ean_13"`. */
   format: BarcodeFormat;
   /**
-   * Location of the code. For camera scans: video pixels (`video.videoWidth`
-   * space). For `scanImage`: pixels of the source image.
+   * Location of the code: corners of the symbol (2D codes: their finder
+   * points; 1D codes: start-top, end-top, end-bottom, start-bottom). For
+   * camera scans: video pixels (`video.videoWidth` space). For `scanImage`:
+   * pixels of the source image.
    */
   points: Point[];
   /** Raw payload bytes when the symbology provides them (binary QR codes…). */
@@ -116,6 +118,17 @@ export interface ProcessingOptions {
   maxDimension?: number;
   /** Frame pipeline. `'auto'` uses WebGL2 and falls back to Canvas 2D. Default: `'auto'`. */
   backend?: 'auto' | 'webgl' | 'canvas';
+  /**
+   * Use the browser's native `BarcodeDetector` (Chrome on Android, macOS and
+   * ChromeOS) as the fast pass, when it supports every requested format
+   * (`micro_qr` excepted). The engine's fallback strategies keep running on
+   * the frames it finds nothing in: hard codes (laser engraving, shadows…)
+   * are still read. Codes get the same confirmation and de-duplication.
+   * It reads codes whatever their orientation. Elsewhere (Safari, Firefox,
+   * Chrome on Windows / Linux), or if it fails, the engine does everything.
+   * `'off'`: always the engine alone. Default: `'auto'`.
+   */
+  nativeDetector?: 'auto' | 'off';
 }
 
 export interface ReaderOptions extends EngineOptions, AssetOptions {
@@ -150,6 +163,10 @@ export interface ReaderStats {
   worker: boolean;
   /** Frames decoded in parallel (number of workers, `1` on the main thread). */
   workers: number;
+  /** `true` when the native `BarcodeDetector` does the fast pass (see `processing.nativeDetector`). */
+  native: boolean;
+  /** Average native detection time, in ms (`0` when not used). */
+  nativeMs: number;
 }
 
 export interface ReaderEvents {