Giter Club home page Giter Club logo

webrtc-qrcode-reader's Introduction

webrtc-qrcode-reader

About

This is a JavaScript library to create a QRCode reader for WebRTC compatible browser.

Demo

See a demo: https://advanceboy.github.io/webrtc-qrcode-reader/

Usage

  1. Include jsqrcode-combined.min.js and webrtc-qrcode-reader.min.js in the lib directory.
  2. Create a <div> element with a size you want to show.
    <div style="width: 480px; height: 480px;" id="scanner"></div>
    
  3. Call the WebRtcQR.startReaderAsync function on the div element.
    WebRtcQR.startReaderAsync(document.getElementById('scanner');, function (success, result) {
        if (success) {
            // do something when code is read
        } else {
            // show scan errors
        }
    }, { zoomScale: 1.0 })
        .catch(function (e) {
            // show initialize video streaming errors
        })
        .then(function (context) {
            // you got the QRCode reader context.
        });
    
    • callback function will be called on each scanning.
    • The Promise instance signs that the initialize of video streaming was succeed or not.
  4. You can configure scanning the through readerContext instance got from the Promise onFulfilled callback.

Options

  • scanInterval
    • scanning interval. default: 250(ms)
  • zoomScale
    • zoom scaling. default: 1.0
    • This parameter needs to be between 1.0 and 4.0.
    • You can change this parameter after starting the scanning through options property of the ReaderContext.
  • decodeSize
    • The temporary canvas size used in decoding. defailt: 480

LICENSE

This Project

See LICENSE file.

jsqrcode

See the license notice implemented in the source code (jsqrcode-combined.min.js).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.