Updated docs

gh-pages
Christoph Oberhofer 9 years ago
parent d23ed53718
commit 29abd69b82

@ -8,6 +8,7 @@ quaggaJS
======== ========
- [Changelog](#changelog) (2016-03-31) - [Changelog](#changelog) (2016-03-31)
- [Browser Support](#browser-support)
- [Installing](#installing) - [Installing](#installing)
- [Getting Started](#gettingstarted) - [Getting Started](#gettingstarted)
- [API](#api) - [API](#api)
@ -40,18 +41,30 @@ invariant to scale and rotation, whereas other libraries require the barcode to
be aligned with the viewport. be aligned with the viewport.
## Requirements ## <a name="browser-support">Browser Support</a>
In order to take full advantage of quaggaJS, the browser needs to support the Quagga makes use of many modern Web-APIs which are not implemented by all
`getUserMedia` API which is already implemented in recent versions of Firefox, browsers yet. There are two modes in which Quagga operates: 1. analyzing static
Chrome, IE (Edge) and Opera. The API is also available on their mobile images and 2. using a camera to decode the images from a live-stream. The latter
counterparts installed on Android (except IE). Safari does not allow the access requires the presence of the MediaDevices API. You can track the compatibility
to the camera yet, neither on desktop, nor on mobile. You can check of the used Web-APIs for each mode:
[caniuse][caniuse_getusermedia] for updates.
In cases where real-time decoding is not needed, or the platform does not - [Static Images](http://caniuse.com/#feat=webworkers,canvas,typedarrays,bloburls,blobbuilder)
support `getUserMedia` QuaggaJS is also capable of decoding image-files using - [Live Stream](http://caniuse.com/#feat=webworkers,canvas,typedarrays,bloburls,blobbuilder,stream)
the File API or other URL sources.
### Static Images
The following APIs need to be implemented in your browser:
- [webworkers](http://caniuse.com/#feat=webworkers)
- [canvas](http://caniuse.com/#feat=canvas)
- [typedarrays](http://caniuse.com/#feat=typedarrays)
- [bloburls](http://caniuse.com/#feat=bloburls)
- [blobbuilder](http://caniuse.com/#feat=blobbuilder)
### Live Stream
In addition to the APIs mentioned above:
- [MediaDevices](http://caniuse.com/#feat=stream)
## <a name="installing">Installing</a> ## <a name="installing">Installing</a>

Loading…
Cancel
Save