scanbot-web-sdk 8.0.2-beta.1 → 8.1.0-beta.1

package/@types/barcode-scanner-view.d.ts

@@ -21,7 +21,6 @@ export default class BarcodeScannerView extends FinderScannerView<BarcodeScanner
     barcodeScannerHandle: BarcodeScanner | null;
     readonly barcodes: BarcodeItem[];
     private detectionRunning;
-    private fpsLimiter;
     constructor(props: BarcodeScannerProps);
     get configuration(): BarcodeScannerViewConfiguration;
     get enabled(): boolean;

package/@types/core/bridge/worker-bridge.d.ts

@@ -73,10 +73,6 @@ export declare class WorkerBridge {
             } & {
                 readonly _type: "CustomBinarizationFilter";
             }) | ({
-                radius?: number;
-                borderWidthFraction?: number;
-                blackOutliersFraction?: number;
-                whiteOutliersFraction?: number;
                 contrastEnhancement?: number;
                 colorEnhancement?: number;
                 paperWhitening?: number;
@@ -145,10 +141,6 @@ export declare class WorkerBridge {
             } & {
                 readonly _type: "CustomBinarizationFilter";
             }) | ({
-                radius?: number;
-                borderWidthFraction?: number;
-                blackOutliersFraction?: number;
-                whiteOutliersFraction?: number;
                 contrastEnhancement?: number;
                 colorEnhancement?: number;
                 paperWhitening?: number;
@@ -232,10 +224,6 @@ export declare class WorkerBridge {
             } & {
                 readonly _type: "CustomBinarizationFilter";
             }) | ({
-                radius?: number;
-                borderWidthFraction?: number;
-                blackOutliersFraction?: number;
-                whiteOutliersFraction?: number;
                 contrastEnhancement?: number;
                 colorEnhancement?: number;
                 paperWhitening?: number;
@@ -304,10 +292,6 @@ export declare class WorkerBridge {
             } & {
                 readonly _type: "CustomBinarizationFilter";
             }) | ({
-                radius?: number;
-                borderWidthFraction?: number;
-                blackOutliersFraction?: number;
-                whiteOutliersFraction?: number;
                 contrastEnhancement?: number;
                 colorEnhancement?: number;
                 paperWhitening?: number;

package/@types/core/compiled/BarcodeConfigurationTypes.d.ts

@@ -1,6 +1,7 @@
 import type { DeepPartial } from "./utils";
 import { BarcodeFormat } from "./BarcodeTypes";
 import { Gs1Handling } from "./BarcodeTypes";
+import { OneDConfirmationMode } from "./BarcodeTypes";
 import { UpcEanExtensionBehavior } from "./BarcodeTypes";
 /**
 Base class for all barcode configurations.
@@ -50,10 +51,17 @@ export declare class BarcodeFormatCodabarConfiguration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
+    */
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     Minimum text length. Applied only to linear barcode formats that allow variable length.
     @defaultValue 1;
@@ -65,7 +73,7 @@ export declare class BarcodeFormatCodabarConfiguration {
     */
     maximumTextLength: number;
     /**
-    If true, barcodes with heavy blur or from far distance are tried to scan.
+    If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
     @defaultValue true;
     */
     enableOneDBlurScanner: boolean;
@@ -107,10 +115,17 @@ export declare class BarcodeFormatCode11Configuration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
+    */
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     If true, the check digits are stripped from the result.
     @defaultValue false;
@@ -164,10 +179,17 @@ export declare class BarcodeFormatCode39Configuration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
+    */
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     If true, the check digits are stripped from the result.
     @defaultValue false;
@@ -184,7 +206,7 @@ export declare class BarcodeFormatCode39Configuration {
     */
     maximumTextLength: number;
     /**
-    If true, barcodes with heavy blur or from far distance are tried to scan.
+    If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
     @defaultValue true;
     */
     enableOneDBlurScanner: boolean;
@@ -251,10 +273,17 @@ export declare class BarcodeFormatCode93Configuration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
+    */
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     If true, the check digits are stripped from the result.
     @defaultValue false;
@@ -271,7 +300,7 @@ export declare class BarcodeFormatCode93Configuration {
     */
     maximumTextLength: number;
     /**
-    If true, barcodes with heavy blur or from far distance are tried to scan.
+    If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
     @defaultValue true;
     */
     enableOneDBlurScanner: boolean;
@@ -308,10 +337,17 @@ export declare class BarcodeFormatCode128Configuration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
+    */
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     GS1 message handling options.
     @defaultValue "PARSE";
@@ -328,7 +364,7 @@ export declare class BarcodeFormatCode128Configuration {
     */
     maximumTextLength: number;
     /**
-    If true, barcodes with heavy blur or from far distance are tried to scan.
+    If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
     @defaultValue true;
     */
     enableOneDBlurScanner: boolean;
@@ -369,10 +405,17 @@ export declare class BarcodeFormatCode2Of5Configuration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
+    */
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     If true, the check digits are stripped from the result.
     @defaultValue false;
@@ -441,10 +484,17 @@ export declare class BarcodeFormatDataBarConfiguration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
+    */
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     GS1 message handling options.
     @defaultValue "PARSE";
@@ -483,10 +533,17 @@ export declare class BarcodeFormatDataBarExpandedConfiguration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
+    */
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     GS1 message handling options.
     @defaultValue "PARSE";
@@ -525,10 +582,17 @@ export declare class BarcodeFormatDataBarLimitedConfiguration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
+    */
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     GS1 message handling options.
     @defaultValue "PARSE";
@@ -567,10 +631,17 @@ export declare class BarcodeFormatItfConfiguration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
+    */
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     Minimum text length. Applied only to linear barcode formats that allow variable length.
     @defaultValue 1;
@@ -582,7 +653,7 @@ export declare class BarcodeFormatItfConfiguration {
     */
     maximumTextLength: number;
     /**
-    If true, barcodes with heavy blur or from far distance are tried to scan.
+    If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
     @defaultValue true;
     */
     enableOneDBlurScanner: boolean;
@@ -662,10 +733,17 @@ export declare class BarcodeFormatMsiPlesseyConfiguration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
+    */
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     If true, the check digits are stripped from the result.
     @defaultValue false;
@@ -682,7 +760,7 @@ export declare class BarcodeFormatMsiPlesseyConfiguration {
     */
     maximumTextLength: number;
     /**
-    If true, barcodes with heavy blur or from far distance are tried to scan.
+    If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
     @defaultValue true;
     */
     enableOneDBlurScanner: boolean;
@@ -726,18 +804,26 @@ export declare class BarcodeFormatUpcEanConfiguration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
+    */
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     If true, the check digits are stripped from the result.
     @defaultValue false;
     */
     stripCheckDigits: boolean;
     /**
-    If true, barcodes with heavy blur or from far distance are tried to scan.
-    @defaultValue true;
+    If true, the scanner will try extra-hard to scan barcodes with heavy blur or that are otherwise damaged.
+    Enabling this option may increase the number of misreads (false positives).
+    @defaultValue false;
     */
     enableOneDBlurScanner: boolean;
     /**
@@ -766,11 +852,13 @@ export declare class BarcodeFormatUpcEanConfiguration {
     */
     extensions: UpcEanExtensionBehavior;
     /**
-    In case that ean/upc both with and without extensions are allowed,
-    we require confirmations to consider a standalone EAN or UPC (i.e. without extension) as valid.
+    In case that EAN/UPC barcodes both with and without extensions are allowed,
+    we require this number of frames on which the standalone EAN or UPC (i.e. without extension) has to be detected to be considered as valid (live scanning only).
+    EAN/UPC barcodes with extensions are more prone to slicing (incomplete decoding).
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability that an extension is accidentally missed.
     @defaultValue 1;
     */
-    minimumStandaloneConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless: number;
     /** @param source {@displayType `DeepPartial<BarcodeFormatUpcEanConfiguration>`} */
     constructor(source?: DeepPartial<BarcodeFormatUpcEanConfiguration>);
 }
@@ -804,10 +892,17 @@ export declare class BarcodeFormatPharmaCodeConfiguration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
+    */
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     Minimum value for PharmaCode. Very low values are likely to produce more false positives.
     @defaultValue 16;
@@ -1333,10 +1428,12 @@ export declare class BarcodeFormatCommonOneDConfiguration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
     /**
     If true, the check digits are stripped from the result.
     @defaultValue false;
@@ -1358,10 +1455,10 @@ export declare class BarcodeFormatCommonOneDConfiguration {
     */
     gs1Handling: Gs1Handling;
     /**
-    If true, barcodes with heavy blur or from far distance are tried to scan.
-    @defaultValue true;
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
     */
-    enableOneDBlurScanner: boolean;
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     List of linear (1D) barcode formats to scan.
     @defaultValue ["CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_8", "EAN_13", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "MSI_PLESSEY", "PHARMA_CODE", "PZN_7", "PZN_8", "UPC_A", "UPC_E"];
@@ -1487,10 +1584,12 @@ export declare class BarcodeFormatCommonConfiguration {
     */
     minimum1DQuietZoneSize: number;
     /**
-    In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
+    Minimum number of frames on which a linear (1D) barcode has to be detected to be considered valid (live scanning only).
+    Linear barcodes are more prone to false positives.
+    Increasing the number of frames on which a barcode has to decode to the same content reduces the probability of a false positive.
     @defaultValue 1;
     */
-    minimum1DConfirmationCount: number;
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
     /**
     If true, the check digits are stripped from the result.
     @defaultValue false;
@@ -1517,10 +1616,10 @@ export declare class BarcodeFormatCommonConfiguration {
     */
     strictMode: boolean;
     /**
-    If true, barcodes with heavy blur or from far distance are tried to scan.
-    @defaultValue true;
+    Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+    @defaultValue "THOROUGH";
     */
-    enableOneDBlurScanner: boolean;
+    oneDConfirmationMode: OneDConfirmationMode;
     /**
     List of barcode formats to scan. By default, the most commonly used formats are enabled.
     @defaultValue ["AZTEC", "CODABAR", "CODE_39", "CODE_93", "CODE_128", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "ITF", "PDF_417", "QR_CODE", "UPC_A", "UPC_E"];