cordova-plugin-cszbar-jsg/README.md

28 lines
799 B
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).
## 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