barcode

Barcode模块管理二维码，提供二维码扫描识别功能，可调用设备的摄像头对二维码图片扫描进行数据输入。通过plus.barcode可获取二维码管理对象。

常量：

• QR: 二维码类型常量，QR码，数值为0
• EAN13: 二维码类型常量，EAN码标准版，数值为1
• EAN8: 二维码类型常量，ENA码简版，数值为2
• AZTEC: 二维码类型常量，Aztec码，数值为3
• DATAMATRIX: 二维码类型常量，Data Matrix码，数值为4
• UPCA: 二维码类型常量，UPC码标准版，数值为5
• UPCE: 二维码类型常量，UPC码缩短版，数值为6
• CODABAR: 二维码类型常量，Codabar码，数值为7
• CODE39: 二维码类型常量，Code39码，数值为8
• CODE93: 二维码类型常量，Code93码，数值为9
• CODE128: 二维码类型常量，Code128码，数值为10
• ITF: 二维码类型常量，ITF码，数值为11
• MAXICODE: 二维码类型常量，MaxiCode码，数值为12
• PDF417: 二维码类型常量，PDF 417码，数值为13
• RSS14: 二维码类型常量，RSS 14码，数值为14
• RSSEXPANDED: 二维码类型常量，扩展式RSS码，数值为15

方法：

• scan: 通过图片扫描二维码数据

对象：

• Barcode: 二维码识别控件对象
• BarcodeOption: JSON对象，二维码识别控件扫描参数

回调方法：

• BarcodeSuccessCallback: 二维码识别成功的回调函数
• BarcodeErrorCallback: 二维码识别错误的回调函数

权限：

permissions

"Barcode": {
	"description": "访问二维码扫描插件"
}
			

Barcode

二维码识别控件对象

interface plus.barcode.Barcode {
	// Methods
	function void start( options );
	function void cancel();
	function void setFlash( open );

	// Events
	function void onmarked();
	function void onerror();
}
				

说明：

Barcode对象表示二维码识别控件对象，用于在窗口中显示二维码识别控件，使用此对象可自定义二维码识别界面。

构造：

• Barcode.constructor(id,filters): 创建Barcode对象

方法：

• start: 开始二维码识别
• cancel: 结束二维码识别
• setFlash: 是否开启闪光灯

事件：

• onmarked: 二维码识别成功事件
• onerror: 二维码识别错误事件

BarcodeOption

JSON对象，二维码识别控件扫描参数

interface plus.barcode.BarcodeOption {
	attribute Boolean conserve;
	attribute DOMString filename;
}
				

说明：

用于设置二维码识别控件扫描二维码的参数，如是否保存扫描成功时的图片等。

属性：

• conserve: (Boolean 类型 )是否保存成功扫描到的二维码数据时的图片
  

  如果设置为true则在成功扫描到二维码数据时将图片保存，并通过onmarked回调函数的file参数返回保存文件的路径。默认值为false，不保存图片。

• filename: (DOMString 类型 )保存成功扫描到的二维码数据时的图片路径
  

  可通过此参数设置保存图片的路径或名，如果设置图片文件名称则必须指定文件的后缀名（必须是.png），否则认为是指定目录，文件名称则自动生成。

BarcodeSuccessCallback

二维码识别成功的回调函数

void BarcodeSuccessCallback ( type, code, file ) {
	// Barcode success code
}
				

说明：

当获取二维码识别成功时的回调函数，用于返回识别成功的数据。

参数：

• type: ( Number ) 必选 识别到的二维码类型
  Number类型的值，与Barcode对象定义的二维码类型常量一致。
• code: ( DOMString ) 必选 识别到的二维码数据
  从二维码图片中扫描出的数据内容，字符串采用UTF8编码格式。
• file: ( DOMString ) 可选 识别到的二维码图片文件路径
  识别到的二维码数据图片，为png格式文件，为设置为不保存图片，则返回undefined。

返回值：

BarcodeErrorCallback

二维码识别错误的回调函数

void BarcodeErrorCallback( error ) {
	// Handle error
}
				

参数：

• error: ( DOMException ) 必选 二维码识别的错误信息
  

返回值：