Scanner SDK
v20260828
The Scanner SDK targets Android PDA devices. ScanManager provides barcode scanning control, output mode switching, and scanner parameter configuration. Scan results can be delivered via broadcast (Intent) or keyboard wedge output.
This document matches the 2026-08-28 Scanner development guide. It covers core ScanManager APIs, common parameter examples, broadcast-based scan image capture, and broadcast-based scanner settings on Android 11 and above.
PropertyID (int / String)com.android.broadcast.uscanner.settings (Android 11+)| Item | Requirement |
|---|---|
| Platform | Android PDA |
| Language | Java |
| Core class | android.device.ScanManager |
| Parameter constants | android.device.scanner.configuration.PropertyID |
| Auto image return | Android 11+, OS version from 2024 onward |
| Broadcast parameter settings | Android 11+ |
The Scanner SDK is shipped as a JAR file: ScannerSDK-20250427.jar. It includes core classes such as android.device.ScanManager and android.device.scanner.configuration.PropertyID. Obtain the JAR from the SDK distribution package or refer to the included sample project: ScannerAPIsSamples.
Add the JAR to your Android project as follows (same approach as the ScannerDemo sample project):
ScannerSDK-20250427.jar into your project's app/libs/ directory.app/build.gradle under dependencies:dependencies {
// ...
implementation files('libs/ScannerSDK-20250427.jar')
}import android.device.ScanManager and call the APIs in code.Note: The JAR provides compile-time API declarations. Scanning capability is provided by the device system at runtime; verify on a physical device.
ScanManager instance in an Activity or Service.switchOutputMode(0) or set Settings → Scan Settings → Output Mode → Intent output on the device.BroadcastReceiver for the scan result Action (default android.intent.ACTION_DECODE_DATA; use ScanManager.ACTION_DECODE or read configured values at runtime).unregisterReceiver in onPause or when the screen is destroyed to avoid leaks.ScanManager mScanManager = new ScanManager();
mScanManager.switchOutputMode(0); // 0: broadcast; 1: keyboardDefault broadcast Action is android.intent.ACTION_DECODE_DATA; default data key is barcode_string. You may also use ScanManager.ACTION_DECODE and ScanManager.BARCODE_STRING_TAG.
Minimal broadcast-mode barcode capture:
ScanManager mScanManager = new ScanManager();
mScanManager.switchOutputMode(0);
IntentFilter filter = new IntentFilter();
filter.addAction(ScanManager.ACTION_DECODE);
registerReceiver(mReceiver, filter);private BroadcastReceiver mReceiver = new BroadcastReceiver() {
@Override
public void onReceive(Context context, Intent intent) {
String barcodeStr = intent.getStringExtra(ScanManager.BARCODE_STRING_TAG);
}
};Unregister when the screen is not visible:
unregisterReceiver(mReceiver);Trigger mode enumeration.
| Value | Meaning |
|---|---|
| PULSE | Short press triggers decode; stops on timeout |
| CONTINUOUS | Continuous scan mode |
| HOST | Press and hold to scan; release to stop |
Common broadcast constants on ScanManager.
| Value | Meaning |
|---|---|
| ACTION_DECODE | Scan result broadcast Action; defaults to android.intent.ACTION_DECODE_DATA |
| BARCODE_STRING_TAG | Intent extra key for barcode string; defaults to barcode_string |
Sets how decoded barcode data is delivered after a successful scan.
public boolean switchOutputMode(int mode)| Name | Type | Description |
|---|---|---|
| mode | int | 0: broadcast (Intent output); 1: keyboard mode; 2: broadcast + keyboard mode |
boolean — true on success; false on failure.
mScanManager.switchOutputMode(0);Returns the current scan result output mode.
public int getOutputMode()| Value | Meaning |
|---|---|
| 0 | Broadcast (Intent output) |
| 1 | Keyboard mode |
| 2 | Broadcast + keyboard mode |
mScanManager.getOutputMode();Starts decoding programmatically; equivalent to pressing the physical scan key. Skip this call if you only use hardware keys.
public boolean startDecode()boolean — true on success; false on failure.
mScanManager.startDecode();Stops an active decode session programmatically.
public boolean stopDecode()boolean — true on success; false on failure.
mScanManager.stopDecode();Sets the trigger scan mode.
public void setTriggerMode(Triggering tgMode)| Name | Type | Description |
|---|---|---|
| tgMode | Triggering | PULSE, CONTINUOUS, or HOST; see Triggering enum |
mScanManager.setTriggerMode(Triggering.PULSE);Returns the current trigger scan mode.
public Triggering getTriggerMode()Triggering — PULSE, CONTINUOUS, or HOST.
mScanManager.getTriggerMode();Disables scan triggering (hardware key and programmatic scan methods).
public boolean lockTriggler()boolean — true on success; false on failure.
mScanManager.lockTriggler();Re-enables scan triggering (hardware scan key).
public boolean unlockTriggler()boolean — true on success; false on failure.
mScanManager.unlockTriggler();Opens the scan engine. Devices are usually already enabled; this call is optional.
public boolean openScanner()boolean — true on success; false on failure.
mScanManager.openScanner();Closes the scan engine. Scanning is unavailable while closed.
public boolean closeScanner()boolean — true on success; false on failure.
mScanManager.closeScanner();Sets scanner parameters with String values.
public boolean setParameterString(int[] index, String[] value)| Name | Type | Description |
|---|---|---|
| index | int[] | Parameter key array (PropertyID) |
| value | String[] | Value array with the same length as index |
boolean — true on success; false on failure.
mScanManager.setParameterString(
new int[]{PropertyID.WEDGE_INTENT_ACTION_NAME, PropertyID.WEDGE_INTENT_DATA_STRING_TAG},
new String[]{"com.pkuhit.intent.action.SCANRECVR", "yourKeyString"}
);See ScannerAPIsSamples for more PropertyID values.
Reads scanner parameters as String values.
public String[] getParameterString(int[] index)| Name | Type | Description |
|---|---|---|
| index | int[] | Parameter key array |
String[] — Result indices match the input index array.
int[] keys = new int[]{
PropertyID.WEDGE_INTENT_ACTION_NAME,
PropertyID.WEDGE_INTENT_DATA_STRING_TAG
};
String[] ret = mScanManager.getParameterString(keys);Sets scanner parameters with int values.
public boolean setPropertyInts(int[] index, int[] value)| Name | Type | Description |
|---|---|---|
| index | int[] | Parameter key array |
| value | int[] | Value array with the same length as index |
boolean — true on success; false on failure.
mScanManager.setPropertyInts(
new int[]{PropertyID.SEND_GOOD_READ_BEEP_ENABLE, PropertyID.SEND_GOOD_READ_VIBRATE_ENABLE},
new int[]{2, 1}
);See ScannerAPIsSamples for more PropertyID values.
Reads scanner parameters as int values.
public int[] getPropertyInts(int[] index)| Name | Type | Description |
|---|---|---|
| index | int[] | Parameter key array |
int[] — Result indices match the input index array.
int[] keys = new int[]{
PropertyID.SEND_GOOD_READ_BEEP_ENABLE,
PropertyID.SEND_GOOD_READ_VIBRATE_ENABLE
};
int[] ret = mScanManager.getPropertyInts(keys);Resets scanner-related settings to factory defaults.
public boolean resetScannerParameters()boolean — true on success; false on failure.
mScanManager.resetScannerParameters();For Android 11+ devices with OS builds from 2024 onward. Send the configuration broadcast once at startup; subsequent scans return image data automatically.
Send configuration:
private static String BROADCAST_IMAGE_ACTION = "com.ubx.scanner_capture_image_result";
Intent intentImage = new Intent();
intentImage.setAction("com.ubx.barcode.broadcast_image");
intentImage.putExtra("imageAction", BROADCAST_IMAGE_ACTION);
// Broadcast image and barcode data immediately after a successful decode
intentImage.putExtra("enableSendImage", true);
// Send failed-decode images by default (not supported on all scan engines; contact technical support)
intentImage.putExtra("enableSendFailedImage", true);
// Image output form: 0 bitmap byte array; 1 saved file path
intentImage.putExtra("outputImageMode", 0);
// JPEG quality percentage: 1-100; system default is 50 (50%)
intentImage.putExtra("jpegQuality", 100);
// Return bounding coordinates
intentImage.putExtra("outputBounds", true);
// Saved image format: 0 png; 1 jpg; 2 bmp
intentImage.putExtra("imageFormat", 0);
// Image save directory path
intentImage.putExtra("saveImageDirPath", "/storage/emulated/0/imageSave/");
sendBroadcast(intentImage);Register and receive:
IntentFilter filter = new IntentFilter();
filter.addAction(BROADCAST_IMAGE_ACTION);
registerReceiver(mGetBitmapReceiver, filter);BroadcastReceiver mGetBitmapReceiver = new BroadcastReceiver() {
@Override
public void onReceive(Context context, Intent intent) {
if (BROADCAST_IMAGE_ACTION.equals(intent.getAction())) {
String barcode = intent.getStringExtra("barcode");
int[] bounds = intent.getIntArrayExtra("bounds");
String imageName = intent.getStringExtra("imageName");
byte[] bmp = intent.getByteArrayExtra("bitmapBytes");
if (bmp != null && bmp.length > 0) {
Bitmap mBitmap = BitmapFactory.decodeByteArray(bmp, 0, bmp.length)
.copy(Bitmap.Config.RGB_565, true);
}
}
}
};Unregister when no longer needed:
unregisterReceiver(mGetBitmapReceiver);Broadcast Action: com.android.broadcast.uscanner.settings
Intent intent = new Intent("com.android.broadcast.uscanner.settings");| Extra | Value |
|---|---|
keyInt | -10 |
valueInt | 0 off; 1 on |
intent.putExtra("keyInt", -10);
intent.putExtra("valueInt", 1);
sendBroadcast(intent);| Extra | Value |
|---|---|
keyInt | -11 |
valueInt | 0 stop; 1 start |
intent.putExtra("keyInt", -11);
intent.putExtra("valueInt", 1);
sendBroadcast(intent);| Extra | Value |
|---|---|
keyInt | -12 |
valueInt | 0 broadcast; 1 keyboard; 2 both |
intent.putExtra("keyInt", -12);
intent.putExtra("valueInt", 0);
sendBroadcast(intent);| Extra | Value |
|---|---|
keyInt | -13 |
valueInt | 0 auto; 1 continuous; 2 manual |
intent.putExtra("keyInt", -13);
intent.putExtra("valueInt", 0);
sendBroadcast(intent);| Extra | Value |
|---|---|
keyInt | -14 |
valueInt | 0 lock; 1 unlock |
intent.putExtra("keyInt", -14);
intent.putExtra("valueInt", 1);
sendBroadcast(intent);| Extra | Value |
|---|---|
keyInt | 200000 (PropertyID.WEDGE_INTENT_ACTION_NAME) |
valueStr | default android.intent.ACTION_DECODE_DATA |
intent.putExtra("keyInt", 200000);
intent.putExtra("valueStr", "android.intent.ACTION_DECODE_DATA");
sendBroadcast(intent);| Extra | Value |
|---|---|
keyInt | 200002 (PropertyID.WEDGE_INTENT_DATA_STRING_TAG) |
valueStr | default barcode_string |
intent.putExtra("keyInt", 200002);
intent.putExtra("valueStr", "barcode_string");
sendBroadcast(intent);| Extra | Value |
|---|---|
keyInt | 6 (PropertyID.SEND_GOOD_READ_BEEP_ENABLE) |
valueInt | 0 none; 1 short; 2 sharp |
intent.putExtra("keyInt", 6);
intent.putExtra("valueInt", 1);
sendBroadcast(intent);| Extra | Value |
|---|---|
keyInt | 7 (PropertyID.SEND_GOOD_READ_VIBRATE_ENABLE) |
valueInt | 0 off; 1 on |
intent.putExtra("keyInt", 7);
intent.putExtra("valueInt", 1);
sendBroadcast(intent);See ScannerAPIsSamples for more PropertyID values.
In broadcast mode, property IDs use the SEND prefix:
ScanManager mScanManager = new ScanManager();
mScanManager.setPropertyInts(new int[]{PropertyID.SEND_GOOD_READ_BEEP_ENABLE}, new int[]{0});
mScanManager.setPropertyInts(new int[]{PropertyID.SEND_GOOD_READ_VIBRATE_ENABLE}, new int[]{0});
new ScanManager().setParameterString(
new int[]{PropertyID.WEDGE_INTENT_ACTION_NAME, PropertyID.WEDGE_INTENT_DATA_STRING_TAG},
new String[]{"yourAction", "yourKeyString"}
);ScanManager mScanManager = new ScanManager();
mScanManager.setPropertyInts(new int[]{PropertyID.GOOD_READ_BEEP_ENABLE}, new int[]{0});
mScanManager.setPropertyInts(new int[]{PropertyID.GOOD_READ_VIBRATE_ENABLE}, new int[]{0});Output mode must be keyboard mode:
new ScanManager().setPropertyInts(new int[]{PropertyID.WEDGE_KEYBOARD_TYPE}, new int[]{1});
// 0 physical; 1 IME; 2 physical only; 3 IME onlynew ScanManager().setPropertyInts(new int[]{PropertyID.LABEL_APPEND_ENTER}, new int[]{1});
// 0 None; 1 CR; 2 IME action done; 3 TABnew ScanManager().switchOutputMode(0);
new ScanManager().switchOutputMode(1);int[] keyInt = new int[]{PropertyID.LABEL_SEPARATOR_ENABLE};
int[] valueInt = new int[]{1};
new ScanManager().setPropertyInts(keyInt, valueInt);new ScanManager().setPropertyInts(new int[]{PropertyID.SEND_LABEL_PREFIX_SUFFIX}, new int[]{1});new ScanManager().setParameterString(
new int[]{PropertyID.LABEL_MATCHER_TARGETREGEX, PropertyID.LABEL_MATCHER_REPLACEMENT},
new String[]{"oldStr", "newStr"}
);int[] multiConfigbuf = new int[]{
PropertyID.MULTI_DECODE_MODE,
PropertyID.FULL_READ_MODE,
PropertyID.BAR_CODES_TO_READ
};
int[] multiConfigval = new int[]{1, 1, 4};
new ScanManager().setPropertyInts(multiConfigbuf, multiConfigval);
String moreBarcodeStr = intent.getStringExtra("com.ubx.datawedge.data_string");new ScanManager().setPropertyInts(new int[]{PropertyID.DEC_Multiple_Decode_MODE}, new int[]{0});ScanManager mScanManager = new ScanManager();
mScanManager.setPropertyInts(new int[]{PropertyID.TIMEOUT_BETWEEN_SAME_SYMBOL}, new int[]{1});
mScanManager.setPropertyInts(new int[]{PropertyID.DEC_Multiple_Decode_INTERVAL}, new int[]{50});
mScanManager.setPropertyInts(new int[]{PropertyID.DEC_Multiple_Decode_TIMEOUT}, new int[]{5000});ScanManager mScanManager = new ScanManager();
mScanManager.enableSymbology(Symbology.AZTEC, false);
mScanManager.enableAllSymbologies(true);mScanManager.setPropertyInts(new int[]{PropertyID.DEC_PICKLIST_AIM_MODE}, new int[]{1});
new ScanManager().setPropertyInts(
new int[]{PropertyID.LINEAR_CODE_TYPE_SECURITY_LEVEL}, new int[]{1}
);int[] codeChecksumKey = new int[]{
PropertyID.EAN13_ENABLE, PropertyID.UPCA_ENABLE, PropertyID.UPCE_ENABLE, PropertyID.UPCE1_ENABLE,
PropertyID.EAN13_SEND_CHECK, PropertyID.UPCA_SEND_CHECK, PropertyID.UPCE_SEND_CHECK, PropertyID.UPCE1_SEND_CHECK
};
int[] codeChecksumvalue = new int[]{1, 1, 1, 1, 0, 0, 0, 0};
new ScanManager().setPropertyInts(codeChecksumKey, codeChecksumvalue);ScanManager mScanManager = new ScanManager();
mScanManager.setPropertyInts(
new int[]{PropertyID.LOW_CONTRAST_IMPROVED, PropertyID.LOW_CONTRAST_IMPROVED_ALGORITHM},
new int[]{2, 0}
);
new ScanManager().setPropertyInts(new int[]{PropertyID.DEC_2D_LIGHTS_MODE}, new int[]{1});mScanManager.setPropertyInts(
new int[]{PropertyID.DEC_2D_CENTERING_ENABLE, PropertyID.DEC_2D_CENTERING_MODE},
new int[]{1, 2}
);
mScanManager.setPropertyInts(new int[]{PropertyID.CODING_FORMAT}, new int[]{1});mScanManager.setPropertyInts(
new int[]{PropertyID.DEC_OCR_MODE, PropertyID.DEC_OCR_TEMPLATE}, new int[]{3, 0}
);
mScanManager.setPropertyInts(
new int[]{PropertyID.IMAGE_EXPOSURE_MODE, PropertyID.DEC_ES_MAX_EXP, PropertyID.DEC_ES_MAX_GAIN, PropertyID.DEC_ES_TARGET_VALUE},
new int[]{1, 500, 4, 4000}
);For more details, see the ScannerAPIsSamples official sample repository.
switchOutputMode(0) or Intent output in system settings before results can be received by broadcast.PropertyID list.setParameterInts while the API section documents setPropertyInts; use the method name exposed on your device SDK.Q: What are the default broadcast Action and data key?
A: Default Action is android.intent.ACTION_DECODE_DATA; default key is barcode_string. You may also use ScanManager.ACTION_DECODE and ScanManager.BARCODE_STRING_TAG, or read current values with getParameterString.
Q: Can I use broadcast mode without calling the API?
A: Yes. Set Settings → Scan Settings → Output Mode → Intent output on the PDA, then register a BroadcastReceiver for the configured Action and key.
Q: How do I unlock scanning after lock?
A: Call unlockTriggler(), or send broadcast with keyInt = -14 and valueInt = 1.
Scanner SDK 面向 Android PDA 设备，通过 ScanManager 提供条码扫描控制、输出模式切换、扫描参数配置等能力。扫描结果可通过广播（Intent）或键盘方式输出。
本文档对应 2026-08-28 版 Scanner 开发文档，涵盖 ScanManager 核心接口、常用参数示例、扫描头图片广播获取，以及 Android 11 及以上通过广播设置扫描参数的方式。
PropertyID 配置扫描参数（int / String）com.android.broadcast.uscanner.settings 设置扫描参数（Android 11+）| 项 | 要求 |
|---|---|
| 平台 | Android PDA |
| 语言 | Java |
| 核心类 | android.device.ScanManager |
| 参数常量 | android.device.scanner.configuration.PropertyID |
| 图片自动返回 | Android 11 及以上，OS 版本为 2024 年及之后 |
| 广播设置参数 | Android 11 及以上 |
Scanner SDK 以 JAR 形式提供，文件名为 ScannerSDK-20250427.jar，包含 android.device.ScanManager、android.device.scanner.configuration.PropertyID 等核心类。请从 SDK 发布包获取该 JAR，或参考附带的示例工程：ScannerAPIsSamples。
按以下步骤将 JAR 引入 Android 工程（与 ScannerDemo 示例工程一致）：
ScannerSDK-20250427.jar 复制到工程 app/libs/ 目录下。app/build.gradle 的 dependencies 节点中添加本地 JAR 依赖：dependencies {
// ...
implementation files('libs/ScannerSDK-20250427.jar')
}import android.device.ScanManager 并使用相关 API。说明：该 JAR 提供编译期 API 声明；实际扫描能力由设备系统提供，需在真机上运行验证。
ScanManager 实例。switchOutputMode(0)），或在设备 设置 → 扫描设置 → 输出方式 中选择 Intent 输出。BroadcastReceiver 监听扫描结果 Action（默认 android.intent.ACTION_DECODE_DATA，可通过 ScanManager.ACTION_DECODE 或参数配置获取）。onPause / 页面销毁时 unregisterReceiver，避免泄漏。ScanManager mScanManager = new ScanManager();
mScanManager.switchOutputMode(0); // 0：广播模式；1：键盘模式广播模式默认 Action 为 android.intent.ACTION_DECODE_DATA，默认数据 Key 为 barcode_string。也可使用 ScanManager.ACTION_DECODE 与 ScanManager.BARCODE_STRING_TAG。
以下示例展示广播模式下获取条码的最短路径：
ScanManager mScanManager = new ScanManager();
mScanManager.switchOutputMode(0);
IntentFilter filter = new IntentFilter();
filter.addAction(ScanManager.ACTION_DECODE);
registerReceiver(mReceiver, filter);private BroadcastReceiver mReceiver = new BroadcastReceiver() {
@Override
public void onReceive(Context context, Intent intent) {
String barcodeStr = intent.getStringExtra(ScanManager.BARCODE_STRING_TAG);
}
};页面不可见时取消注册：
unregisterReceiver(mReceiver);触发扫描模式枚举。
| Value | Meaning |
|---|---|
| PULSE | 短按触发解码或超时停止 |
| CONTINUOUS | 连扫模式 |
| HOST | 长按触发，松开停止 |
ScanManager 常用广播常量。
| Value | Meaning |
|---|---|
| ACTION_DECODE | 扫描结果广播 Action；默认等同于 android.intent.ACTION_DECODE_DATA |
| BARCODE_STRING_TAG | 广播 Intent 中条码字符串 Extra Key；默认 barcode_string |
设置 PDA 扫描到条码后的结果输出方式。
public boolean switchOutputMode(int mode)| 参数 | 类型 | 说明 |
|---|---|---|
| mode | int | 0：广播模式（Intent 输出）；1：键盘模式；2：广播模式 + 键盘模式 |
boolean — true 设置成功；false 设置失败。
mScanManager.switchOutputMode(0);获取 PDA 当前使用的扫码结果输出方式。
public int getOutputMode()| 值 | 说明 |
|---|---|
| 0 | 广播模式（Intent 输出） |
| 1 | 键盘模式 |
| 2 | 广播模式 + 键盘模式 |
mScanManager.getOutputMode();代码调起扫描头扫码；与物理扫描键效果相同。若仅使用按键触发，可不调用本方法。
public boolean startDecode()boolean — true 设置成功；false 设置失败。
mScanManager.startDecode();代码控制停止扫描。
public boolean stopDecode()boolean — true 设置成功；false 设置失败。
mScanManager.stopDecode();设置触发扫描模式。
public void setTriggerMode(Triggering tgMode)| 参数 | 类型 | 说明 |
|---|---|---|
| tgMode | Triggering | PULSE / CONTINUOUS / HOST，见 Triggering 枚举 |
mScanManager.setTriggerMode(Triggering.PULSE);获取当前触发扫描模式。
public Triggering getTriggerMode()Triggering — PULSE 短按触发或超时停止；CONTINUOUS 连扫；HOST 长按触发、松开停止。
mScanManager.getTriggerMode();禁用扫描触发（扫描按钮与扫描方法均不可用）。
public boolean lockTriggler()boolean — true 设置成功；false 设置失败。
mScanManager.lockTriggler();启用扫描触发（恢复扫描按钮）。
public boolean unlockTriggler()boolean — true 设置成功；false 设置失败。
mScanManager.unlockTriggler();打开扫描引擎。设备通常默认已开启，可不调用。
public boolean openScanner()boolean — true 设置成功；false 设置失败。
mScanManager.openScanner();关闭扫描引擎；关闭后无法扫描。
public boolean closeScanner()boolean — true 设置成功；false 设置失败。
mScanManager.closeScanner();设置扫描参数（String 类型）。
public boolean setParameterString(int[] index, String[] value)| 参数 | 类型 | 说明 |
|---|---|---|
| index | int[] | 参数 key 数组，对应 PropertyID |
| value | String[] | 与 index 等长的参数值数组 |
boolean — true 设置成功；false 设置失败。
mScanManager.setParameterString(
new int[]{PropertyID.WEDGE_INTENT_ACTION_NAME, PropertyID.WEDGE_INTENT_DATA_STRING_TAG},
new String[]{"com.pkuhit.intent.action.SCANRECVR", "你接收的KeyString"}
);更多 PropertyID 说明见 ScannerAPIsSamples。
获取扫描参数（String 类型）。
public String[] getParameterString(int[] index)| 参数 | 类型 | 说明 |
|---|---|---|
| index | int[] | 参数 key 数组 |
String[] — 返回数组下标与传入 index 下标一一对应。
int[] keys = new int[]{
PropertyID.WEDGE_INTENT_ACTION_NAME,
PropertyID.WEDGE_INTENT_DATA_STRING_TAG
};
String[] ret = mScanManager.getParameterString(keys);设置扫描参数（int 类型）。
public boolean setPropertyInts(int[] index, int[] value)| 参数 | 类型 | 说明 |
|---|---|---|
| index | int[] | 参数 key 数组 |
| value | int[] | 与 index 等长的参数值数组 |
boolean — true 设置成功；false 设置失败。
mScanManager.setPropertyInts(
new int[]{PropertyID.SEND_GOOD_READ_BEEP_ENABLE, PropertyID.SEND_GOOD_READ_VIBRATE_ENABLE},
new int[]{2, 1}
);更多 PropertyID 说明见 ScannerAPIsSamples。
获取扫描参数（int 类型）。
public int[] getPropertyInts(int[] index)| 参数 | 类型 | 说明 |
|---|---|---|
| index | int[] | 参数 key 数组 |
int[] — 返回数组下标与传入 index 下标一一对应。
int[] keys = new int[]{
PropertyID.SEND_GOOD_READ_BEEP_ENABLE,
PropertyID.SEND_GOOD_READ_VIBRATE_ENABLE
};
int[] ret = mScanManager.getPropertyInts(keys);将扫描头相关设置重置为出厂默认值。
public boolean resetScannerParameters()boolean — true 设置成功；false 设置失败。
mScanManager.resetScannerParameters();适用于 Android 11 及以上、OS 版本为 2024 年及之后的设备。程序启动后发送一次配置广播，后续扫码会自动返回图片数据。
发送配置广播：
private static String BROADCAST_IMAGE_ACTION = "com.ubx.scanner_capture_image_result";
Intent intentImage = new Intent();
intentImage.setAction("com.ubx.barcode.broadcast_image");
intentImage.putExtra("imageAction", BROADCAST_IMAGE_ACTION);
// 是否解到条码后就直接广播出图片数据和条码数据
intentImage.putExtra("enableSendImage", true);
// 是否默认发送解码失败图片（某些扫码头不支持，具体可咨询技术支持）
intentImage.putExtra("enableSendFailedImage", true);
// 该广播输出图片数据形式 0 bitmap 数组 1 保存图片输出路径
intentImage.putExtra("outputImageMode", 0);
// 设置返回图片的质量百分比：1-100，系统默认 50(50%)
intentImage.putExtra("jpegQuality", 100);
// 是否返回坐标位置
intentImage.putExtra("outputBounds", true);
// 保存图片后缀类型 0 png 1 jpg 2 bmp
intentImage.putExtra("imageFormat", 0);
// 设置图片保存路径
intentImage.putExtra("saveImageDirPath", "/storage/emulated/0/imageSave/");
sendBroadcast(intentImage);注册并接收：
IntentFilter filter = new IntentFilter();
filter.addAction(BROADCAST_IMAGE_ACTION);
registerReceiver(mGetBitmapReceiver, filter);BroadcastReceiver mGetBitmapReceiver = new BroadcastReceiver() {
@Override
public void onReceive(Context context, Intent intent) {
if (BROADCAST_IMAGE_ACTION.equals(intent.getAction())) {
String barcode = intent.getStringExtra("barcode");
int[] bounds = intent.getIntArrayExtra("bounds");
String imageName = intent.getStringExtra("imageName");
byte[] bmp = intent.getByteArrayExtra("bitmapBytes");
if (bmp != null && bmp.length > 0) {
Bitmap mBitmap = BitmapFactory.decodeByteArray(bmp, 0, bmp.length)
.copy(Bitmap.Config.RGB_565, true);
}
}
}
};不再接收图片时取消注册：
unregisterReceiver(mGetBitmapReceiver);广播 Action：com.android.broadcast.uscanner.settings
Intent intent = new Intent("com.android.broadcast.uscanner.settings");| Extra | 取值 |
|---|---|
keyInt | -10 |
valueInt | 0 关闭；1 开启 |
intent.putExtra("keyInt", -10);
intent.putExtra("valueInt", 1);
sendBroadcast(intent);| Extra | 取值 |
|---|---|
keyInt | -11 |
valueInt | 0 关闭解码；1 开始解码 |
intent.putExtra("keyInt", -11);
intent.putExtra("valueInt", 1);
sendBroadcast(intent);| Extra | 取值 |
|---|---|
keyInt | -12 |
valueInt | 0 广播；1 键盘；2 广播+键盘 |
intent.putExtra("keyInt", -12);
intent.putExtra("valueInt", 0);
sendBroadcast(intent);| Extra | 取值 |
|---|---|
keyInt | -13 |
valueInt | 0 自动（按下开始，超时停止）；1 连扫；2 手动（按下开始，松开或超时停止） |
intent.putExtra("keyInt", -13);
intent.putExtra("valueInt", 0);
sendBroadcast(intent);| Extra | 取值 |
|---|---|
keyInt | -14 |
valueInt | 0 锁定（无法扫描）；1 解锁 |
intent.putExtra("keyInt", -14);
intent.putExtra("valueInt", 1);
sendBroadcast(intent);| Extra | 取值 |
|---|---|
keyInt | 200000（PropertyID.WEDGE_INTENT_ACTION_NAME） |
valueStr | 默认 android.intent.ACTION_DECODE_DATA |
intent.putExtra("keyInt", 200000);
intent.putExtra("valueStr", "android.intent.ACTION_DECODE_DATA");
sendBroadcast(intent);| Extra | 取值 |
|---|---|
keyInt | 200002（PropertyID.WEDGE_INTENT_DATA_STRING_TAG） |
valueStr | 默认 barcode_string |
intent.putExtra("keyInt", 200002);
intent.putExtra("valueStr", "barcode_string");
sendBroadcast(intent);| Extra | 取值 |
|---|---|
keyInt | 6（PropertyID.SEND_GOOD_READ_BEEP_ENABLE） |
valueInt | 0 无；1 短促；2 尖锐 |
intent.putExtra("keyInt", 6);
intent.putExtra("valueInt", 1);
sendBroadcast(intent);| Extra | 取值 |
|---|---|
keyInt | 7（PropertyID.SEND_GOOD_READ_VIBRATE_ENABLE） |
valueInt | 0 关闭；1 开启 |
intent.putExtra("keyInt", 7);
intent.putExtra("valueInt", 1);
sendBroadcast(intent);更多 PropertyID 说明见 ScannerAPIsSamples。
广播模式下，属性标识带 SEND 前缀：
ScanManager mScanManager = new ScanManager();
mScanManager.setPropertyInts(new int[]{PropertyID.SEND_GOOD_READ_BEEP_ENABLE}, new int[]{0});
// 声音：0 关闭；1 短促；2 尖锐
mScanManager.setPropertyInts(new int[]{PropertyID.SEND_GOOD_READ_VIBRATE_ENABLE}, new int[]{0});
// 震动：0 关闭；1 开启
new ScanManager().setParameterString(
new int[]{PropertyID.WEDGE_INTENT_ACTION_NAME, PropertyID.WEDGE_INTENT_DATA_STRING_TAG},
new String[]{"你的Action", "你接收的KeyString"}
);键盘模式下使用不带 SEND 前缀的属性：
ScanManager mScanManager = new ScanManager();
mScanManager.setPropertyInts(new int[]{PropertyID.GOOD_READ_BEEP_ENABLE}, new int[]{0});
mScanManager.setPropertyInts(new int[]{PropertyID.GOOD_READ_VIBRATE_ENABLE}, new int[]{0});输出模式须为键盘模式：
new ScanManager().setPropertyInts(new int[]{PropertyID.WEDGE_KEYBOARD_TYPE}, new int[]{1});
// 0：物理键盘；1：输入法软件；2：仅用物理键盘；3：仅用输入法new ScanManager().setPropertyInts(new int[]{PropertyID.LABEL_APPEND_ENTER}, new int[]{1});
// 0: None；1: Carriage return；2: IME action done；3: TABnew ScanManager().switchOutputMode(0); // 广播模式
new ScanManager().switchOutputMode(1); // 键盘模式int[] keyInt = new int[]{PropertyID.LABEL_SEPARATOR_ENABLE};
int[] valueInt = new int[]{1}; // 0 关闭；1 开启
new ScanManager().setPropertyInts(keyInt, valueInt);new ScanManager().setPropertyInts(new int[]{PropertyID.SEND_LABEL_PREFIX_SUFFIX}, new int[]{1});new ScanManager().setParameterString(
new int[]{PropertyID.LABEL_MATCHER_TARGETREGEX, PropertyID.LABEL_MATCHER_REPLACEMENT},
new String[]{"oldStr", "newStr"}
);int[] multiConfigbuf = new int[]{
PropertyID.MULTI_DECODE_MODE,
PropertyID.FULL_READ_MODE,
PropertyID.BAR_CODES_TO_READ
};
int[] multiConfigval = new int[3];
multiConfigval[0] = 1; // 0 关闭；1 开启多条码
multiConfigval[1] = 1; // 达到设定数量后才回调
multiConfigval[2] = 4; // 解码个数 1–10
new ScanManager().setPropertyInts(multiConfigbuf, multiConfigval);
// 广播获取多条码（输出模式须为广播）
String moreBarcodeStr = intent.getStringExtra("com.ubx.datawedge.data_string");new ScanManager().setPropertyInts(
new int[]{PropertyID.DEC_Multiple_Decode_MODE}, new int[]{0}
);
// 0 可重复解码；1 连续不重复；2 缓存内不重复ScanManager mScanManager = new ScanManager();
mScanManager.setPropertyInts(new int[]{PropertyID.TIMEOUT_BETWEEN_SAME_SYMBOL}, new int[]{1});
// value * 100 ms，范围 1–99
mScanManager.setPropertyInts(new int[]{PropertyID.DEC_Multiple_Decode_INTERVAL}, new int[]{50});
// 扫描间隔，默认 50ms（0–5000ms）
mScanManager.setPropertyInts(new int[]{PropertyID.DEC_Multiple_Decode_TIMEOUT}, new int[]{5000});
// 扫描超时，默认 5000ms（50–60000ms）ScanManager mScanManager = new ScanManager();
mScanManager.enableSymbology(Symbology.AZTEC, false);
mScanManager.enableAllSymbologies(true);mScanManager.setPropertyInts(new int[]{PropertyID.DEC_PICKLIST_AIM_MODE}, new int[]{1});
int[] codeleveindex = new int[]{PropertyID.LINEAR_CODE_TYPE_SECURITY_LEVEL};
int[] codelevevalue = new int[]{1}; // 级别 0–3
new ScanManager().setPropertyInts(codeleveindex, codelevevalue);int[] codeChecksumKey = new int[]{
PropertyID.EAN13_ENABLE, PropertyID.UPCA_ENABLE, PropertyID.UPCE_ENABLE, PropertyID.UPCE1_ENABLE,
PropertyID.EAN13_SEND_CHECK, PropertyID.UPCA_SEND_CHECK, PropertyID.UPCE_SEND_CHECK, PropertyID.UPCE1_SEND_CHECK
};
int[] codeChecksumvalue = new int[]{1, 1, 1, 1, 0, 0, 0, 0};
new ScanManager().setPropertyInts(codeChecksumKey, codeChecksumvalue);ScanManager mScanManager = new ScanManager();
mScanManager.setPropertyInts(
new int[]{PropertyID.LOW_CONTRAST_IMPROVED, PropertyID.LOW_CONTRAST_IMPROVED_ALGORITHM},
new int[]{2, 0}
);
new ScanManager().setPropertyInts(new int[]{PropertyID.DEC_2D_LIGHTS_MODE}, new int[]{1});
// 1 仅瞄准灯；2 仅照明灯；3 交替；4 同时mScanManager.setPropertyInts(
new int[]{PropertyID.DEC_2D_CENTERING_ENABLE, PropertyID.DEC_2D_CENTERING_MODE},
new int[]{1, 2}
);
int[] key = new int[]{PropertyID.CODING_FORMAT};
int[] value = new int[]{1}; // 0 UTF-8；1 GBK
mScanManager.setPropertyInts(key, value);int[] key = new int[]{PropertyID.DEC_OCR_MODE, PropertyID.DEC_OCR_TEMPLATE};
int[] value = new int[]{3, 0};
mScanManager.setPropertyInts(key, value);
int[] expKey = new int[]{
PropertyID.IMAGE_EXPOSURE_MODE, PropertyID.DEC_ES_MAX_EXP,
PropertyID.DEC_ES_MAX_GAIN, PropertyID.DEC_ES_TARGET_VALUE
};
int[] expValue = new int[]{1, 500, 4, 4000};
mScanManager.setPropertyInts(expKey, expValue);更多详情，请查看 ScannerAPIsSamples 官方示例仓库。
switchOutputMode(0) 或在系统设置中选择 Intent 输出，否则无法通过广播接收条码。PropertyID 常量较多，完整列表参考 ScannerAPIsSamples 或联系技术支持。setParameterInts 与 API 章节 setPropertyInts 命名不一致；请以设备实际 SDK 方法为准。Q: 默认广播 Action 和数据 Key 是什么？
A: 默认 Action 为 android.intent.ACTION_DECODE_DATA，默认 Key 为 barcode_string。也可使用 ScanManager.ACTION_DECODE 与 ScanManager.BARCODE_STRING_TAG，或通过 getParameterString 实时读取当前配置。
Q: 如何在不调用 API 的情况下使用广播模式？
A: 在 PDA 设置 → 扫描设置 → 输出方式 中选择 Intent 输出，然后按 Action / Key 注册 BroadcastReceiver。
Q: 锁定扫描后如何恢复？
A: 调用 unlockTriggler()，或通过广播 keyInt = -14、valueInt = 1 解锁。