更新记录

1.3.56.1.14(2026-09-04) 下载此版本

将祥承原生SDK打包成为UNI可用的插件包


平台兼容性

HbuilderX/cli最低兼容版本
不确定

XCScanner 扫码头 UniApp 插件

祥承XCScanner扫码头SDK的纯UniApp UTS插件封装,可直接上传至DCloud插件市场。

平台支持

Android iOS H5 小程序
× × ×

安装方式

xc-scanner 文件夹复制到项目的 uni_modules 目录下即可。

基本用法

<script>
import {
  init,
  initWithSymbology,
  deInit,
  startScan,
  stopScan,
  BARCODE_TYPE
} from "@/uni_modules/xc-scanner";

export default {
  onReady() {
    // 方式1:仅获取条码内容
    init((result) => {
      console.log('扫码结果:', result);
    });

    // 方式2:同时获取条码类型和内容
    initWithSymbology((sym, barCode) => {
      console.log('条码类型:', sym, '内容:', barCode);
    });
  },
  onHide() {
    deInit();
  },
  methods: {
    scan() {
      startScan();
    }
  }
}
</script>

API 列表

初始化与生命周期

方法 说明
init(callback) 初始化SDK,回调仅返回条码结果
initWithSymbology(callback) 初始化SDK,回调返回条码类型+结果
deInit() 反初始化SDK(页面隐藏/销毁时调用)

扫码控制

方法 说明
startScan() 开始扫码
stopScan() 停止扫码
suspendScanService() 暂停扫码服务
resumeScanService() 继续扫码服务
isScanServiceSuspending() 获取扫码服务挂起状态

连续扫码

方法 说明
setLoopScanInterval(ms) 设置连续扫码间隔(毫秒)
startLoopScan() 开始连续扫码
stopLoopScan() 停止连续扫码
isLoopScanRunning() 获取连续扫码状态

条码类型管理

方法 说明
enableBarcodeType(type, enabled) 开关条码类型
isBarcodeTypeEnabled(type) 查询条码类型是否启用

输出与提示

方法 说明
setOutputMethod(method) 设置输出方式
setSuccessNotification(type) 设置成功提示
setFailNotification(type) 设置失败提示
enableSuccessIndicator(enabled) 扫码成功指示灯开关
setScanVolume(volume) 设置扫码音量(0.0-1.0)

灯光控制

方法 说明
setAimerLightsMode(mode) 设置瞄准灯模式
setFlashLightsMode(mode) 设置补光灯模式
setStrobeLightBrightness(brightness) 设置闪光灯亮度

文本处理

方法 说明
setTextCase(textCase) 设置结果大小写转换
setTextPrefix(prefix) 设置前缀
setTextPrefix2(prefix2) 设置前缀2
setTextSuffix(suffix) 设置后缀
setTextSuffix1(suffix2) 设置后缀2

高级扫码设置

方法 说明
setMultiBarcodes(count, fixed) 设置多条码参数
setScanRegionSize(size) 设置识别范围
setTimeout(seconds) 设置扫码超时(1-9秒)
setScanTriggerMode(mode) 设置触发模式
setScanMode(mode) 设置扫码模式

条码属性配置

方法 说明
getDecoderTagValue(tag) 获取条码属性值
setDecoderTag(tag, value) 设置条码属性

授权管理

方法 说明
getLicenseState() 获取授权状态
activateLicense() 激活授权
forceNetWorkActivate() 强制重新激活

配置管理

方法 说明
exportSettings(path) 导出配置到指定路径
importSettingsByProfileName(name, path) 导入配置
loadSettings() 加载设置
saveSettings() 保存设置
resetSettings() 重置设置

按键控制

方法 说明
setFrontScanKeyEnable(enable) 正面扫码键开关
setLeftScanKeyEnable(enable) 左侧扫码键开关
setRightScanKeyEnable(enable) 右侧扫码键开关
setPoGoScanKeyEnable(enable) 手持柄扫码键开关

常量

插件导出了以下常量对象,可直接引用:

  • BARCODE_TYPE - 条码类型常量
  • OUTPUT_METHOD - 输出方式常量
  • NOTIFICATION_TYPE - 提示类型常量
  • TEXT_CASE_TYPE - 大小写类型常量
  • AIMER_MODE - 瞄准灯模式常量
  • FLASH_MODE - 补光灯模式常量
  • REGION_SIZE_TYPE - 识别范围常量
  • STROBE_LIGHT_BRIGHTNESS - 闪光灯亮度常量
  • LICENSE_STATE - 授权状态常量
  • SCAN_TRIGGER_MODE - 触发模式常量
  • SCAN_MODE - 扫码模式常量
  • BARCODE_TAG - 条码属性TAG常量

注意事项

  1. 本插件仅支持Android平台,需运行在安装了祥承扫码服务的设备上
  2. SDK版本需与扫码服务版本匹配,当前SDK版本 1.3.56.1.14 需配合扫码服务 1.3.56.1.14 及以上版本
  3. 页面切换到后台或销毁时务必调用 deInit() 释放资源
  4. 激活授权需要网络连接,激活流程约需1-2分钟

隐私、权限声明

1. 本插件需要申请的系统权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

MIT协议

暂无用户评论。