輸入設備

導入模塊

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

inputDevice.getDeviceList9+

getDeviceList(callback: AsyncCallback<Array<number>>): void

獲取所有輸入設備的id列表，使用AsyncCallback異步方式返回結(jié)果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

參數(shù)：

示例：

try {
  inputDevice.getDeviceList((error, ids) => {
    if (error) {
      console.log(`Failed to get device id list, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Device id list: ${JSON.stringify(ids)}`);
  });
} catch (error) {
  console.log(`Failed to get device id list, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDevice.getDeviceList9+

getDeviceList(): Promise<Array<number>>

獲取所有輸入設備的id列表，使用Promise異步方式返回結(jié)果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

返回值：

示例：

try {
  inputDevice.getDeviceList().then((ids) => {
    console.log(`Device id list: ${JSON.stringify(ids)}`);
  });
} catch (error) {
  console.log(`Failed to get device id list, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDevice.getDeviceInfo9+

getDeviceInfo(deviceId: number, callback: AsyncCallback<InputDeviceData>): void

獲取指定輸入設備的信息，使用AsyncCallback異步方式返回結(jié)果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

參數(shù)：

示例：

// 獲取輸入設備id為1的設備信息。
try {
  inputDevice.getDeviceInfo(1, (error, deviceData) => {
    if (error) {
      console.log(`Failed to get device info, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Device info: ${JSON.stringify(deviceData)}`);
  });
} catch (error) {
  console.log(`Failed to get device info, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDevice.getDeviceInfo9+

getDeviceInfo(deviceId: number): Promise<InputDeviceData>

獲取指定輸入設備的信息，使用Promise異步方式返回結(jié)果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

參數(shù)：

返回值：

示例：

// 獲取輸入設備id為1的設備信息。
try {
  inputDevice.getDeviceInfo(1).then((deviceData) => {
    console.log(`Device info: ${JSON.stringify(deviceData)}`);
  });
} catch (error) {
  console.log(`Failed to get device info, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDevice.on9+

on(type: "change", listener: Callback<DeviceListener>): void

監(jiān)聽輸入設備的熱插拔事件，使用時需連接鼠標鍵盤等外部設備。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

參數(shù)：

示例：

let isPhysicalKeyboardExist = true;
try {
  inputDevice.on("change", (data) => {
    console.log(`Device event info: ${JSON.stringify(data)}`);
    inputDevice.getKeyboardType(data.deviceId, (err, type) => {
      console.log("The keyboard type is: " + type);
      if (type == inputDevice.KeyboardType.ALPHABETIC_KEYBOARD && data.type == 'add') {
        // 監(jiān)聽物理鍵盤已連接。
        isPhysicalKeyboardExist = true;
      } else if (type == inputDevice.KeyboardType.ALPHABETIC_KEYBOARD && data.type == 'remove') {
        // 監(jiān)聽物理鍵盤已斷開。
        isPhysicalKeyboardExist = false;
      }
    });
  });
  // 根據(jù)isPhysicalKeyboardExist的值決定軟鍵盤是否彈出。
} catch (error) {
  console.log(`Get device info failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDevice.off9+

off(type: "change", listener?: Callback<DeviceListener>): void

取消監(jiān)聽輸入設備的熱插拔事件。在應用退出前調(diào)用，取消監(jiān)聽。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

參數(shù)：

示例：

function callback(data) {
  console.log(`Report device event info: ${JSON.stringify(data, [`type`, `deviceId`])}`);
};

try {
  inputDevice.on("change", callback);
} catch (error) {
  console.log(`Listen device event failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

// 取消指定的監(jiān)聽。
try {
  inputDevice.off("change", callback);
} catch (error) {
  console.log(`Cancel listening device event failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

// 取消所有監(jiān)聽。
try {
  inputDevice.off("change");
} catch (error) {
  console.log(`Cancel all listening device event failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDevice.getDeviceIds(deprecated)

getDeviceIds(callback: AsyncCallback<Array<number>>): void

獲取所有輸入設備的id列表，使用AsyncCallback異步方式返回結(jié)果。

從API version 9 開始不再維護，建議使用inputDevice.getDeviceList代替。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

參數(shù)：

示例：

inputDevice.getDeviceIds((error, ids) => {
  if (error) {
    console.log(`Failed to get device id list, error: ${JSON.stringify(error, [`code`, `message`])}`);
    return;
  }
  console.log(`Device id list: ${JSON.stringify(ids)}`);
});

inputDevice.getDeviceIds(deprecated)

getDeviceIds(): Promise<Array<number>>

獲取所有輸入設備的id列表，使用Promise異步方式返回結(jié)果。

從API version 9 開始不再維護，建議使用inputDevice.getDeviceList代替。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

返回值：

示例：

inputDevice.getDeviceIds().then((ids) => {
  console.log(`Device id list: ${JSON.stringify(ids)}`);
});

inputDevice.getDevice(deprecated)

getDevice(deviceId: number, callback: AsyncCallback<InputDeviceData>): void

獲取指定輸入設備的信息，使用AsyncCallback異步方式返回結(jié)果。

從API version 9 開始不再維護，建議使用inputDevice.getDeviceInfo代替。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

參數(shù)：

示例：

// 獲取輸入設備id為1的設備信息。
inputDevice.getDevice(1, (error, deviceData) => {
  if (error) {
    console.log(`Failed to get device info, error: ${JSON.stringify(error, [`code`, `message`])}`);
    return;
  }
  console.log(`Device info: ${JSON.stringify(deviceData)}`);
});

inputDevice.getDevice(deprecated)

getDevice(deviceId: number): Promise<InputDeviceData>

獲取指定輸入設備的信息，使用Promise異步方式返回結(jié)果。

從API version 9 開始不再維護，建議使用inputDevice.getDeviceInfo代替。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

參數(shù)：

返回值：

示例：

// 獲取輸入設備id為1的設備信息。
inputDevice.getDevice(1).then((deviceData) => {
  console.log(`Device info: ${JSON.stringify(deviceData)}`);
});

inputDevice.supportKeys9+

supportKeys(deviceId: number, keys: Array<KeyCode>, callback: AsyncCallback <Array<boolean>>): void

獲取輸入設備是否支持指定的鍵碼值，使用AsyncCallback異步方式返回結(jié)果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

參數(shù)：

示例：

// 查詢id為1的輸入設備對于17、22和2055按鍵的支持情況。
try {
  inputDevice.supportKeys(1, [17, 22, 2055], (error, supportResult) => {
    console.log(`Query result: ${JSON.stringify(supportResult)}`);
  });
} catch (error) {
  console.log(`Query failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDevice.supportKeys9+

supportKeys(deviceId: number, keys: Array<KeyCode>): Promise<Array<boolean>>

獲取輸入設備是否支持指定的鍵碼值，使用Promise異步方式返回結(jié)果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

參數(shù)：

返回值：

示例：

// 查詢id為1的輸入設備對于17、22和2055按鍵的支持情況。
try {
  inputDevice.supportKeys(1, [17, 22, 2055]).then((supportResult) => {
    console.log(`Query result: ${JSON.stringify(supportResult)}`);
  });
} catch (error) {
  console.log(`Query failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDevice.getKeyboardType9+

getKeyboardType(deviceId: number, callback: AsyncCallback<KeyboardType>): void

獲取輸入設備的鍵盤類型，使用AsyncCallback異步方式返回結(jié)果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

參數(shù)：

示例：

// 查詢id為1的輸入設備的鍵盤類型。
try {
  inputDevice.getKeyboardType(1, (error, type) => {
    if (error) {
      console.log(`Failed to get keyboard type, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Keyboard type: ${JSON.stringify(type)}`);
  });
} catch (error) {
  console.log(`Failed to get keyboard type, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDevice.getKeyboardType9+

getKeyboardType(deviceId: number): Promise<KeyboardType>

獲取輸入設備的鍵盤類型，使用AsyncCallback異步方式返回結(jié)果。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

參數(shù)：

返回值：

示例：

// 示例查詢設備id為1的設備鍵盤類型。
try {
  inputDevice.getKeyboardType(1).then((type) => {
    console.log(`Keyboard type: ${JSON.stringify(type)}`);
  });
} catch (error) {
  console.log(`Failed to get keyboard type, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

DeviceListener9+

輸入設備熱插拔的描述信息。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

InputDeviceData

輸入設備的描述信息。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

AxisType9+

輸入設備的軸類型。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

AxisRange

輸入設備的軸信息。

系統(tǒng)能力： SystemCapability.MultimodalInput.Input.InputDevice

SourceType9+

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

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

ChangedType9+

定義監(jiān)聽設備熱插拔事件。

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice

KeyboardType9+

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

系統(tǒng)能力：SystemCapability.MultimodalInput.Input.InputDevice