36 lines
1.0 KiB
Markdown
36 lines
1.0 KiB
Markdown
# ZBar Barcode Scanner Plugin
|
|
|
|
This plugin integrates with the [ZBar](http://zbar.sourceforge.net/) library,
|
|
exposing a JavaScript interface for scanning barcodes (QR, 2D, etc).
|
|
|
|
## Installation
|
|
|
|
cordova plugins install org.cloudsky.cordovaplugins.zbar
|
|
|
|
## License
|
|
|
|
This plugin is released under the Apache 2.0 license, but the ZBar library on which it depends (and which is distribute with this plugin) is under the LGPL license (2.1).
|
|
|
|
## API
|
|
|
|
### Scan barcode
|
|
|
|
cloudSky.zBar.scan(params, onSuccess, onFailure)
|
|
|
|
Arguments:
|
|
|
|
- **params**: _Unused for now. Will be an object in the future if we extend this plugin with options to specify scannable barcode types, etc._
|
|
- **onSuccess**: function (s) {...} _Callback for successful scan._
|
|
- **onFailure**: function (s) {...} _Callback for cancelled scan or error._
|
|
|
|
Return:
|
|
|
|
- success('scanned bar code') _Successful scan with value of scanned code_
|
|
- error('cancelled') _If user cancelled the scan (with back button etc)_
|
|
- error('misc error message') _Misc failure_
|
|
|
|
Status:
|
|
|
|
- Android: DONE
|
|
- iOS: DONE
|