【免费下载】 Instascan 使用指南

2026-01-25 04:06:45作者：宣聪麟

Instascan 是一个基于 HTML5 的实时二维码扫描库，利用 webcam 实现快速扫码功能。本文档旨在指导您如何安装、使用 Instascan，并理解其核心API。

安装指南

通过npm安装

对于Node.js项目，您可以通过npm轻松安装Instascan：

npm install --save instascan

然后在您的代码中引入它：

const Instascan = require('instascan');

Bower支持

Bower的集成目前尚待实现。如果您需要此功能，请在项目GitHub仓库中留言(Issue #31)。

使用Minified文件

从发布页面下载instascan.min.js，并在HTML中这样引入：

<script type="text/javascript" src="path/to/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>
    let scanner = new Instascan.Scanner({ video: document.getElementById('preview') });
    scanner.addListener('scan', function(content) {
      console.log(content); // 扫描到的二维码内容将被打印
    });

    Instascan.Camera.getCameras().then(function(cameras) {
      if(cameras.length > 0) {
        scanner.start(cameras[0]); // 开始使用第一个摄像头进行扫描
      } else {
        console.error('未找到相机。');
      }
    }).catch(function(e) {
      console.error(e);
    });
  </script>
</body>
</html>

项目API使用文档

创建Scanner实例

let scanner = new Instascan.Scanner(options);

其中，options可以包含以下参数：

continuous: boolean 是否持续扫描，默认开启。
video: HTMLVideoElement 视频预览元素，默认为创建的一个隐藏视频元素。
mirror: boolean 视频是否水平镜像，默认开启，适用于前置摄像头。
captureImage: boolean 是否捕获扫描图像数据，默认关闭。
backgroundScan: boolean 当标签页非激活状态时，是否继续扫描，默认开启。
refractoryPeriod: number 连续模式下，再次识别相同二维码的时间间隔（毫秒），默认5000毫秒。
scanPeriod: number 每次分析帧数的周期，影响CPU使用率和响应速度，默认每一帧都分析。

启动和停止扫描

启动扫描

scanner.start(camera).then(() => {
  // 相机激活并开始扫描
}).catch(err => {
  console.error(err);
});

停止扫描

scanner.stop().then(() => {
  // 扫描和相机已经停止
});

手动扫描一次

scanner.scan().then(result => {
  if(result) {
    console.log(result.content); // 获取扫描结果的内容
  }
});

事件监听

// 监听扫描事件
scanner.addListener('scan', function(content, image) {
  console.log(content); // 扫描内容
  if(image) {
    // 处理图像数据，如果captureImage设置为true
  }
});

// 监听摄像头活动状态变化
scanner.addListener('active', () => {
  console.log('扫描器已激活');
});

scanner.addListener('inactive', () => {
  console.log('扫描器已停用');
});