輸入設備

輸入設備管理模塊，用于監聽輸入設備連接、斷開和變化，并查看輸入設備相關信息。比如監聽鼠標插拔，并獲取鼠標的id、name和指針移動速度等信息。

說明 ： 開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模塊首批接口從API version 8開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。

導入模塊

import inputDevice from '@ohos.multimodalInput.inputDevice';

inputDevice.on9+

on(type: “change”, listener: Callback): void

監聽輸入設備的熱插拔事件。

系統能力 ：SystemCapability.MultimodalInput.Input.InputDevice

參數 ：

示例 ：

let isPhysicalKeyboardExist = true;
inputDevice.on("change", (data) = > {
    console.log("type: " + data.type + ", deviceId: " + data.deviceId);
    inputDevice.getKeyboardType(data.deviceId, (err, ret) = > {
        console.log("The keyboard type of the device is: " + ret);
        if (ret == inputDevice.KeyboardType.ALPHABETIC_KEYBOARD && data.type == 'add') {
            // 監聽物理鍵盤已連接。
            isPhysicalKeyboardExist = true;
        } else if (ret == inputDevice.KeyboardType.ALPHABETIC_KEYBOARD && data.type == 'remove') {
            // 監聽物理鍵盤已斷開。
            isPhysicalKeyboardExist = false;
        }
    });
});
// 根據isPhysicalKeyboardExist的值決定軟鍵盤是否彈出。

inputDevice.off9+

off(type: “change”, listener?: Callback): void

取消監聽輸入設備的熱插拔事件。

系統能力 ：SystemCapability.MultimodalInput.Input.InputDevice

參數 ：

示例 ：

function listener(data) {
    console.log("type: " + data.type + ", deviceId: " + data.deviceId);
}

// 單獨取消listener的監聽。
inputDevice.off("change", listener);

// 取消所有監聽。
inputDevice.off("change");
// 取消監聽后，軟鍵盤默認都彈出。

inputDevice.getDeviceIds

getDeviceIds(callback: AsyncCallback>): void

獲取所有輸入設備的id列表，使用callback方式作為異步方法。

系統能力 ：SystemCapability.MultimodalInput.Input.InputDevice

參數 ：

示例 ：

inputDevice.getDeviceIds((ids)= >{
    console.log("The device ID list is: " + ids);
});

inputDevice.getDeviceIds

getDeviceIds(): Promise>

獲取所有輸入設備的id列表，使用Promise方式作為異步方法。

系統能力 ：SystemCapability.MultimodalInput.Input.InputDevice

返回值 ：

示例 ：

inputDevice.getDeviceIds().then((ids)= >{
    console.log("The device ID list is: " + ids);
});

inputDevice.getDevice

getDevice(deviceId: number, callback: AsyncCallback): void

獲取輸入設備的描述信息，使用callback方式作為異步方法。

系統能力 ：SystemCapability.MultimodalInput.Input.InputDevice

參數 ：

示例 ：

// 示例獲取設備id為1的設備name信息。
inputDevice.getDevice(1, (inputDevice)= >{
    console.log("The device name is: " + inputDevice.name);
});

inputDevice.getDevice

getDevice(deviceId: number): Promise

獲取輸入設備的描述信息，使用Promise方式作為異步方法。

系統能力 ：SystemCapability.MultimodalInput.Input.InputDevice

參數 ：

返回值 ：

示例 ：

// 示例獲取設備id為1的設備name信息。
inputDevice.getDevice(1).then((inputDevice)= >{
    console.log("The device name is: " + inputDevice.name);
});

inputDevice.supportKeys9+

supportKeys(deviceId: number, keys: Array, callback: Callback>): void

獲取輸入設備支持的鍵碼值，使用callback方式作為異步方法。

系統能力 ：SystemCapability.MultimodalInput.Input.InputDevice

參數 ：

示例 ：

// 示例查詢id為1的設備對于17、22和2055按鍵的支持情況。
inputDevice.supportKeys(1, [17, 22, 2055], (ret)= >{
    console.log("The query result is as follows: " + ret);
});

inputDevice.supportKeys9+

supportKeys(deviceId: number, keys: Array): Promise>

獲取輸入設備支持的鍵碼值，使用Promise方式作為異步方法。

系統能力 ：SystemCapability.MultimodalInput.Input.InputDevice

參數 ：

返回值 ：

示例 ：

// 示例查詢id為1的設備對于17、22和2055按鍵的支持情況。
inputDevice.supportKeys(1, [17, 22, 2055]).then((ret)= >{
    console.log("The query result is as follows: " + ret);
})

inputDevice.getKeyboardType9+

getKeyboardType(deviceId: number, callback: AsyncCallback): void

查詢輸入設備的鍵盤類型，使用callback方式作為異步方法。

系統能力 ：SystemCapability.MultimodalInput.Input.InputDevice

參數 ：

示例 ：

// 示例查詢設備id為1的設備鍵盤類型。
inputDevice.getKeyboardType(1, (ret)= >{
    console.log("The keyboard type of the device is: " + ret);
});

inputDevice.getKeyboardType9+

getKeyboardType(deviceId: number): Promise

查詢輸入設備的鍵盤類型，使用Promise方式作為異步方法。

系統能力 ：SystemCapability.MultimodalInput.Input.InputDevice

返回值 ：

示例 ：

// 示例查詢設備id為1的設備鍵盤類型。
inputDevice.getKeyboardType(1).then((ret)= >{
    console.log("The keyboard type of the device is: " + ret);
})

DeviceListener9+

輸入設備的描述信息。

系統能力 ：以下各項對應的系統能力均為SystemCapability.MultimodalInput.Input.InputDevice

InputDeviceData

輸入設備的描述信息。

系統能力 ：以下各項對應的系統能力均為SystemCapability.MultimodalInput.Input.InputDevice

AxisType9+

輸入設備的軸類型。

系統能力 ：以下各項對應的系統能力均為SystemCapability.MultimodalInput.Input.InputDevice

AxisRange

輸入設備的軸信息。

系統能力 ： 以下各項對應的系統能力均為SystemCapability.MultimodalInput.Input.InputDevice

SourceType

定義這個軸的輸入源類型。比如鼠標設備可上報x軸事件，則x軸的源就是鼠標。

系統能力 ：以下各項對應的系統能力均為SystemCapability.MultimodalInput.Input.InputDevice

ChangedType

定義監聽設備熱插拔事件。

系統能力 ：以下各項對應的系統能力均為SystemCapability.MultimodalInput.Input.InputDevice

KeyboardType9+

定義鍵盤輸入設備的類型。

系統能力 ：以下各項對應的系統能力均為SystemCapability.MultimodalInput.Input.InputDevice

審核編輯 黃宇