Codex Mobile Barcode SDK - Apache Cordova™插件

要监控MX设备使用的可用性:

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

使用

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

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

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

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

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

具体的例子有:

cmbScanner.setConnectionStateDidChangeOfReaderCallback（函数（connectionState）{if（connectionState==cmbScanner.CONSTANTS.CONNECTION_STATE_CONNECTED）{//在连接时执行一些操作，例如将符号设置为enabled返回cmbScanner.setSymbologyEnabled（“SYMBOL.QR”，true）。然后（函数（rr）{//有关rr的更多信息，请参阅setSymbologyEnabled）（返回结果）对象//设置符号后，我们可以发送一个命令。让我们在cmbScanner.sendCommand（“set LIGHT.INTERNAL-ENABLE ON”）上设置闪光灯。然后（函数（结果）{//如果命令成功，我们应该在启动扫描过程时打开指示灯//并且为了检查闪光灯是否打开，我们可以使用isLightsOn API方法cmbScanner.isLightsOn（）。然后（函数（lights_ON）{//LIGHT should ON}）；}）；}）；

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

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

宣言

使用

cmbscanner.setActivestartArtScanningCallback（函数（Scannstate）{if（scannstate == true）{console.log（'扫描仪工作'）;否则{console.log（'扫描仪不起作用'）;}};

如前所述，设置此函数完全不需要在startscanning（）或停止扫描（）方法。

尽管让动作在承诺中返回或在之后立即回调似乎更合适startscanning（）/停止扫描（）被称为，由于性质stopScanning进程，它在每次有结果时发生，最好在同一位置侦听两个动作(启动和停止)。

要检查并要求允许使用相机，用于与移动设备扫描条形码。

checkCameraPermission声明

requestCameraPermission声明

/* @return (promise) {status: boolean，允许使用相机消息的状态:int，如果允许，则为1，否则为0}*/

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

startScanning宣言

停止宣言

使用

由于读者的性质，我们应该始终设置setActiveStartScanningCallback（）函数，如果我们希望根据扫描仪（读卡器）的状态控制某些DOM元素。

cmbscanner . startscan (function(scannerState){if(scannerState) document.getElementById(' scannerState -active-label')[remove] = 'RUNNING';else document.getElementById('scanner-active-label')[deleted] = '已停止';}）;

例子

启动扫描仪的按钮-->启动扫描仪的按钮-->停止扫描仪的按钮-->停止扫描仪的按钮-->“>Start scanner<！--按钮使用回调启动扫描仪，避免此操作，并始终使用setActiveStartScanningCallback-->

要从图像扫描条形码，我们可以使用Scanimage或ScanimageFrombase64。

scanImage宣言

scanImageFromBase64宣言

/ * @返回（许诺）{状态：布尔，图像扫描执行ERR的状态：串，如果状态假ERR将不能为空} * /

要检查，如果我们有启用符号，我们使用isSymbologyEnabled ()．

/ ** @return包含对象{action：调用的dmcc命令的承诺：它是否成功了，如果发生错误，它将设置为假结果：如果符号已启用，则为真，如果不是那么false err：如果操作没有完成，则错误消息} * /

例子

cmbScanner.isSymbologyEnabled（“SYMBOL.C93”，function（rr）{console.log（JSON.stringify（rr））；//将打印{“action”：“GET SYMBOL.C93”，“status”：true，“err”：null，“result”：true}）；

要设置将摄像头设备用作条形码阅读器时摄像头的行为，请使用：

/**使用无瞄准器的相机。预览打开，照明可用。使用基本瞄准器(例如，StingRay)。预览关闭，照明不可用。被动瞄准器= 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,0,100,50）;//将预览设置为0,0和100％宽度50％高度

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

仅适用于iOS的，仅适用于相机的读者。

将摄影机预览部分视图顶轴设置为从与Androids行为匹配的状态栏下方开始。它需要一个布尔参数。

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.SetStopscannerOnotate（真实）;

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

以编程方式启用闪光灯的光，我们可以使用：

/**@return一个包含JSON对象{（string）操作的承诺：被调用的DMCC命令（bool）状态：是否成功，如果发生错误，它将被设置为false（string）err：如果操作未完成，错误消息（bool）结果：所采取操作的结果，在本例中，如果灯光已启用，则为TRUE；如果未启用，则为false}*/

例子

cmbScanner.setLightsOn（真，功能（响应）{//console.log(response）;}）;cmbScanner.setLightsOn（真）。然后（函数（响应）{//或承诺，回调函数是一个承诺内包裹//所以如果我们不设置一个回调函数作为PARAM，默认的会使用//它会返回一个承诺继续链}）;

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

/**@return一个包含JSON对象{（string）操作的承诺：被调用的DMCC命令（bool）状态：是否成功，如果发生错误，它将被设置为false（string）err：如果操作未完成，错误消息（bool）结果：所采取操作的结果，在本例中，如果灯光已启用，则为TRUE；如果未启用，则为false}*/

例子

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

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

宣言

使用

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

条形码结果对象的结构是：

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

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

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

设置读取结果类型的编码。期待CMB.Constants.ReadString_Encoding类型的一个参数。

cmb.setReadStringEncoding（cmb.CONSTANTS.ReadStringEncoding.UTF_8）；

大多数API方法都可以替换为只向MX（或摄像头）读取器发送适当的命令。

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

使用

cmbScanner。sendCommand(“设置标志。POSTNET OFF") .then(function(result){//在promise中让我们看看我们的命令做了什么}）;//类似cmbScanner。sendCommand(“光。then(function(result){//如果命令成功，当我们启动扫描进程时，应该将LIGHT打开。}）;

第一个命令将禁用符号邮政网．第二个将设置闪光灯开。

这两种操作都可以通过相应的API函数执行SetyymbologyEnabled（）和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”）。然后（函数（响应）{//这将调用USER1的存储设置项，因此MX设备基本上会发出两次嘟嘟声，并伴有红色LED和振动}）

仅适用于iOS系统。

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

使用CMBSDK框架的IOS应用程序可以将附加的移动终端的状态信息报告给MDM实例。可以使用leasemdmreporting的方法启用，该方法接受一个布尔参数。

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

cmb.setmdmreportingEnabled（true）;

仅适用于iOS系统。

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

应在setMDMReportingEnabled之前调用。

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

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

如果我们需要重新设置MX/摄像头读取器的配置，我们可以使用:

宣言

使用

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

结果界面

/ * @返回一个承诺，包含JSON对象{（串）动作：这是调用（布尔）状态DMCC命令：没有它成功与否，如果发生错误，将被设置为false（字符串）错误：在错误消息，如果动作没有完成并且有错误。缺省为空（布尔）结果：在sendCommand动作的结果} * /

如果您使用的是摄像头设备，则可以使用另一种方法添加许可证密钥。这将从清单中覆盖您的许可证密钥安卓或info.plist for网间网操作系统．

例子

cmbscanner.registersdk（“sdk_key”）;

要查看您当前使用的是什么版本cmbSDK：

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

获取相机曝光补偿范围。

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

cmbScanner.getCameraExposureCompensationRange（函数（范围）{//范围是具有这些属性// JSON对象“下”：分相机曝光值//“上”：最大相机曝光值//“步骤”：相机曝光步骤值控制台。日志（JSON.stringify（范围））;}，函数（误差）{的console.log（误差）;}）;

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

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

cmbscanner.setcameraexpoosurecompensation（5，函数（错误）{console.log（错误）;}）;

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