Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Real-time webcam-driven HTML5 QR code scanner.
Note: Chrome requires HTTPS when using the WebRTC API. Any pages using this library should be served over HTTPS.
npm install --save instascan
var Instascan = require('instascan');
Pending. Drop a note if you need Bower support.
Copy instascan.min.js
from the releases page and load with:
<script type="text/javascript" src="instascan.min.js"></script>
<!DOCTYPE html>
<html>
<head>
<title>Instascan</title>
<script type="text/javascript" src="instascan.min.js"></script>
</head>
<body>
<video id="preview"></video>
<script type="text/javascript">
var scanner = new Instascan.Scanner({ video: document.getElementById('preview') });
scanner.addListener('scan', function (content, image) {
console.log(content);
});
Instascan.Camera.getCameras().then(function (cameras) {
if (cameras.length > 0) {
scanner.start(cameras[0]);
}
});
</script>
</body>
</html>
opts.continuous
: Whether to scan continuously for QR codes. If false
, use scanner.scan
to manually scan. Default true
.opts.video
: The HTML element to use for the camera's video preview. Must be a <video>
element. When the camera is active, this element will have the active
CSS class, otherwise, it will have the inactive
class. By default, an invisible element will be created to host the video.opts.mirror
: Whether to horizontally mirror the video preview. This is helpful when trying to scan a QR code with a user-facing camera. Default true
.opts.captureImage
: Whether to include the scanned image data as part of the scan result. See the scan
event for format details. Default false
.opts.backgroundScan
: Only applies to continuous mode. Whether to actively scan when the tab is not active. When false
, this reduces CPU usage when the tab is not active. Default false
.opts.refractoryPeriod
: Only applies to continuous mode. The period, in milliseconds, before the same QR code will be recognized in succession. Default 5000
.opts.scanPeriod
: Only applies to continuous mode. The period, in rendered frames, between scans. A lower scan period increases CPU usage but makes scan response faster. Default 1
(i.e. analyze every frame).camera
and start scanning using it as the source. Returns promise.scanner.scan
or receive scan
events.camera
: Instance of Instascan.Camera
from Instascan.Camera.getCameras
.function ()
, called when camera is active and scanning has started.function ()
, called when camera and scanning have stopped.scan
event.result
is null
.result.content
: Scanned content decoded from the QR code.result.image
: Undefined if scanner.captureImage
is false
, otherwise, see the scan
event for format.scanner.continuous
).callback
: function (content, image)
content
: Scanned content decoded from the QR code.image
: null
if scanner.captureImage
is false
, otherwise, a base64-encoded WebP-compressed data URI of the camera frame used to decode the QR code.scanner.start
or the tab gaining focus.opts.video
element was specified, it will have the active
CSS class.callback
: function ()
scanner.stop
or the tab losing focus.opts.video
element was specified, it will have the inactive
CSS class.callback
: function ()
function (cameras)
, called when cameras are available.cameras
: Array of Instascan.Camera
instances available for use.null
if the user has not yet allowed camera access, e.g. on first launch of the app.Instascan works with any browser that supports the getUserMedia API, which currently includes Chome, Firefox, Opera, and Edge. IE and Safari are not supported.
Many factors affect how quickly and reliably Instascan can detect QR codes.
If you control creation of the QR code, consider the following:
When scanning, consider the following:
Powered by the Emscripten JavaScript build of the C++ port of the ZXing Java library.
Copyright © 2016 Chris Schmich
MIT License. See LICENSE for details.
FAQs
Webcam-driven QR code scanner.
The npm package instascan receives a total of 6,165 weekly downloads. As such, instascan popularity was classified as popular.
We found that instascan demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.