cordova-plugin-cszbar-jsg/README.md

1.0 KiB

ZBar Barcode Scanner Plugin

This plugin integrates with the ZBar 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