• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 输入设备开发指导
2
3## 场景介绍
4
5输入设备管理提供设备热插拔监听、查询指定设备的键盘类型等能力。使用场景例如:当用户需要输入文本时,输入法会根据当前是否插入了物理键盘来决定是否弹出虚拟键盘,开发者可以通过监听设备热插拔判断是否有物理键盘插入。
6
7## 导入模块
8
9```js
10import inputDevice from '@ohos.multimodalInput.inputDevice';
11```
12
13## 接口说明
14
15输入设备管理常用接口如下表所示,接口详细介绍请参考[ohos.multimodalInput.inputDevice文档](../reference/apis/js-apis-inputdevice.md)。
16
17| 实例名 | 接口名  | 说明 |
18| ----------- | ------------------------------------------------------------ | -------------------------- |
19| inputDevice | function getDeviceList(): Promise\<Array\<number>>; | 获取输入设备列表。 |
20| inputDevice | function getKeyboardType(deviceId: number): Promise\<KeyboardType>; | 获取输入设备的键盘类型。 |
21| inputDevice | function on(type: "change", listener: Callback\<DeviceListener>): void; | 监听输入设备的热插拔事件。 |
22| inputDevice | function off(type: "change", listener?: Callback\<DeviceListener>): void; | 取消监听输入设备的热插拔事件。 |
23
24## 虚拟键盘弹出检测
25
26当用户需要输入文本时,输入法会根据当前是否插入了物理键盘来决定是否弹出虚拟键盘,开发者可以通过监听设备热插拔,判断是否有物理键盘插入。
27
28## 开发步骤
29
301. 调用getDeviceList方法查询所有连接的输入设备,调用getKeyboardType方法遍历所有连接的设备,判断是否有物理键盘,若有则标记已有物理键盘连接,该步骤确保监听设备热插拔之前,检测所有插入的输入设备。
312. 调用on接口监听输入设备热插拔事件,若监听到有物理键盘插入,则标记已有物理键盘连接;若监听到有物理键盘拔掉,则标记没有物理键盘连接。
32
33
34```js
35import inputDevice from '@ohos.multimodalInput.inputDevice';
36
37let isPhysicalKeyboardExist = true;
38try {
39  // 1.获取设备列表,判断是否有物理键盘连接
40  inputDevice.getDeviceList().then(data => {
41    for (let i = 0; i < data.length; ++i) {
42      inputDevice.getKeyboardType(data[i]).then(type => {
43        if (type === inputDevice.KeyboardType.ALPHABETIC_KEYBOARD) {
44          // 物理键盘已连接
45          isPhysicalKeyboardExist = true;
46        }
47      });
48    }
49  });
50  // 2.监听设备热插拔
51  inputDevice.on("change", (data) => {
52    console.log(`Device event info: ${JSON.stringify(data)}`);
53    inputDevice.getKeyboardType(data.deviceId).then((type) => {
54      console.log("The keyboard type is: " + type);
55      if (type === inputDevice.KeyboardType.ALPHABETIC_KEYBOARD && data.type == 'add') {
56        // 物理键盘已插入
57        isPhysicalKeyboardExist = true;
58      } else if (type == inputDevice.KeyboardType.ALPHABETIC_KEYBOARD && data.type == 'remove') {
59        // 物理键盘已拔掉
60        isPhysicalKeyboardExist = false;
61      }
62    });
63  });
64} catch (error) {
65  console.log(`Execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
66}
67```
68