barkoder-nativescript 1.3.0 → 1.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/barkoder-nativescript.android.ts +1098 -813
  2. package/barkoder-nativescript.common.ts +4 -1
  3. package/barkoder-nativescript.ios.ts +1146 -818
  4. package/package.json +1 -1
  5. package/platforms/android/barkoder.aar +0 -0
  6. package/platforms/ios/Barkoder.xcframework/Info.plist +5 -5
  7. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/Barkoder +0 -0
  8. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/Headers/iBarkoder.h +103 -14
  9. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/Info.plist +0 -0
  10. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/default.metallib +0 -0
  11. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/float16_384x256.mlmodelc/analytics/coremldata.bin +0 -0
  12. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/float16_384x256.mlmodelc/coremldata.bin +0 -0
  13. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/float16_384x256.mlmodelc/metadata.json +85 -0
  14. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/float16_384x256.mlmodelc/model.mil +753 -0
  15. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/float16_384x256.mlmodelc/weights/weight.bin +0 -0
  16. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/float16_512x384.mlmodelc/analytics/coremldata.bin +0 -0
  17. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/float16_512x384.mlmodelc/coremldata.bin +0 -0
  18. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/float16_512x384.mlmodelc/metadata.json +85 -0
  19. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/float16_512x384.mlmodelc/model.mil +753 -0
  20. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/float16_512x384.mlmodelc/weights/weight.bin +0 -0
  21. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/mrz.traineddata +0 -0
  22. package/platforms/ios/Barkoder.xcframework/ios-arm64/Barkoder.framework/mrzfast.traineddata +0 -0
  23. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/Barkoder +0 -0
  24. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/Headers/iBarkoder.h +103 -14
  25. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/Info.plist +0 -0
  26. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/_CodeSignature/CodeResources +137 -5
  27. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/default.metallib +0 -0
  28. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/float16_384x256.mlmodelc/analytics/coremldata.bin +0 -0
  29. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/float16_384x256.mlmodelc/coremldata.bin +0 -0
  30. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/float16_384x256.mlmodelc/metadata.json +85 -0
  31. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/float16_384x256.mlmodelc/model.mil +753 -0
  32. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/float16_384x256.mlmodelc/weights/weight.bin +0 -0
  33. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/float16_512x384.mlmodelc/analytics/coremldata.bin +0 -0
  34. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/float16_512x384.mlmodelc/coremldata.bin +0 -0
  35. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/float16_512x384.mlmodelc/metadata.json +85 -0
  36. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/float16_512x384.mlmodelc/model.mil +753 -0
  37. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/float16_512x384.mlmodelc/weights/weight.bin +0 -0
  38. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/mrz.traineddata +0 -0
  39. package/platforms/ios/Barkoder.xcframework/ios-arm64_x86_64-simulator/Barkoder.framework/mrzfast.traineddata +0 -0
  40. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64/BarkoderSDK.framework/BarkoderSDK +0 -0
  41. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64/BarkoderSDK.framework/Headers/BarkoderSDK-Swift.h +49 -30
  42. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64/BarkoderSDK.framework/Info.plist +0 -0
  43. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64/BarkoderSDK.framework/Modules/BarkoderSDK.swiftmodule/arm64-apple-ios.abi.json +1118 -377
  44. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64/BarkoderSDK.framework/Modules/BarkoderSDK.swiftmodule/arm64-apple-ios.private.swiftinterface +3 -1
  45. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64/BarkoderSDK.framework/Modules/BarkoderSDK.swiftmodule/arm64-apple-ios.swiftdoc +0 -0
  46. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64/BarkoderSDK.framework/Modules/BarkoderSDK.swiftmodule/arm64-apple-ios.swiftinterface +3 -1
  47. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64/BarkoderSDK.framework/templates.json +203 -17
  48. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64_x86_64-simulator/BarkoderSDK.framework/BarkoderSDK +0 -0
  49. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64_x86_64-simulator/BarkoderSDK.framework/Headers/BarkoderSDK-Swift.h +98 -60
  50. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64_x86_64-simulator/BarkoderSDK.framework/Info.plist +0 -0
  51. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64_x86_64-simulator/BarkoderSDK.framework/Modules/BarkoderSDK.swiftmodule/arm64-apple-ios-simulator.abi.json +1118 -377
  52. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64_x86_64-simulator/BarkoderSDK.framework/Modules/BarkoderSDK.swiftmodule/arm64-apple-ios-simulator.private.swiftinterface +3 -1
  53. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64_x86_64-simulator/BarkoderSDK.framework/Modules/BarkoderSDK.swiftmodule/arm64-apple-ios-simulator.swiftdoc +0 -0
  54. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64_x86_64-simulator/BarkoderSDK.framework/Modules/BarkoderSDK.swiftmodule/arm64-apple-ios-simulator.swiftinterface +3 -1
  55. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64_x86_64-simulator/BarkoderSDK.framework/Modules/BarkoderSDK.swiftmodule/x86_64-apple-ios-simulator.abi.json +1118 -377
  56. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64_x86_64-simulator/BarkoderSDK.framework/Modules/BarkoderSDK.swiftmodule/x86_64-apple-ios-simulator.private.swiftinterface +3 -1
  57. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64_x86_64-simulator/BarkoderSDK.framework/Modules/BarkoderSDK.swiftmodule/x86_64-apple-ios-simulator.swiftdoc +0 -0
  58. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64_x86_64-simulator/BarkoderSDK.framework/Modules/BarkoderSDK.swiftmodule/x86_64-apple-ios-simulator.swiftinterface +3 -1
  59. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64_x86_64-simulator/BarkoderSDK.framework/_CodeSignature/CodeResources +25 -85
  60. package/platforms/ios/BarkoderSDK.xcframework/ios-arm64_x86_64-simulator/BarkoderSDK.framework/templates.json +203 -17
  61. package/typings/ios/objc!Barkoder.d.ts +11 -1
  62. package/README.md +0 -115
@@ -1,6 +1,6 @@
1
1
  // swift-interface-format-version: 1.0
2
2
  // swift-compiler-version: Apple Swift version 5.9.2 (swiftlang-5.9.2.2.56 clang-1500.1.0.2.5)
3
- // swift-module-flags: -target arm64-apple-ios10.0 -enable-objc-interop -enable-library-evolution -swift-version 5 -enforce-exclusivity=checked -O -module-name BarkoderSDK
3
+ // swift-module-flags: -target arm64-apple-ios13.0 -enable-objc-interop -enable-library-evolution -swift-version 5 -enforce-exclusivity=checked -O -module-name BarkoderSDK
4
4
  // swift-module-flags-ignorable: -enable-bare-slash-regex
5
5
  import AVFoundation
6
6
  import Barkoder
@@ -119,6 +119,8 @@ extension CoreFoundation.CGRect {
119
119
  case vin
120
120
  case dotcode
121
121
  case all_1d
122
+ case mrz
123
+ case gallery_scan
122
124
  public init?(rawValue: Swift.Int)
123
125
  public typealias RawValue = Swift.Int
124
126
  public var rawValue: Swift.Int {
@@ -1,6 +1,6 @@
1
1
  // swift-interface-format-version: 1.0
2
2
  // swift-compiler-version: Apple Swift version 5.9.2 (swiftlang-5.9.2.2.56 clang-1500.1.0.2.5)
3
- // swift-module-flags: -target arm64-apple-ios10.0 -enable-objc-interop -enable-library-evolution -swift-version 5 -enforce-exclusivity=checked -O -module-name BarkoderSDK
3
+ // swift-module-flags: -target arm64-apple-ios13.0 -enable-objc-interop -enable-library-evolution -swift-version 5 -enforce-exclusivity=checked -O -module-name BarkoderSDK
4
4
  // swift-module-flags-ignorable: -enable-bare-slash-regex
5
5
  import AVFoundation
6
6
  import Barkoder
@@ -119,6 +119,8 @@ extension CoreFoundation.CGRect {
119
119
  case vin
120
120
  case dotcode
121
121
  case all_1d
122
+ case mrz
123
+ case gallery_scan
122
124
  public init?(rawValue: Swift.Int)
123
125
  public typealias RawValue = Swift.Int
124
126
  public var rawValue: Swift.Int {
@@ -142,7 +142,7 @@
142
142
  "regionOfInterestVisible": false,
143
143
  "barkoderResolution": 0,
144
144
  "beepOnSuccessEnabled": true,
145
- "vibrateOnSuccessEnabled": true
145
+ "vibrateOnSuccessEnabled": false
146
146
  },
147
147
  "pdf_optimized": {
148
148
  "decoder": {
@@ -183,7 +183,7 @@
183
183
  "regionOfInterestVisible": false,
184
184
  "barkoderResolution": 1,
185
185
  "beepOnSuccessEnabled": true,
186
- "vibrateOnSuccessEnabled": true
186
+ "vibrateOnSuccessEnabled": false
187
187
  },
188
188
  "qr": {
189
189
  "decoder": {
@@ -224,7 +224,7 @@
224
224
  "regionOfInterestVisible": false,
225
225
  "barkoderResolution": 1,
226
226
  "beepOnSuccessEnabled": true,
227
- "vibrateOnSuccessEnabled": true
227
+ "vibrateOnSuccessEnabled": false
228
228
  },
229
229
  "retail_1d": {
230
230
  "decoder": {
@@ -252,8 +252,8 @@
252
252
  "encodingCharacterSet": "",
253
253
  "multicodeCachingEnabled": true,
254
254
  "multicodeCachingDuration": 1000,
255
- "enableMisshaped1D": true,
256
- "upcEanDeblur": false,
255
+ "enableMisshaped1D": false,
256
+ "upcEanDeblur": true,
257
257
  "enableVINRestrictions": false,
258
258
  "thresholdBetweenDuplicatesScans": 5
259
259
  }
@@ -271,7 +271,7 @@
271
271
  "regionOfInterestVisible": false,
272
272
  "barkoderResolution": 1,
273
273
  "beepOnSuccessEnabled": true,
274
- "vibrateOnSuccessEnabled": true
274
+ "vibrateOnSuccessEnabled": false
275
275
  },
276
276
  "industrial_1d": {
277
277
  "decoder": {
@@ -335,7 +335,7 @@
335
335
  "multicodeCachingEnabled": true,
336
336
  "multicodeCachingDuration": 1000,
337
337
  "enableMisshaped1D": false,
338
- "upcEanDeblur": false,
338
+ "upcEanDeblur": true,
339
339
  "enableVINRestrictions": false,
340
340
  "thresholdBetweenDuplicatesScans": 5
341
341
  }
@@ -353,7 +353,7 @@
353
353
  "regionOfInterestVisible": false,
354
354
  "barkoderResolution": 1,
355
355
  "beepOnSuccessEnabled": true,
356
- "vibrateOnSuccessEnabled": true
356
+ "vibrateOnSuccessEnabled": false
357
357
  },
358
358
  "all_2d": {
359
359
  "decoder": {
@@ -404,7 +404,7 @@
404
404
  "regionOfInterestVisible": false,
405
405
  "barkoderResolution": 1,
406
406
  "beepOnSuccessEnabled": true,
407
- "vibrateOnSuccessEnabled": true
407
+ "vibrateOnSuccessEnabled": false
408
408
  },
409
409
  "dpm": {
410
410
  "decoder": {
@@ -443,7 +443,7 @@
443
443
  "regionOfInterestVisible": false,
444
444
  "barkoderResolution": 1,
445
445
  "beepOnSuccessEnabled": true,
446
- "vibrateOnSuccessEnabled": true
446
+ "vibrateOnSuccessEnabled": false
447
447
  },
448
448
  "vin": {
449
449
  "decoder": {
@@ -488,15 +488,15 @@
488
488
  "roiLineColor": -65536,
489
489
  "roiLineWidth": 3,
490
490
  "roiOverlayBackgroundColor": 1711276032,
491
- "closeSessionOnResultEnabled": true,
491
+ "closeSessionOnResultEnabled": false,
492
492
  "imageResultEnabled": false,
493
493
  "locationInImageResultEnabled": false,
494
494
  "locationInPreviewEnabled": true,
495
495
  "pinchToZoomEnabled": false,
496
- "regionOfInterestVisible": false,
496
+ "regionOfInterestVisible": true,
497
497
  "barkoderResolution": 1,
498
498
  "beepOnSuccessEnabled": true,
499
- "vibrateOnSuccessEnabled": true
499
+ "vibrateOnSuccessEnabled": false
500
500
  },
501
501
  "dotcode": {
502
502
  "decoder": {
@@ -534,12 +534,12 @@
534
534
  "regionOfInterestVisible": false,
535
535
  "barkoderResolution": 1,
536
536
  "beepOnSuccessEnabled": true,
537
- "vibrateOnSuccessEnabled": true
537
+ "vibrateOnSuccessEnabled": false
538
538
  },
539
539
  "all_1d": {
540
540
  "decoder": {
541
541
  "Code 128": {
542
- "enabled": false,
542
+ "enabled": true,
543
543
  "minimumLength": 0,
544
544
  "maximumLength": 0
545
545
  },
@@ -666,6 +666,192 @@
666
666
  "regionOfInterestVisible": false,
667
667
  "barkoderResolution": 1,
668
668
  "beepOnSuccessEnabled": true,
669
- "vibrateOnSuccessEnabled": true
670
- }
669
+ "vibrateOnSuccessEnabled": false
670
+ },
671
+ "mrz": {
672
+ "decoder": {
673
+ "ID Document": {
674
+ "enabled": true
675
+ },
676
+ "general": {
677
+ "maxThreads": 2,
678
+ "decodingSpeed": 1,
679
+ "roi_x": 0,
680
+ "roi_y": 0,
681
+ "roi_w": 100,
682
+ "roi_h": 100,
683
+ "formattingType": 0,
684
+ "duplicatesDelayMs": 0,
685
+ "encodingCharacterSet": "",
686
+ "multicodeCachingEnabled": true,
687
+ "multicodeCachingDuration": 1000,
688
+ "enableMisshaped1D": false,
689
+ "upcEanDeblur": false,
690
+ "enableVINRestrictions": false,
691
+ "thresholdBetweenDuplicatesScans": 5
692
+ }
693
+ },
694
+ "locationLineColor": -65536,
695
+ "locationLineWidth": 4,
696
+ "roiLineColor": -65536,
697
+ "roiLineWidth": 3,
698
+ "roiOverlayBackgroundColor": 1711276032,
699
+ "closeSessionOnResultEnabled": true,
700
+ "imageResultEnabled": false,
701
+ "locationInImageResultEnabled": false,
702
+ "locationInPreviewEnabled": true,
703
+ "pinchToZoomEnabled": false,
704
+ "regionOfInterestVisible": false,
705
+ "barkoderResolution": 1,
706
+ "beepOnSuccessEnabled": true,
707
+ "vibrateOnSuccessEnabled": false
708
+ },
709
+ "gallery_scan": {
710
+ "decoder": {
711
+ "Aztec": {
712
+ "enabled": true
713
+ },
714
+ "Aztec Compact": {
715
+ "enabled": true
716
+ },
717
+ "QR": {
718
+ "enabled": true
719
+ },
720
+ "QR Micro": {
721
+ "enabled": true
722
+ },
723
+ "Code 128": {
724
+ "enabled": true,
725
+ "minimumLength": 0,
726
+ "maximumLength": 0
727
+ },
728
+ "Code 93": {
729
+ "enabled": true,
730
+ "minimumLength": 0,
731
+ "maximumLength": 0
732
+ },
733
+ "Code 39": {
734
+ "enabled": true,
735
+ "minimumLength": 0,
736
+ "maximumLength": 0,
737
+ "checksum": 0
738
+ },
739
+ "Codabar": {
740
+ "enabled": true,
741
+ "minimumLength": 0,
742
+ "maximumLength": 0
743
+ },
744
+ "Code 11": {
745
+ "enabled": true,
746
+ "minimumLength": 0,
747
+ "maximumLength": 0,
748
+ "checksum": 0
749
+ },
750
+ "MSI": {
751
+ "enabled": true,
752
+ "minimumLength": 4,
753
+ "maximumLength": 0,
754
+ "checksum": 1
755
+ },
756
+ "Upc-A": {
757
+ "enabled": true
758
+ },
759
+ "Upc-E": {
760
+ "enabled": true
761
+ },
762
+ "Upc-E1": {
763
+ "enabled": false
764
+ },
765
+ "Ean-13": {
766
+ "enabled": true
767
+ },
768
+ "Ean-8": {
769
+ "enabled": true
770
+ },
771
+ "PDF 417": {
772
+ "enabled": true
773
+ },
774
+ "PDF 417 Micro": {
775
+ "enabled": true
776
+ },
777
+ "Datamatrix": {
778
+ "enabled": true,
779
+ "dpmMode": 1
780
+ },
781
+ "Code 25": {
782
+ "enabled": true,
783
+ "checksum": 0,
784
+ "minimumLength": 0,
785
+ "maximumLength": 0
786
+ },
787
+ "Interleaved 2 of 5": {
788
+ "enabled": true,
789
+ "checksum": 0,
790
+ "minimumLength": 0,
791
+ "maximumLength": 0
792
+ },
793
+ "ITF 14": {
794
+ "enabled": true
795
+ },
796
+ "IATA 25": {
797
+ "enabled": true,
798
+ "checksum": 0,
799
+ "minimumLength": 0,
800
+ "maximumLength": 0
801
+ },
802
+ "Matrix 25": {
803
+ "enabled": true,
804
+ "checksum": 0,
805
+ "minimumLength": 0,
806
+ "maximumLength": 0
807
+ },
808
+ "Datalogic 25": {
809
+ "enabled": false,
810
+ "checksum": 0,
811
+ "minimumLength": 0,
812
+ "maximumLength": 0
813
+ },
814
+ "COOP 25": {
815
+ "enabled": true,
816
+ "checksum": 0,
817
+ "minimumLength": 0,
818
+ "maximumLength": 0
819
+ },
820
+ "Code 32": {
821
+ "enabled": true,
822
+ "minimumLength": 0,
823
+ "maximumLength": 0
824
+ },
825
+ "Telepen": {
826
+ "enabled": true,
827
+ "minimumLength": 0,
828
+ "maximumLength": 0
829
+ },
830
+ "Dotcode": {
831
+ "enabled": true
832
+ },
833
+ "ID Document": {
834
+ "enabled": true
835
+ },
836
+ "general": {
837
+ "maxThreads": 2,
838
+ "decodingSpeed": 3,
839
+ "roi_x": 0,
840
+ "roi_y": 0,
841
+ "roi_w": 100,
842
+ "roi_h": 100,
843
+ "formattingType": 1,
844
+ "encodingCharacterSet": "",
845
+ "enableMisshaped1D": true,
846
+ "upcEanDeblur": true,
847
+ "enableVINRestrictions": false
848
+ }
849
+ },
850
+ "closeSessionOnResultEnabled": true,
851
+ "barkoderResolution": 0,
852
+ "beepOnSuccessEnabled": true,
853
+ "vibrateOnSuccessEnabled": false,
854
+ "locationInImageResultEnabled": true,
855
+ "locationLineWidth": 7
856
+ }
671
857
  }
@@ -311,55 +311,68 @@ enum BarkoderResolution : NSInteger;
311
311
 
312
312
  SWIFT_CLASS("_TtC11BarkoderSDK14BarkoderConfig")
313
313
  @interface BarkoderConfig : NSObject
314
- /// Region of interest line color as UIColor
314
+ /// Retrieves/Sets the color of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed
315
315
  @property (nonatomic, strong) UIColor * _Nonnull roiLineColor;
316
- /// Region of interest line width as float
316
+ /// Retrieves/Sets the width of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed
317
+ /// note:
317
318
  /// Default value is 2.0
318
319
  @property (nonatomic) float roiLineWidth;
319
- /// Region of interest background color as UIColor
320
+ /// Retrieves/Sets the background color of the overlay within the Region of Interest (ROI) for barcode scanning on the camera feed
320
321
  @property (nonatomic, strong) UIColor * _Nonnull roiOverlayBackgroundColor;
321
- /// Check if ROI is visible on the preview screen
322
+ /// Retrieves/Sets the visibility of the Region of Interest (ROI) on the camera preview
323
+ /// note:
322
324
  /// Default value is true
323
325
  @property (nonatomic) BOOL regionOfInterestVisible;
324
- /// Location line color as UIColor
326
+ /// Retrieves/Sets the hexadecimal color code representing the line color used to indicate the location of detected barcodes
325
327
  @property (nonatomic, strong) UIColor * _Nonnull locationLineColor;
326
- /// Get the location line width as float
328
+ /// Retrieves/Sets the width of the lines indicating the location of detected barcodes on the camera feed
329
+ /// note:
327
330
  /// Default value is 2
328
331
  @property (nonatomic) float locationLineWidth;
329
- /// Check if the camera preview can be zoomed with pinch
332
+ /// Enables or disables the pinch-to-zoom feature for adjusting the zoom level during barcode scanning
333
+ /// note:
330
334
  /// Default value is false
331
335
  @property (nonatomic) BOOL pinchToZoomEnabled;
332
- /// Check if device will beep on successful scan
336
+ /// Enables or disables the audible beep sound upon successfully decoding a barcode
337
+ /// note:
333
338
  /// Default value is true
334
339
  @property (nonatomic) BOOL beepOnSuccessEnabled;
335
- /// Check if device will vibrate on successful scan
340
+ /// Enables or disables the device vibration upon successfully decoding a barcode.
341
+ /// note:
336
342
  /// Default value is true
337
343
  @property (nonatomic) BOOL vibrateOnSuccessEnabled;
338
- /// Check if camera preview session will be closed when barcode is scanned
344
+ /// Enables or disables the automatic closing of the scanning session upon detecting a barcode result
345
+ /// note:
339
346
  /// Default value is true
340
347
  @property (nonatomic) BOOL closeSessionOnResultEnabled;
341
- /// Check if the image result is enabled
342
- /// Image result is received in BarkoderResultDelegate as UIImage
348
+ /// Enables or disables the capturing and processing of image data when a barcode is successfully detected
349
+ /// note:
343
350
  /// Default value is false
344
351
  @property (nonatomic) BOOL imageResultEnabled;
345
- /// Check if barcode location in the image result is enabled
346
- /// If enabled, barcode in the result image will be marked
352
+ /// Enables or disables the inclusion of barcode location information within the image data result
353
+ /// note:
347
354
  /// Default value is false
348
355
  @property (nonatomic) BOOL locationInImageResultEnabled;
349
- /// Check if barcode location in preview is enabled
356
+ /// Enables or disables the display of barcode location information on the camera preview
357
+ /// note:
350
358
  /// Default value is true
351
359
  @property (nonatomic) BOOL locationInPreviewEnabled;
352
- /// Get the decoder config object. With this object you can enable/disable decoders (barcode types) or configure each one of them
360
+ /// Configures the Barkoder functionality based on the provided configuration
353
361
  @property (nonatomic, strong) Config * _Nullable decoderConfig;
354
- /// Get the active resolution. It can be Normal(HD), or HIGH(Full HD)
362
+ /// Retrieve/Sets the resolution for barcode scanning
363
+ /// note:
355
364
  /// Default value is BarkoderView.BarkoderResolution.normal
356
365
  @property (nonatomic) enum BarkoderResolution barkoderResolution;
357
- /// Getting barcode thumbnail on result
366
+ /// Retrieve/Sets whether to enable barcode thumbnail on result
367
+ /// note:
368
+ /// Default value is true
358
369
  @property (nonatomic) BOOL barcodeThumbnailOnResult;
359
- /// Getting threshold between duplicates scans
370
+ /// Retrieve/Sets the threshold between duplicate scans
360
371
  @property (nonatomic) NSInteger thresholdBetweenDuplicatesScans;
372
+ /// Defines the Region of Interest (ROI) on the camera preview for barcode scanning, specifying an area where the application focuses on detecting barcodes
361
373
  - (BOOL)setRegionOfInterest:(CGRect)value error:(NSError * _Nullable * _Nullable)error;
362
- /// Get active region of interest
374
+ /// Retrieves the region of interest (ROI)
375
+ /// note:
363
376
  /// Default value is ‘CGRect(x: 3, y: 30, width: 94, height: 40)’
364
377
  - (CGRect)getRegionOfInterest SWIFT_WARN_UNUSED_RESULT;
365
378
  - (nonnull instancetype)initWithLicenseKey:(NSString * _Nonnull)licenseKey licenseCheckHandler:(void (^ _Nonnull)(LicenseCheckResult * _Nonnull))licenseCheckHandler;
@@ -372,10 +385,15 @@ SWIFT_CLASS("_TtC11BarkoderSDK14BarkoderConfig")
372
385
  /// \param value [1, max threads available]
373
386
  ///
374
387
  - (BOOL)setThreadsLimit:(NSInteger)value error:(NSError * _Nullable * _Nullable)error;
388
+ /// Get maximum threads that are used for the decoding process
375
389
  - (NSInteger)getThreadsLimit SWIFT_WARN_UNUSED_RESULT;
390
+ /// Sets whether multi-code caching is enabled
376
391
  - (void)setMulticodeCachingEnabled:(BOOL)boolean;
392
+ /// Retrieves whether multi-code caching is enabled
377
393
  - (BOOL)getMulticodeCachingEnabled SWIFT_WARN_UNUSED_RESULT;
394
+ /// Sets the caching duration (in milliseconds) for multi-code results
378
395
  - (void)setMulticodeCachingDuration:(NSInteger)value;
396
+ /// Retrieves the caching duration (in milliseconds) for multi-code results
379
397
  - (NSInteger)getMulticodeCachingDuration SWIFT_WARN_UNUSED_RESULT;
380
398
  - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
381
399
  @end
@@ -442,6 +460,8 @@ typedef SWIFT_ENUM(NSInteger, BarkoderConfigTemplate, open) {
442
460
  BarkoderConfigTemplateVin = 7,
443
461
  BarkoderConfigTemplateDotcode = 8,
444
462
  BarkoderConfigTemplateAll_1d = 9,
463
+ BarkoderConfigTemplateMrz = 10,
464
+ BarkoderConfigTemplateGallery_scan = 11,
445
465
  };
446
466
 
447
467
 
@@ -479,24 +499,21 @@ SWIFT_CLASS("_TtC11BarkoderSDK12BarkoderView")
479
499
  /// \param delegate Callback which return fps and dps as Float
480
500
  ///
481
501
  - (void)setBarkoderPerformanceDelegate:(id <BarkoderPerformanceDelegate> _Nullable)delegate;
482
- /// Turn flash ON/OFF
483
- /// If preview session is already active this state be set only for active session
484
- /// otherwise the initial flash state is set. Every next preview session will be started with this state
485
- /// \param enabled [true, false]. Default value is false
486
- ///
502
+ /// Initiates the barcode scanning process, allowing the application to detect and decode barcodes from the device’s camera feed
487
503
  - (BOOL)startScanning:(id <BarkoderResultDelegate> _Nonnull)resultDelegate error:(NSError * _Nullable * _Nullable)error;
488
- /// Stop the scanning process and the camera preview
504
+ /// Halts the barcode scanning process, stopping the camera from capturing and processing barcode information
489
505
  - (void)stopScanning;
490
- /// Pause only the scanning process. Camera preview is still running
506
+ /// Temporarily suspends the barcode scanning process, pausing the camera feed without completely stopping the scanning session
491
507
  - (void)pauseScanning;
508
+ /// Sets the zoom factor for the device’s camera, adjusting the level of zoom during barcode scanning
492
509
  - (void)setZoomFactor:(float)zoomFactor;
493
- /// Turn flash ON/OFF
494
- /// If preview session is already active this state be set only for active session
495
- /// otherwise the initial flash state is set. Every next preview session will be started with this state
510
+ /// Enables or disables the device’s flash (torch) for illumination during barcode scanning
496
511
  /// \param enabled [true, false]. Default value is false
497
512
  ///
498
513
  - (void)setFlash:(BOOL)enabled;
514
+ /// Retrieves the maximum available zoom factor for the device’s camera
499
515
  - (void)getMaxZoomFactor:(void (^ _Nonnull)(float))completion;
516
+ /// Checks whether the device has a built-in flash (torch) that can be used for illumination during barcode scanning
500
517
  - (void)isFlashAvailable:(void (^ _Nonnull)(BOOL))completion;
501
518
  - (void)cameraFrameReceivedWithSampleBuffer:(CMSampleBufferRef _Nonnull)sampleBuffer;
502
519
  - (void)layoutSubviews;
@@ -510,7 +527,9 @@ typedef SWIFT_ENUM(NSInteger, BarkoderResolution, open) {
510
527
 
511
528
 
512
529
 
530
+
513
531
  @interface iBarkoder (SWIFT_EXTENSION(BarkoderSDK))
532
+ /// Retrieves the version of the Barkoder library
514
533
  + (NSString * _Nonnull)GetVersion SWIFT_WARN_UNUSED_RESULT;
515
534
  @end
516
535
 
@@ -835,55 +854,68 @@ enum BarkoderResolution : NSInteger;
835
854
 
836
855
  SWIFT_CLASS("_TtC11BarkoderSDK14BarkoderConfig")
837
856
  @interface BarkoderConfig : NSObject
838
- /// Region of interest line color as UIColor
857
+ /// Retrieves/Sets the color of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed
839
858
  @property (nonatomic, strong) UIColor * _Nonnull roiLineColor;
840
- /// Region of interest line width as float
859
+ /// Retrieves/Sets the width of the lines outlining the Region of Interest (ROI) for barcode scanning on the camera feed
860
+ /// note:
841
861
  /// Default value is 2.0
842
862
  @property (nonatomic) float roiLineWidth;
843
- /// Region of interest background color as UIColor
863
+ /// Retrieves/Sets the background color of the overlay within the Region of Interest (ROI) for barcode scanning on the camera feed
844
864
  @property (nonatomic, strong) UIColor * _Nonnull roiOverlayBackgroundColor;
845
- /// Check if ROI is visible on the preview screen
865
+ /// Retrieves/Sets the visibility of the Region of Interest (ROI) on the camera preview
866
+ /// note:
846
867
  /// Default value is true
847
868
  @property (nonatomic) BOOL regionOfInterestVisible;
848
- /// Location line color as UIColor
869
+ /// Retrieves/Sets the hexadecimal color code representing the line color used to indicate the location of detected barcodes
849
870
  @property (nonatomic, strong) UIColor * _Nonnull locationLineColor;
850
- /// Get the location line width as float
871
+ /// Retrieves/Sets the width of the lines indicating the location of detected barcodes on the camera feed
872
+ /// note:
851
873
  /// Default value is 2
852
874
  @property (nonatomic) float locationLineWidth;
853
- /// Check if the camera preview can be zoomed with pinch
875
+ /// Enables or disables the pinch-to-zoom feature for adjusting the zoom level during barcode scanning
876
+ /// note:
854
877
  /// Default value is false
855
878
  @property (nonatomic) BOOL pinchToZoomEnabled;
856
- /// Check if device will beep on successful scan
879
+ /// Enables or disables the audible beep sound upon successfully decoding a barcode
880
+ /// note:
857
881
  /// Default value is true
858
882
  @property (nonatomic) BOOL beepOnSuccessEnabled;
859
- /// Check if device will vibrate on successful scan
883
+ /// Enables or disables the device vibration upon successfully decoding a barcode.
884
+ /// note:
860
885
  /// Default value is true
861
886
  @property (nonatomic) BOOL vibrateOnSuccessEnabled;
862
- /// Check if camera preview session will be closed when barcode is scanned
887
+ /// Enables or disables the automatic closing of the scanning session upon detecting a barcode result
888
+ /// note:
863
889
  /// Default value is true
864
890
  @property (nonatomic) BOOL closeSessionOnResultEnabled;
865
- /// Check if the image result is enabled
866
- /// Image result is received in BarkoderResultDelegate as UIImage
891
+ /// Enables or disables the capturing and processing of image data when a barcode is successfully detected
892
+ /// note:
867
893
  /// Default value is false
868
894
  @property (nonatomic) BOOL imageResultEnabled;
869
- /// Check if barcode location in the image result is enabled
870
- /// If enabled, barcode in the result image will be marked
895
+ /// Enables or disables the inclusion of barcode location information within the image data result
896
+ /// note:
871
897
  /// Default value is false
872
898
  @property (nonatomic) BOOL locationInImageResultEnabled;
873
- /// Check if barcode location in preview is enabled
899
+ /// Enables or disables the display of barcode location information on the camera preview
900
+ /// note:
874
901
  /// Default value is true
875
902
  @property (nonatomic) BOOL locationInPreviewEnabled;
876
- /// Get the decoder config object. With this object you can enable/disable decoders (barcode types) or configure each one of them
903
+ /// Configures the Barkoder functionality based on the provided configuration
877
904
  @property (nonatomic, strong) Config * _Nullable decoderConfig;
878
- /// Get the active resolution. It can be Normal(HD), or HIGH(Full HD)
905
+ /// Retrieve/Sets the resolution for barcode scanning
906
+ /// note:
879
907
  /// Default value is BarkoderView.BarkoderResolution.normal
880
908
  @property (nonatomic) enum BarkoderResolution barkoderResolution;
881
- /// Getting barcode thumbnail on result
909
+ /// Retrieve/Sets whether to enable barcode thumbnail on result
910
+ /// note:
911
+ /// Default value is true
882
912
  @property (nonatomic) BOOL barcodeThumbnailOnResult;
883
- /// Getting threshold between duplicates scans
913
+ /// Retrieve/Sets the threshold between duplicate scans
884
914
  @property (nonatomic) NSInteger thresholdBetweenDuplicatesScans;
915
+ /// Defines the Region of Interest (ROI) on the camera preview for barcode scanning, specifying an area where the application focuses on detecting barcodes
885
916
  - (BOOL)setRegionOfInterest:(CGRect)value error:(NSError * _Nullable * _Nullable)error;
886
- /// Get active region of interest
917
+ /// Retrieves the region of interest (ROI)
918
+ /// note:
887
919
  /// Default value is ‘CGRect(x: 3, y: 30, width: 94, height: 40)’
888
920
  - (CGRect)getRegionOfInterest SWIFT_WARN_UNUSED_RESULT;
889
921
  - (nonnull instancetype)initWithLicenseKey:(NSString * _Nonnull)licenseKey licenseCheckHandler:(void (^ _Nonnull)(LicenseCheckResult * _Nonnull))licenseCheckHandler;
@@ -896,10 +928,15 @@ SWIFT_CLASS("_TtC11BarkoderSDK14BarkoderConfig")
896
928
  /// \param value [1, max threads available]
897
929
  ///
898
930
  - (BOOL)setThreadsLimit:(NSInteger)value error:(NSError * _Nullable * _Nullable)error;
931
+ /// Get maximum threads that are used for the decoding process
899
932
  - (NSInteger)getThreadsLimit SWIFT_WARN_UNUSED_RESULT;
933
+ /// Sets whether multi-code caching is enabled
900
934
  - (void)setMulticodeCachingEnabled:(BOOL)boolean;
935
+ /// Retrieves whether multi-code caching is enabled
901
936
  - (BOOL)getMulticodeCachingEnabled SWIFT_WARN_UNUSED_RESULT;
937
+ /// Sets the caching duration (in milliseconds) for multi-code results
902
938
  - (void)setMulticodeCachingDuration:(NSInteger)value;
939
+ /// Retrieves the caching duration (in milliseconds) for multi-code results
903
940
  - (NSInteger)getMulticodeCachingDuration SWIFT_WARN_UNUSED_RESULT;
904
941
  - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
905
942
  @end
@@ -966,6 +1003,8 @@ typedef SWIFT_ENUM(NSInteger, BarkoderConfigTemplate, open) {
966
1003
  BarkoderConfigTemplateVin = 7,
967
1004
  BarkoderConfigTemplateDotcode = 8,
968
1005
  BarkoderConfigTemplateAll_1d = 9,
1006
+ BarkoderConfigTemplateMrz = 10,
1007
+ BarkoderConfigTemplateGallery_scan = 11,
969
1008
  };
970
1009
 
971
1010
 
@@ -1003,24 +1042,21 @@ SWIFT_CLASS("_TtC11BarkoderSDK12BarkoderView")
1003
1042
  /// \param delegate Callback which return fps and dps as Float
1004
1043
  ///
1005
1044
  - (void)setBarkoderPerformanceDelegate:(id <BarkoderPerformanceDelegate> _Nullable)delegate;
1006
- /// Turn flash ON/OFF
1007
- /// If preview session is already active this state be set only for active session
1008
- /// otherwise the initial flash state is set. Every next preview session will be started with this state
1009
- /// \param enabled [true, false]. Default value is false
1010
- ///
1045
+ /// Initiates the barcode scanning process, allowing the application to detect and decode barcodes from the device’s camera feed
1011
1046
  - (BOOL)startScanning:(id <BarkoderResultDelegate> _Nonnull)resultDelegate error:(NSError * _Nullable * _Nullable)error;
1012
- /// Stop the scanning process and the camera preview
1047
+ /// Halts the barcode scanning process, stopping the camera from capturing and processing barcode information
1013
1048
  - (void)stopScanning;
1014
- /// Pause only the scanning process. Camera preview is still running
1049
+ /// Temporarily suspends the barcode scanning process, pausing the camera feed without completely stopping the scanning session
1015
1050
  - (void)pauseScanning;
1051
+ /// Sets the zoom factor for the device’s camera, adjusting the level of zoom during barcode scanning
1016
1052
  - (void)setZoomFactor:(float)zoomFactor;
1017
- /// Turn flash ON/OFF
1018
- /// If preview session is already active this state be set only for active session
1019
- /// otherwise the initial flash state is set. Every next preview session will be started with this state
1053
+ /// Enables or disables the device’s flash (torch) for illumination during barcode scanning
1020
1054
  /// \param enabled [true, false]. Default value is false
1021
1055
  ///
1022
1056
  - (void)setFlash:(BOOL)enabled;
1057
+ /// Retrieves the maximum available zoom factor for the device’s camera
1023
1058
  - (void)getMaxZoomFactor:(void (^ _Nonnull)(float))completion;
1059
+ /// Checks whether the device has a built-in flash (torch) that can be used for illumination during barcode scanning
1024
1060
  - (void)isFlashAvailable:(void (^ _Nonnull)(BOOL))completion;
1025
1061
  - (void)cameraFrameReceivedWithSampleBuffer:(CMSampleBufferRef _Nonnull)sampleBuffer;
1026
1062
  - (void)layoutSubviews;
@@ -1034,7 +1070,9 @@ typedef SWIFT_ENUM(NSInteger, BarkoderResolution, open) {
1034
1070
 
1035
1071
 
1036
1072
 
1073
+
1037
1074
  @interface iBarkoder (SWIFT_EXTENSION(BarkoderSDK))
1075
+ /// Retrieves the version of the Barkoder library
1038
1076
  + (NSString * _Nonnull)GetVersion SWIFT_WARN_UNUSED_RESULT;
1039
1077
  @end
1040
1078