uexScanner查看3.0文档

  • 1、简介
  • 2、API概览
  • 3、更新历史

    1、简介

    二维码插件
    1.1、说明
    条形码,二维码等扫描,此插件提供可以自定义扫描界面UI设置接口,用户传入资源文件,使其效果更能满足应用的需求和ui设计

    本文的目的是为了开发能够更好更快地将API集成到自己的项目中,在使用前最好先使用好我们提供的demo并对照文档运行看看效果。
    这里可以【参考教程】下载AppCan IDE为开发者工具开发,然后集成到自己的项目上。
    备注:iOS应用需要配置隐私权限才能正常调用,参考【1.5、接口有效性】。

1.2、UI展示

1.3、开源源码

插件测试用例与源码下载:点击插件中心至插件详情页 (插件测试用例与插件源码已经提供)

1.4、平台版本支持

本插件的所有API默认支持Android4.0+iOS7.0+操作系统. 有特殊版本要求的API会在文档中额外说明.

1.5、接口有效性

本插件所有API默认在插件版本4.0.0+可用.
在后续版本中新添加的接口会在文档中额外说明.
iOS隐私权限配置说明

2、API概览

2.1、方法
open //开启扫描功能

uexScanner.open(callbackFunction)

说明:

开启扫描功能,当扫描完成后会执行回调函数

参数:

参数名称 参数类型 是否必选 说明
callbackFunction Function 扫描成功后的回调函数

回调参数:

var callbackFunction = function(error,data){}
参数名称 类型 说明
error Number 扫描结果,0-成功,非0-失败,打开失败通常是因为没有开启摄像头权限.
data Object 扫描成功的数据,形式如下:
var data = {
    code:, 
    type:
}

示例:

var callback = function(error,data) {
  if(!error){
    alert("data:" + JSON.stringify(data));
  }else{
    alert("failed!");
  }
};
uexScanner.open(callback);
setJsonData //设置数据

uexScanner.setJsonData(params)

说明:

可以自定义扫描界面,未设置的话为默认界面 自定义二维码扫描图片资源,图片路径支持 wgt:// wgts:// res:// file:// 路径协议详见CONSTANT中PathTypes

参数:

参数名称 参数类型 是否必选 说明
params Object 接口所需相关数据,形式见下:
var params = {
    lineImg: ,
    pickBgImg: ,
    tipLabel: ,
    title: ,
    charset:
}

各字段含义如下:

字段名称 类型 是否必选 说明
lineImg String 扫描时移动的光线
pickBgImg String 扫描区域边框图片
tipLabel String 扫描区下部提示语
title String 否,仅iOS支持 扫描界面顶部标题
charset String 设置字符编码

示例:

var jsonData = {
  lineImg:"res://line.png",
  pickBgImg:"res://pick_bg.png",
  tipLabel:"对准二维码/条形码,即可自动扫描",
  title:"扫一下"
};
uexScanner.setJsonData(jsonData);

recognizeFromImage //传入条形码、二维码图片路径

var result = uexScanner.recognizeFromImage(imagePath)

说明:

传入条形码、二维码图片路径,同步返回识别结果。图片路径支持http https ,还有 wgt:// wgts:// res:// file:// 路径协议详见CONSTANT中PathTypes

参数:

参数名称 参数类型 是否必选 说明
imagePath String 条形码、二维码图片路径

返回结果:

参数名称 类型 说明
result String 识别图片后返回对应的信息

示例:

  var result = uexScanner.recognizeFromImage("res://scanner.png");

3、更新历史

iOS

API版本: uexScanner-4.0.1

最近更新时间:2017-1-16

历史发布版本 更新内容
4.0.1 修复首次启动用户确认相机权限时可能闪退的问题
Android

API版本: uexScanner-4.0.0

最近更新时间:2016-6-11

历史发布版本 更新内容
还需要帮助吗? 联系我们
最新更新 19th Jan 2017