@pixelverse/strichjs-sdk 1.11.0 → 1.12.0

package/dist/strich.d.ts

@@ -29,16 +29,12 @@ export declare interface AudioFeedbackConfiguration {
  */
 export declare class BarcodeReader {
     /**
-     * User-supplied barcode detection handler.
-     *
-     * This is a synchronous call, so further processing will not happen until the handler returns.
+     * App-supplied barcode detection handler.
      */
-    detected?: (detections: CodeDetection[]) => (void);
+    detected?: DetectionHandler;
     /**
-     * Optional user-supplied error callback.
-     *
-     * This is invoked by the BarcodeReader if an error occurred while processing frames, and is usually not
-     * recoverable.
+     * Optional app-supplied error callback, invoked by the BarcodeReader if an unexpected error occurred while
+     * processing frames.
      */
     onError?: (error: Error) => (void);
     /**
@@ -108,6 +104,24 @@ export declare class BarcodeReader {
      * @returns the current visibility of this BarcodeReader instance
      */
     getVisible(): boolean;
+    /**
+     * Programmatically zoom the camera feed if the device supports it.
+     *
+     * @remarks
+     * This method will do nothing if the BarcodeReader is not initialized or has been destroyed.
+     *
+     * @param enabled - True to enable zoom, false to disable it
+     */
+    setZoom(enabled: boolean): Promise<void>;
+    /**
+     * Programmatically toggle the flashlight if the device supports it.
+     *
+     * @remarks
+     * This method will do nothing if the BarcodeReader is not initialized or has been destroyed.
+     *
+     * @param enabled - True to enable the flashlight, false to disable it
+     */
+    setFlashlight(enabled: boolean): Promise<void>;
 }
 
 /**
@@ -188,6 +202,32 @@ export declare interface Configuration {
     feedback?: FeedbackConfiguration;
 }
 
+/**
+ * Type for barcode detection handler.
+ *
+ * @remarks
+ * This handler is called synchronously when one or more barcodes are detected, so it should avoid performing any
+ * expensive operations. STRICH currently tries to detect a barcode as quickly as possible, it may occasionally
+ * return multiple detections simultaneously.
+ */
+export declare type DetectionHandler = (detections: CodeDetection[]) => DetectionHandlerResult;
+
+/**
+ * Result type for barcode detection handler.
+ *
+ * The handler can either return nothing (in versions prior to 1.12 this was the only option), or a boolean or array of
+ * booleans indicating whether the app handled the detections.
+ *
+ * Detections that are returned as unhandled (indicate by a `false` return value) will not be highlighted in the
+ * overlay, even if {@link OverlayConfiguration#showDetections} is set to true. No audio or vibration feedback will
+ * be emitted either.
+ *
+ * @remarks
+ * Returning `false` from the handler does not influence the usage in quota-based plans. All detections are always
+ * counted, regardless if they were handled or not.
+ */
+export declare type DetectionHandlerResult = void | boolean | boolean[];
+
 /**
  * Engine configuration
  */
@@ -937,7 +977,7 @@ export declare class StrichSDK {
  *
  * For more information, please visit https://docs.strich.io/supported-symbologies.html
  */
-export declare type SymbologyName = 'ean13' | 'ean8' | 'upca' | 'upce' | 'databar' | 'databar-exp' | 'code39' | 'code93' | 'code128' | 'i25' | 'codabar' | 'qr' | 'aztec' | 'datamatrix' | 'pdf417';
+export declare type SymbologyName = 'ean13' | 'ean8' | 'upca' | 'upce' | 'databar' | 'databar-exp' | 'code39' | 'code93' | 'code128' | 'i25' | 'codabar' | 'qr' | 'aztec' | 'datamatrix' | 'pdf417' | 'microqr';
 
 /**
  * For variable-length symbologies, min/max length can be specified in addition to the symbology.
@@ -1005,7 +1045,7 @@ export declare type SymbologySpec = {
     curved: boolean;
 } | {
     /** The name of the 2D symbology */
-    name: 'aztec' | 'datamatrix' | 'pdf417';
+    name: 'aztec' | 'datamatrix' | 'pdf417' | 'microqr';
 };
 
 export { }