Apache Cordova™插件

要启动并运行扫描仪，首先要做的是调用loadScanner ()方法。

它期望设备类型和一个回调作为第二个参数。的回调函数被包装在Promise中，并作为Promise返回。

/* @return {const (string)action:所采取的操作(将始终返回LOAD READER) (string) result:来自服务器的消息(bool) status:如果读取器被加载，它将返回true (string) err:如果抛出错误则返回字符串错误(int) type:我们连接的设备类型[0,1](string) name:设备类型的名称DEVICES[type]} */

设备类型参数可以是一个字符串常量，可能的值为:

设备:[" device_type_mx_1000 "，" device_type_mobile_device "]

或者我们可以直接为DEVICE_TYPE_MX传递0，为DEVICE_TYPE_MOBILE_DEVICE传递1

例子

cmbScanner.loadScanner("DEVICE_TYPE_MOBILE_DEVICE"，function(result){cmbScanner.connect();});//示例作为承诺cbscanner . loadscanner ("DEVICE_TYPE_MOBILE_DEVICE").then(函数(结果){cbscanner .connect();});//示例将设备类型传递为整数cbscanner . loadscanner (0).then(function(result){cbscanner .connect();})；

要在加载READER后连接到它，我们需要使用连接．

cmbScanner.connect((回调));

/* @返回(承诺){状态:布尔值，如果连接成功则为true，如果不为false err:字符串，如果状态为false err将不为null} */

例子

/**使用connect并返回承诺值*/ cmbScanner.connect().then(function(connectionState){console.log(connectionState);// {"status": false， "err": "Did not return OK in success"}});/**使用connect并将值作为回调函数返回*/ cmbScanner.connect(function(connectionState){console.log(connectionState);});

的结果连接action，不建议对连接回调的结果进行操作，目的是更新DOM元素或调用只有在我们有连接集之后才有效的API方法。

有一个监听器回调（setConnectionStateDidChangeOfReaderCallback）可以设置的函数，它总是会在连接状态发生变化时触发我们应该保留那里的代码。

/* @返回(承诺){状态:布尔值，如果连接成功则为true，如果不为false err:字符串，如果状态为false err将不为null} */

就像这样connect ()，有一个断开()方法，其作用与connect ()：

cmbScanner.disconnect((回调))

类似于connect ()，断开()too返回回调函数中的connectionState(它被包装成Promise)，我们可以对connectionState进行操作，例如将标签从“connected”更改为“disconnected”:

cmbScanner.disconnect(function(connectionState){if(connectionState == cmbScanner.CONSTANTS.CONNECTION_STATE_DISCONNECTED){document.getElementById('some-label').innerHtml('DISCONNECTED');} else if (connectionState == cmbScanner.CONSTANTS.CONNECTION_STATE_CONNECTED){document.getElementById('some-label').innerHtml('DISCONNECTED');}})

但是，就像connect ()我们没必要这么做，因为setConnectionStateDidChangeOfReaderCallback ()将监听器设置为所有连接/断开/连接/断开事件。

要处理成功的扫描结果，需要设置ResultCallback函数。这是通过setResultCallback．

它为所有对象设置回调函数didReceiveReadResultFromReader事件。

cmbScanner.setResultCallback(函数(结果){if(结果&&结果。readResults && result.readResults.length > 0){result.readResults.lengthforEach(函数(项目，索引){if(项目，索引)goodRead == true){//对条形码读取执行一些操作//例如:document.getElementById('content')。insertAdjacentHTML('beforeend'，'
'+item。symbologyString +”< / span >: ' + item.readString + < / div >);//我们可以把所有这些DOM处理放在DOM helper对象中，但由于它只是一行代码，让我们保留它}else{//在没有读取条形码时执行一些操作或将其保留为空// navigator.notification.alert("Stopped");}});}});

ResultCallback将在每次进行条形码扫描时触发(或者扫描仪被手动停止，或者它超时而没有结果)。

结果对象

条形码结果的结构如下:

监视MX设备使用的可用性:

在可用性更改上设置侦听器。将在设备可用或失去可用性时触发。

使用

cmbScanner.setAvialabilityCallback(函数(可用性){/ * * *可用性- int表示设备的可用性* /如果(可用性= = CONSTANTS.AVAILABILITY_UNKNOWN){/ /执行一些操作时设备可用性}不知道其他如果(可用性= = CONSTANTS.AVAILABILITY_AVAILABLE){/ /执行一些操作设备时可用}其他如果(可用性= = CONSTANTS.AVAILABILITY_UNAVAILABLE){/ /执行一些操作时设备不可用}});

所有连接/断开连接事件应该在回调函数集中用这个API方法处理。

回调是可选的，因为插件提供了一个默认的回调来处理连接/断开连接事件，但默认回调只是一个占位符函数，并没有为最终应用程序开发人员提供太多功能。

当connetionStateDidChange被触发时，它将返回4个可能的整数值之一

这些可以作为整数直接访问，或者开发人员可以通过访问cmbScanner中的CONSTANTS对象从可用的CONSTANTS枚举中使用它们．

具体例子如下:

cmbScanner.setConnectionStateDidChangeOfReaderCallback(function(connectionState){if(connectionState == cmbScanner.CONSTANTS.CONNECTION_STATE_CONNECTED){//在连接时做一些事情，比如设置一个符号为enabled返回cmbScanner.setSymbologyEnabled(" symbol . qr "，true).then(function(rr){//看到setSymbologyEnabled关于rr(返回结果)对象的更多信息//符号设置后，我们可以发送一个命令。让我们设置闪光灯在cmbScanner上。sendCommand(“光。INTERNAL-ENABLE ON") .then(function(result){//如果命令成功，当我们开始扫描过程时，我们应该让LIGHT打开//并且要检查闪光灯是否打开，我们可以使用isLightsOn API方法cmbScanner.isLightsOn().then(function(lights_on){//灯应该打开});});});}});

在这里我们不仅听连接/断开连接事件，但我们也启用一些符号和设置闪光灯，通过命令和API方法isLightsOn．

如果我们想监视扫描器(READER)的状态，我们需要设置这个回调函数。

宣言

使用

cmbScanner.setActiveStartScanningCallback(function(scannerState){if(scannerState == true){console.log('扫描仪正在工作');} else{console.log('扫描器不工作');}});

方法上设置回调函数的需要完全消除了startScanning ()或stopScanning ()方法。

尽管在承诺或回调中立即返回该操作似乎更合适startScanning ()/stopScanning ()被称为，缘于本性stopScanning过程，每次有结果时都会发生，最好在同一位置侦听两个操作(启动和停止)。

检查并请求使用移动设备扫描条形码的摄像头的许可。

checkCameraPermission宣言

requestCameraPermission宣言

/* @return (promise){状态:boolean，使用摄像头的权限状态消息:int，如果可以请求权限，则为1，否则为0}*/

要启动/停止扫描进程，我们使用以下两种方法。它们既可以通过应用程序的UI从按钮调用，也可以通过编程方式调用。

startScanning宣言

stopScanning宣言

使用

由于读者的性质，我们应该始终设置setActiveStartScanningCallback ()函数，如果我们想基于扫描器(Reader)的状态来控制某些DOM元素。

cmbScanner.startScanning(function(scannerState){if(scannerState) document.getElementById('scanner-active-label')[removed] = 'RUNNING';else document.getElementById('scanner-active-label')[removed] = 'STOPPED';})；

例子

< a href = " cmbScanner.startScanning ();">Start Scanner  Stop Scanner  Start Scanner 

要从图像中扫描条形码，我们可以使用scanImage或scanImageFromBase64。

scanImage宣言

scanImageFromBase64宣言

/* @返回(承诺){状态:布尔值，图像扫描执行状态err:字符串，如果状态为false err将不为空}*/

要检查是否启用了某个符号，可以使用isSymbologyEnabled ()．

/** @return一个承诺，包含对象{action:被调用的DMCC命令status:它是否成功，如果发生错误，它将被设置为false result:如果符号被启用则为true，如果没有则为false err:如果操作未完成则错误消息}*/

例子

cmbScanner.isSymbologyEnabled(“SYMBOL.C93函数(rr) {console.log (JSON.stringify (rr));//输出{"action": "GET符号。C93”、“地位”:真的,“犯错”:空,“结果”:真正}});

当我们使用相机设备作为条形码阅读器时，要设置相机的行为:

/**使用无瞄准镜的相机。预览是打开的，照明可用。NO_AIMER = 0，使用带有基本瞄准器的相机(例如StingRay)。预览关闭，照明不可用。PASSIVE_AIMER = 1，使用主动瞄准器的相机(例如MX-100)。预览关闭，照明可用。ACTIVE_AIMER = 2，使用移动设备前置摄像头。预览打开，照明不可用。Front_camera = 3 */

当使用移动设备摄像头时，这控制预览/扫描选项。多个选项可以一起“或”。

/** *使用默认值(不覆盖)。*/ "DEFAULTS": 0， /** *禁用缩放功能(从预览中删除缩放按钮)。*/ "NO_ZOOM_BTN": 1， /** *关闭照明(从预览中删除照明按钮)。*/ "NO_ILLUM_BTN": 2， /** *开启模拟硬件触发器(音量降低按钮)。*/ "HARDWARE_TRIGGER": 4， /** *扫描开始时，显示预览，但解码暂停，直到按下触发器(屏幕上的按钮或音量下降按钮，如果启用)。*/ "PREVIEW_PAUSED": 8， /** *强制显示预览，即使默认关闭(例如，当使用kCDMCameraModePassiveAimer或kCDMCameraModeActiveAimer时)。*/ "PREVIEW_ALWAYS_SHOW": 16， /** *如果设备支持，请使用更高的分辨率。默认值是1280x720，在此参数下将使用1920x1080。*/ "HIGH_RESOLUTION": 64， /** *如果设备支持，请使用更高的帧速率。默认是30帧/秒，在这个参数下将使用60帧/秒。 */ "HIGH_FRAME_RATE" : 128, /** * Show close button in partial view. */ "SHOW_CLOSE_BUTTON" : 256, /** * Keep the preview in paused state after read or timeout. */ "KEEP_PREVIEW_IN_PAUSED_STATE" : 512

设置预览容器的大小和位置(仅当用户使用相机阅读器时可用):

/* @params x,y,w,h x,y:左上方位置w,h:矩形的宽度和高度在整个容器的百分比*/

cmbScanner.setPreviewContainerPositionAndSize(0、0100、50);//将设置预览为0,0和100%宽度50%高度

将相机预览设置为全屏而不是局部视图。(仅适用于用户使用相机阅读器时):

仅支持iOS，仅适用于相机阅读器。

设置摄像头预览部分视图顶部轴，以匹配android行为的状态栏下方开始。它需要一个布尔参数。

cmb.setPreviewContainerBelowStatusBar(真正的);cmb.setPreviewContainerPositionAndSize ([0, 0100, 50]);//将设置预览为0,0和100%宽度50%高度。//在iOS上，部分视图将显示在状态栏下方。

cmb.setPreviewContainerBelowStatusBar(假);cmb.setPreviewContainerPositionAndSize ([0, 0100, 50]);//将设置预览为0,0和100%宽度50%高度。//在iOS上，部分视图将从屏幕顶部开始，并将与状态栏重叠。

设置相机叠加模式。您需要在loadScanner被调用之前这样做，否则它将无法正常工作。

仅在MX-Mobile上可用。

阅读更多关于覆盖模式在这里

cmb.setPreviewOverlayMode (cmb.CONSTANTS.PREVIEW_OVERLAY_MODE.OM_CMB);

设置当应用程序UI改变方向时扫描会话是否应该停止。它需要一个布尔参数。

cmb.setStopScannerOnRotate(真正的);

在使用移动相机扫描时，在相机预览上方显示或隐藏消息。

要以编程方式启用闪光灯，我们可以使用:

/** @return一个包含JSON对象{(string) action:被调用的DMCC命令(bool) status:是否成功，如果发生错误，它将被设置为false (string) err:操作未完成时的错误消息(bool) result:所采取的操作的结果，在这种情况下，如果灯亮起，则为TRUE，否则为false} */

例子

cmbScanner.setLightsOn(真的,函数(响应){/ / console.log(响应);});cmbscannler . setlightson (true).then(function(response){//或带有一个promise，回调函数被包装在一个promise中//所以如果我们不设置一个回调函数作为参数，将使用默认的回调函数//它将返回一个promise来继续链});

要检查闪光灯是否亮着，我们可以使用:

/** @return一个包含JSON对象{(string) action:被调用的DMCC命令(bool) status:是否成功，如果发生错误，它将被设置为false (string) err:操作未完成时的错误消息(bool) result:所采取的操作的结果，在这种情况下，如果灯亮起，则为TRUE，否则为false} */

例子

cmbScanner.isLightsOn(真的,函数(响应){/ / console.log(响应);});cmbscannler . islightson (true).then(function(response){//或带有一个promise，回调函数被包装在一个promise中//所以如果我们不设置一个回调函数作为参数，将使用默认的回调函数//它将返回一个promise来继续链});

如果我们想要返回我们使用的解码器看到的最后一个图像enableImage ()．如果我们想要图像的图形统计返回的图像，我们使用enableImageGraphics()。

宣言

使用

cmbScanner.enableImage(真正的);//它将启用结果中的图像cmbScanner.enableImageGraphics(true);//将显示条码在图像上被检测到的确切位置

条形码结果对象的结构为:

interface BarcodeResult {readString: string, symbologyString: string, symbologyString: integer, goodRead: bool, xml: string, imageGraphics?:字符串，图像?:字符串};

启用或禁用扫描条形码的解析。期望一个cmb.CONSTANTS.PARSERS类型的参数。

cmb.setParser (cmb.CONSTANTS.PARSERS.GS1);

设置readString结果类型的编码。期望一个cmb.CONSTANTS.READSTRING_ENCODING类型的参数。

cmb.setReadStringEncoding (cmb.CONSTANTS.READSTRING_ENCODING.UTF_8);

大多数API方法都可以通过向MX(或Camera)阅读器发送适当的命令来替代。

Send命令接收回调并将其包装成承诺，这样链就可以继续。

使用

cmbScanner。sendCommand(“设置标志。) .then(function(result){//在承诺中让我们看看我们的命令做了什么console.log(JSON.stringify(result));});//或者像这个cmbScanner。sendCommand(“光。) .then(function(result){//如果命令成功，当我们启动扫描过程时，我们应该让LIGHT打开console.log(JSON.stringify(result));})；

第一个命令将禁用象征POSTNET．第二个按钮将打开Flash。

这两种操作都可以使用相应的API函数来执行setSymbologyEnabled ()而且setLightsOn ()一般来说，开发人员应该总是更喜欢API函数sendCommand()。

然而，在某些情况下，Cordova插件不涵盖某些用例场景，我们总是可以使用sendCommand的。

例子

如果我们想改变MX设备“哔哔声”和“灯光”的方式，我们可以使用:

在我们的例子中，我们会有:

cmbScanner。sendCommand(“设置输出。USER-CONFIGURE1 1 2 4 ON").then(function(response){ //console.log(response); //print out the result of the action });

这将配置用户事件#1到两个中蜂鸣声与红色LED和振动。为了激活这个事件，我们使用:

cmbScanner.sendCommand("OUTPUT.USER1").then(function(response){//这将调用USER1的存储设置项，因此MX设备基本上会发出两次红色LED和振动})

仅支持iOS。

拥有并运营多个康耐视移动终端的公司可能希望远程收集有关电池电量、电池健康状况、已安装固件等的最新信息。

iOS应用使用cmbSDK框架，可以向MDM实例报告连接的移动终端的状态信息。这可以通过setMDMReportingEnabled方法启用，该方法接受一个布尔参数。

关于MDM报告的更多信息可以在这里找到在这里

cmb.setMDMReportingEnabled(真正的);

仅支持iOS。

用于创建用于MDM报告的身份验证凭据。它接受四个字符串参数:用户名、密码、clientID和clientSecret。

应该在setMDMReportingEnabled之前调用。

关于MDM报告的更多信息可以在这里找到在这里

招商银行。createMDMAuthCredentials("username"， "password"， " cliententid "， "clientSecret");

如果我们需要重置MX/Camera阅读器存储的配置设置，我们可以使用:

宣言

使用

cmbScanner.resetConfig(函数(结果){console.log(结果);})

结果界面

/* @return一个包含JSON对象{(string) action的承诺:被调用的DMCC命令(bool)状态:它是否成功，如果发生错误，它将被设置为false (string) err:如果操作没有完成，有一个错误，则错误消息。默认为null (bool) result: sendCommand动作的结果}*/

如果您正在使用摄像设备，另一种添加许可密钥的方法。这将覆盖您的许可证密钥从清单安卓或信息。plist为iOS．

例子

cmbScanner.registerSDK(“SDK_KEY”);

要查看当前使用的cmbSDK版本:

包含cmbSDK版本字符串{(string) version: cmbSDK版本}*/的承诺

获取相机曝光补偿范围。

返回成功的回调，范围为JSON对象或错误回调，如果出现错误。

cmbScanner.getCameraExposureCompensationRange(函数(范围){//范围是具有这些属性的JSON对象// "lower":最小相机曝光值// "upper":最大相机曝光值// "step":相机曝光步长值console.log(JSON.stringify(范围));}，函数(错误){console.log(错误);})；

注意:相机需要在cmbSDK内启动至少一次，以获得相机曝光补偿范围。

设置相机曝光补偿值。发送将被设置为曝光补偿的浮动值。

cmbScanner。setCameraExposureCompensation(5, function(错误){console.log(错误);})；

注意:这需要在成功连接到阅读器设备后调用。如果发送的值大于相机曝光最大值，将设置最大值，如果发送的值小于相机曝光最小值，将设置最小值。