输入关键字搜索
开发者能力认证
鸿蒙高校创新赛
HarmonyOS 7
animation
HarmonyOS行业解决方案
layoutWeight
HarmonyOS模板&组件
bindPopup
bindsheet
CTRL+K
文档管理中心
全部文档版本说明工具设计指南与API参考开发与测试上架分发与运营问题处理与运维最佳实践行业解决方案
指南与API参考
指南
API
您当前正在浏览新版开发者文档中心，目录分类和层级有所调整。点击左侧当前文档分类名称前的“☰”图标，可切换文档分类。 了解新版目录
指南与API参考指南系统基础功能Input Kit（多模输入服务）输入设备开发指导

输入设备开发指导

更新时间: 2026-09-24 09:52
复制页面
本文导读

场景介绍

输入设备管理提供设备热插拔监听、查询指定设备的键盘类型等能力。使用场景例如：当用户需要输入文本时，输入法会根据当前是否插入了物理键盘来决定是否弹出虚拟键盘，开发者可以通过监听设备热插拔判断是否有物理键盘插入。

导入模块

收起
自动换行
深色代码主题
复制
  1. import { inputDevice } from '@kit.InputKit';

接口说明

输入设备管理常用接口如下表所示，接口详细介绍请参考@ohos.multimodalInput.inputDevice (输入设备)。

展开
接口名称 描述
getDeviceList(): Promise<Array<number>> 获取所有输入设备的ID列表。
getKeyboardType(deviceId: number): Promise<KeyboardType> 获取输入设备的键盘类型。
on(type: 'change', listener: Callback<DeviceListener>): void 注册监听输入设备的热插拔事件。
off(type: 'change', listener?: Callback<DeviceListener>): void 取消监听输入设备的热插拔事件。

虚拟键盘弹出检测

当用户需要输入文本时，输入法会根据当前是否插入了物理键盘来决定是否弹出虚拟键盘，开发者可以通过监听设备热插拔，判断是否有物理键盘插入。

开发步骤

  1. 调用getDeviceList方法查询所有连接的输入设备，并遍历所有连接的设备，对每个设备调用getKeyboardType方法，判断是否有物理键盘，若有则标记已有物理键盘连接，该步骤确保在监听设备热插拔之前，先检测所有已插入的输入设备。
  2. 调用on接口监听输入设备热插拔事件，若监听到有物理键盘插入，则标记已有物理键盘连接；若监听到有物理键盘拔出，则标记没有物理键盘连接。
收起
自动换行
深色代码主题
复制
  1. import { inputDevice } from '@kit.InputKit';
  2. import { hilog } from '@kit.PerformanceAnalysisKit';
  3. 

  4. const DOMAIN = 0x0000;
  5. 

  6. @Entry
  7. @Component
  8. struct Index {
  9.   @State isPhysicalKeyboardExist: boolean = false;
  10.   @State message: string = "Click to obtain the device list and monitor device hot-plug events";
  11.   keyboards: Map<number, inputDevice.KeyboardType> = new Map();
  12. 

  13.   // ...
  14. 

  15.   build() {
  16.     RelativeContainer() {
  17.       Column() {
  18.         // ...
  19. 

  20.         Text(this.message)
  21.           .onClick(() => {
  22.             try {
  23.               // 1.获取设备列表，判断是否有物理键盘连接
  24.               inputDevice.getDeviceList().then(data => {
  25.                 for (let i = 0; i < data.length; ++i) {
  26.                   inputDevice.getKeyboardType(data[i]).then(type => {
  27.                     if (type === inputDevice.KeyboardType.ALPHABETIC_KEYBOARD) {
  28.                       // 物理键盘已连接
  29.                       this.isPhysicalKeyboardExist = true;
  30.                       this.keyboards.set(data[i], type);
  31.                     }
  32.                   });
  33.                 }
  34.               });
  35.               // 2.监听设备热插拔
  36.               inputDevice.on("change", (data) => {
  37.                 hilog.info(DOMAIN, 'InputDevice', `Device event info: %{public}s`, JSON.stringify(data));
  38.                 inputDevice.getKeyboardType(data.deviceId).then((type) => {
  39.                   hilog.info(DOMAIN, 'InputDevice', 'The keyboard type is: %{public}d', type);
  40.                   if (type === inputDevice.KeyboardType.ALPHABETIC_KEYBOARD && data.type === 'add') {
  41.                     // 物理键盘已插入
  42.                     this.isPhysicalKeyboardExist = true;
  43.                     this.keyboards.set(data.deviceId, type);
  44.                   }
  45.                 });
  46.                 if (this.keyboards.get(data.deviceId) === inputDevice.KeyboardType.ALPHABETIC_KEYBOARD &&
  47.                   data.type === 'remove') {
  48.                   // 物理键盘已拔出
  49.                   this.isPhysicalKeyboardExist = false;
  50.                   this.keyboards.delete(data.deviceId);
  51.                 }
  52.               });
  53.               this.message = "Device monitoring enabled successfully"
  54.             } catch (error) {
  55.               hilog.error(DOMAIN, 'InputDevice', `Execute failed, error: %{public}s`,
  56.                 JSON.stringify(error, ["code", "message"]));
  57.               this.message = `Failed to enable device monitoring. Click to retry. Error message:${JSON.stringify(error,
  58.                 ["code", "message"])}`
  59.             }
  60.           })
  61.           // ...
  62.       }
  63.       // ...
  64.     }
  65.   }
  66. }
Index.ets
Input Kit简介
优先响应系统功能键开发指导
简体中文
华为开发者联盟 版权所有 ©2026
问题反馈
使用条款
华为开发者联盟用户协议
关于华为开发者联盟与隐私的声明
Cookies
开源软件声明