flutter_barcode_reader/README.md

36 lines
1013 B
Markdown
Raw Normal View History

2017-10-30 01:05:11 +08:00
# Barcode Scanner
A flutter plugin for scanning 2D barcodes and QR codes.
This provides a simple wrapper for two commonly used iOS and Android libraries:
iOS: https://github.com/mikebuss/MTBBarcodeScanner
2017-10-30 06:31:33 +08:00
Android: https://github.com/dm77/barcodescanner
2017-10-30 01:05:11 +08:00
### Features
- [x] Scan 2D barcodes
- [x] Scan QR codes
- [x] Control the flash while scanning
- [x] Permission handling
- [ ] Support multiple barcode libraries
2017-10-30 01:05:11 +08:00
## Getting Started
### Android
2017-10-30 01:05:11 +08:00
For Android, you must do the following before you can use the plugin:
* Add the camera permission to your AndroidManifest.xml
`<uses-permission android:name="android.permission.CAMERA" />`
* Add the Barcode activity to your AndroidManifest.xml
`<activity android:name="com.apptreesoftware.barcodescan.BarcodeScannerActivity"/>`
### iOS
To use on iOS, you must add the the camera usage description to your Info.plist
<key>NSCameraUsageDescription</key>
<string>Camera permission is required for barcode scanning.</string>