Showing
2 changed files
with
12 additions
and
12 deletions
| @@ -3,19 +3,17 @@ enum DetectionSpeed { | @@ -3,19 +3,17 @@ enum DetectionSpeed { | ||
| 3 | /// The scanner will only scan a barcode once, and never again until another | 3 | /// The scanner will only scan a barcode once, and never again until another |
| 4 | /// barcode has been scanned. | 4 | /// barcode has been scanned. |
| 5 | /// | 5 | /// |
| 6 | - /// NOTE: This mode does analyze every frame in order to check if the value | ||
| 7 | - /// has changed. | 6 | + /// Bear in mind that this mode analyzes every frame, |
| 7 | + /// in order to check if the value has changed. | ||
| 8 | noDuplicates(0), | 8 | noDuplicates(0), |
| 9 | 9 | ||
| 10 | - /// The barcode scanner will scan one barcode, and wait 250 Miliseconds before | ||
| 11 | - /// scanning again. This will prevent memory issues on older devices. | ||
| 12 | - /// | ||
| 13 | - /// You can change the timeout duration with [detectionTimeout] parameter. | 10 | + /// The barcode scanner will scan barcodes, |
| 11 | + /// while respecting the configured scan timeout between individual scans. | ||
| 14 | normal(1), | 12 | normal(1), |
| 15 | 13 | ||
| 16 | - /// Let the scanner detect barcodes without restriction. | 14 | + /// The barcode scanner will scan barcodes, without any restrictions. |
| 17 | /// | 15 | /// |
| 18 | - /// NOTE: This can cause memory issues with older devices. | 16 | + /// Bear in mind that this mode can cause memory issues on older devices. |
| 19 | unrestricted(2); | 17 | unrestricted(2); |
| 20 | 18 | ||
| 21 | const DetectionSpeed(this.rawValue); | 19 | const DetectionSpeed(this.rawValue); |
| @@ -49,11 +49,13 @@ class MobileScannerController { | @@ -49,11 +49,13 @@ class MobileScannerController { | ||
| 49 | /// WARNING: DetectionSpeed.unrestricted can cause memory issues on some devices | 49 | /// WARNING: DetectionSpeed.unrestricted can cause memory issues on some devices |
| 50 | final DetectionSpeed detectionSpeed; | 50 | final DetectionSpeed detectionSpeed; |
| 51 | 51 | ||
| 52 | - /// Sets the timeout of scanner. | ||
| 53 | - /// The timeout is set in miliseconds. | 52 | + /// Sets the timeout, in milliseconds, of the scanner. |
| 54 | /// | 53 | /// |
| 55 | - /// NOTE: The timeout only works if the [detectionSpeed] is set to | ||
| 56 | - /// [DetectionSpeed.normal] (which is the default value). | 54 | + /// This timeout is ignored if the [detectionSpeed] |
| 55 | + /// is not set to [DetectionSpeed.normal]. | ||
| 56 | + /// | ||
| 57 | + /// By default this is set to `250` milliseconds, | ||
| 58 | + /// which prevents memory issues on older devices. | ||
| 57 | final int detectionTimeoutMs; | 59 | final int detectionTimeoutMs; |
| 58 | 60 | ||
| 59 | /// Automatically start the mobileScanner on initialization. | 61 | /// Automatically start the mobileScanner on initialization. |
-
Please register or login to post a comment