NumScan SDK集成说明

NumScan SDK集成说明 v1.0

 

目  录

1       SDK授权Key获取... 1

2       集成SDK.. 1

2.1         SDK说明... 1

2.2         快速集成... 1

2.2.1     Android工程创建... 1

2.2.2     Layout布局... 1

2.2.3     设置相机及扫描框... 2

2.2.4     初始化扫描模块... 2

2.2.5     获取扫描结果... 2

3       SDK API说明... 2

3.1         com.dieqms.scanner 2

3.1.1     init 2

3.1.2     setScanMode. 3

3.1.3     enableFlipScan. 3

3.1.4     scanNum.. 3

3.2         com.dieqms.scanresult 3

3.2.1     num.. 3

 

 

1. SDK授权Key获取

SDK针对每个Android App包名有唯一授权Key，在集成使用该SDK前请联系 微信号dieqms 获取授权Key。

 

在SDK初始化阶段，需要输入授权Key，当Key非法或无效时，将导致SDK无法正常工作。

1. 集成SDK
   1. SDK说明

SDK主要包含jar包、so库，号码扫描功能需要使用到以上所有文件，需全部集成到Android项目当中。

1. 1. 快速集成
      1.  Android工程创建

在Eclipse或Android Studio创建App工程，然后将SDK中libs所有文件拷贝到项目源码libs目录下。

 

设置App相机权限

 

Android 6以上需要通过PermissionManager动态申请相机权限。

1. 1. 1.  Layout布局

在App扫描界面，增加相机SurfaceView以及绘制扫描框的SurfaceView，具体参考demo源码。

 

1. 1. 1.  设置相机及扫描框

参考demo源码完成相机初始化以及扫描框的绘制功能。

 

1. 1. 1.  初始化扫描模块

private com.dieqms.scanner.Scanner mScanner;

 

 

上面的“b8d3dd00”为demo的授权Key，集成时需要替换为自己App对应的授权Key。

1. 1. 1.  获取扫描结果

开启Timer周期获取扫描框Bitmap图像，传送给Scanner

 

若识别出号码，在ScanResult中num方法中会返回识别出的电话号码。

 

注意：

识别时只传入一次Bitmap时，可能不会识别出号码，需连续将扫描框中的Bitmap数据传给Scanner进行号码识别。

1. SDK API说明
   1. com.dieqms.scanner
      1.  init

原型：public void init(String key, Context context)

描述：SDK初始化

参数：Key   SDK授权Key

context Android Context

注意：务必输入正确授权Key

 

1. 1. 1.  setScanMode

原型：public void setScanMode(int mode)

描述：设置扫描模式

参数：mode识别模式

           SCAN_MODE_AUTO         固话号、手机号

           SCAN_MODE_TELLPHONE   固话号

           SCAN_MODE_CELLPHONE   手机号

注意：若使用场景只识别手机号，建议只设置SCAN_MODE_CELLPHONE

 

1. 1. 1.  enableFlipScan

原型：public void enableFlipScan(boolean enable)

描述：使能翻转识别

参数：enable true / false

注意：使能后识别速度、准确率会降低，非必要不用设置

 

1. 1. 1.  scanNum

原型：public synchronized static void scanNum(Bitmap bmp, ScanResult result)

描述：识别号码

参数：bmp扫描框位图数据

            result 识别回调接口

注意：bmp为扫描框的图像数据，不能将整幅图像进行识别，需控制扫描框尺寸，仅将扫描框中的bmp图像数据传递给该方法，具体尺寸请参考demo。

1. 1. com.dieqms.scanresult
      1.  num

原型： public void num(boolean success, String num, String errorInfo);

描述：识别结果

参数：success true 成功，false 失败

            num 仅success为true时返回电话号码

errorInfo 识别错误信息

 

NumScan SDK Demo已放到网盘：
链接: https://pan.baidu.com/s/1L3qlnQqgbG4WEVVQbqUUKg 提取码: 2qc3