@ohos.multimodalInput.inputDevice (Input Device)

The inputDevice module implements listening for connection, disconnection, and update events of input devices and displays information about input devices. For example, it can be used to listen for mouse insertion and removal and obtain information such as the ID, name, and pointer speed of the mouse.

NOTE
The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

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

inputDevice.getDeviceList⁹⁺

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

Obtains the IDs of all input devices. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Array<number>>	Yes	Callback used to return the result.

Example

try {
  inputDevice.getDeviceIds((error, ids) => {
    if (error) {
      console.log(`Failed to get device list.
         error code=${JSON.stringify(err.code)} msg=${JSON.stringify(err.message)}`);
      return;
    }
    this.data = ids;
    console.log("The device ID list is: " + ids);
  });
} catch (error) {
  console.info("getDeviceList " + error.code + " " + error.message);
}

inputDevice.getDeviceList⁹⁺

getDeviceList(): Promise<Array<number>>

Obtains the IDs of all input devices. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Return value

Name	Description
Promise<Array<number>>	Promise used to return the result.

Example

try {
  inputDevice.getDeviceIds().then((ids) => {
    console.log("The device ID list is: " + ids);
  });
} catch (error) {
  console.info("getDeviceList " + error.code + " " + error.message);
}

inputDevice.getDeviceInfo⁹⁺

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

Obtains information about an input device. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Parameters

Name	Type	Mandatory	Description
deviceId	number	Yes	ID of the input device.
callback	AsyncCallback<InputDeviceData>	Yes	Callback used to return the result, which is an InputDeviceData object.

Example

// Obtain the name of the device whose ID is 1.
try {
  inputDevice.getDeviceInfo(1, (error, inputDevice) => {
    if (error) {
      console.log(`Failed to get device information.
          error code=${JSON.stringify(err.code)} msg=${JSON.stringify(err.message)}`);
      return;
    }
    console.log("The device name is: " + inputDevice.name);
  });
} catch (error) {
  console.info("getDeviceInfo " + error.code + " " + error.message);
}

inputDevice.getDeviceInfo⁹⁺

getDeviceInfo(deviceId: number): Promise<InputDeviceData>

Obtains information about an input device. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Parameters

Name	Type	Mandatory	Description
deviceId	number	Yes	ID of the input device.

Return value

Name	Description
Promise<InputDeviceData>	Promise used to return the result.

Example

// Obtain the name of the device whose ID is 1.
try {
  inputDevice.getDeviceInfo(id).then((inputDevice) => {
    console.log("The device name is: " + inputDevice.name);
  });
} catch (error) {
  console.info("getDeviceInfo " + error.code + " " + error.message);
}

inputDevice.on⁹⁺

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

Enables listening for hot swap events of an input device.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type of the input device.
listener	Callback<DeviceListener>	Yes	Listener for events of the input device.

Example

let isPhysicalKeyboardExist = true;
try {
  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') {
        // The physical keyboard is connected.
        isPhysicalKeyboardExist = true;
      } else if (ret == inputDevice.KeyboardType.ALPHABETIC_KEYBOARD && data.type == 'remove') {
        // The physical keyboard is disconnected.
        isPhysicalKeyboardExist = false;
      }
    });
  });
  // Check whether the soft keyboard is open based on the value of isPhysicalKeyboardExist.
} catch (error) {
  console.info("oninputdevcie " + error.code + " " + error.message);
}

inputDevice.off⁹⁺

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

Disables listening for hot swap events of an input device.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type of the input device.
listener	Callback<DeviceListener>	No	Listener for events of the input device.

Example

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

try {
  inputDevice.on("change", this.callback);
} catch (error) {
  console.info("oninputdevcie " + error.code + " " + error.message)
}

// Enable listening for hot swap events of an input device.
inputDevice.on("change", listener);

// Disable this listener.
try {
  inputDevice.off("change", this.callback);
} catch (error) {
  console.info("offinputdevcie " + error.code + " " + error.message)
}

// Disable all listeners.
try {
  inputDevice.off("change");
} catch (error) {
  console.info("offinputdevcie " + error.code + " " + error.message);
}
// By default, the soft keyboard is closed when listening is disabled.

inputDevice.getDeviceIds^(deprecated)

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

Obtains the IDs of all input devices. This API uses an asynchronous callback to return the result.

This API is deprecated since API version 9. You are advised to use inputDevice.getDeviceList instead.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Array<number>>	Yes	Callback used to return the result.

Example

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<sup>(deprecated)</sup>

getDeviceIds(): Promise&lt;Array&lt;number&gt;&gt;

Obtains the IDs of all input devices. This API uses a promise to return the result.

This API is deprecated since API version 9. You are advised to use [inputDevice.getDeviceList](#inputdevicegetdevicelist9) instead.

**System capability**: SystemCapability.MultimodalInput.Input.InputDevice

**Return value**

| Parameter                                | Description                 |
| ---------------------------------- | ------------------- |
| Promise&lt;Array&lt;number&gt;&gt; | Promise used to return the result.|

**Example**

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

inputDevice.getDevice^(deprecated)

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

Obtains information about an input device. This API uses an asynchronous callback to return the result.

This API is deprecated since API version 9. You are advised to use inputDevice.getDeviceInfo instead.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Parameters

Name	Type	Mandatory	Description
deviceId	number	Yes	ID of the input device.
callback	AsyncCallback<InputDeviceData>	Yes	Callback used to return the result, which is an InputDeviceData object.

Example

// Obtain the name of the device whose ID is 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>

Obtains information about an input device. This API uses a promise to return the result.

This API is deprecated since API version 9. You are advised to use inputDevice.getDeviceInfo instead.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Parameters

Name	Type	Mandatory	Description
deviceId	number	Yes	ID of the input device.

Return value

Parameter	Description
Promise<InputDeviceData>	Promise used to return the result.

Example

// Obtain the name of the device whose ID is 1.
inputDevice.getDevice(1).then((deviceData) => {
  console.log(`Device info: ${JSON.stringify(deviceData)}`);
});

inputDevice.supportKeys⁹⁺

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

Obtains the key codes supported by the input device. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Parameters

Name	Type	Mandatory	Description
deviceId	number	Yes	Unique ID of the input device. If the same physical device is repeatedly inserted and removed, its ID changes.
keys	Array<KeyCode>	Yes	Key codes to be queried. A maximum of five key codes can be specified.
callback	AsyncCallback<Array<boolean>>	Yes	Callback used to return the result.

Example

// Check whether the input device whose ID is 1 supports key codes 17, 22, and 2055.
try {
  inputDevice.supportKeys(1, [17, 22, 2055], (error, ret) => {
    console.log("The query result is as follows: " + ret);
  });
} catch (error) {
  console.info("supportKeys " + error.code + " " + error.message);
}

inputDevice.supportKeys⁹⁺

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

Obtains the key codes supported by the input device. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Parameters

Name	Type	Mandatory	Description
deviceId	number	Yes	Unique ID of the input device. If the same physical device is repeatedly inserted and removed, its ID changes.
keys	Array<KeyCode>	Yes	Key codes to be queried. A maximum of five key codes can be specified.

Return value

Parameter	Description
Promise<Array<boolean>>	Promise used to return the result.

Example

// Check whether the input device whose ID is 1 supports key codes 17, 22, and 2055.
try {
  inputDevice.supportKeys(1, [17, 22, 2055]).then((ret) => {
    console.log("The query result is as follows: " + ret);
  });
} catch (error) {
  console.info("supportKeys " + error.code + " " + error.message);
}

inputDevice.getKeyboardType⁹⁺

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

Obtains the keyboard type of an input device. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Parameters

Name	Type	Mandatory	Description
deviceId	number	Yes	Unique ID of the input device. If the same physical device is repeatedly inserted and removed, its ID changes.
callback	AsyncCallback<KeyboardType>	Yes	Callback used to return the result.

Example

// Query the keyboard type of the input device whose ID is 1.
try {
  inputDevice.getKeyboardType(1, (error, number) => {
    if (error) {
      console.log(`Failed to get keyboardtype.
          error code=${JSON.stringify(err.code)} msg=${JSON.stringify(err.message)}`);
      return;
    }
    console.log("The keyboard type of the device is: " + number);
  });
} catch (error) {
  console.info("getKeyboardType " + error.code + " " + error.message);
}

inputDevice.getKeyboardType⁹⁺

getKeyboardType(deviceId: number,): Promise<KeyboardType>

Obtains the keyboard type of an input device. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Return value

Parameter	Description
Promise<KeyboardType>	Promise used to return the result.

Example

// Query the keyboard type of the input device whose ID is 1.
try {
  inputDevice.getKeyboardType(1).then((number) => {
    console.log("The keyboard type of the device is: " + number);
  });
} catch (error) {
  console.info("getKeyboardType " + error.code + " " + error.message);
}

DeviceListener⁹⁺

Defines the listener for hot swap events of an input device.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Name	Type	Readable	Writable	Description
type	ChangedType	Yes	No	Device change type, which indicates whether an input device is inserted or removed.
deviceId	number	Yes	No	Unique ID of the input device. If the same physical device is repeatedly inserted and removed, its ID changes.

InputDeviceData

Defines the information about an input device.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Name	Type	Readable	Writable	Description
id	number	Yes	No	Unique ID of the input device. If the same physical device is repeatedly inserted and removed, its ID changes.
name	string	Yes	No	Name of the input device.
sources	Array<SourceType>	Yes	No	Source type of the input device. For example, if a keyboard is attached with a touchpad, the device has two input sources: keyboard and touchpad.
axisRanges	Array<AxisRange>	Yes	No	Axis information of the input device.
bus⁹⁺	number	Yes	No	Bus type of the input device.
product⁹⁺	number	Yes	No	Product information of the input device.
vendor⁹⁺	number	Yes	No	Vendor information of the input device.
version⁹⁺	number	Yes	No	Version information of the input device.
phys⁹⁺	string	Yes	No	Physical address of the input device.
uniq⁹⁺	string	Yes	No	Unique ID of the input device.

AxisType⁹⁺

Defines the axis type of an input device.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Name	Type	Readable	Writable	Description
touchmajor	string	Yes	No	touchmajor axis.
touchminor	string	Yes	No	touchminor axis.
toolminor	string	Yes	No	toolminor axis.
toolmajor	string	Yes	No	toolmajor axis.
orientation	string	Yes	No	Orientation axis.
pressure	string	Yes	No	Pressure axis.
x	string	Yes	No	X axis.
y	string	Yes	No	Y axis.
NULL	string	Yes	No	None.

AxisRange

Defines the axis range of an input device.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Name	Type	Readable	Writable	Description
source	SourceType	Yes	No	Input source type of the axis.
axis	AxisType	Yes	No	Axis type.
max	number	Yes	No	Maximum value of the axis.
min	number	Yes	No	Minimum value of the axis.
fuzz⁹⁺	number	Yes	No	Fuzzy value of the axis.
flat⁹⁺	number	Yes	No	Benchmark value of the axis.
resolution⁹⁺	number	Yes	No	Resolution of the axis.

SourceType⁹⁺

Enumerates the input source types. For example, if a mouse reports an x-axis event, the source of the x-axis is the mouse.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Name	Type	Readable	Writable	Description
keyboard	string	Yes	No	The input device is a keyboard.
touchscreen	string	Yes	No	The input device is a touchscreen.
mouse	string	Yes	No	The input device is a mouse.
trackball	string	Yes	No	The input device is a trackball.
touchpad	string	Yes	No	The input device is a touchpad.
joystick	string	Yes	No	The input device is a joystick.

ChangedType⁹⁺

Defines the change type for the hot swap event of an input device.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Name	Type	Readable	Writable	Description
add	string	Yes	No	An input device is inserted.
remove	string	Yes	No	An input device is removed.

KeyboardType⁹⁺

Enumerates the keyboard types.

System capability: SystemCapability.MultimodalInput.Input.InputDevice

Name	Value	Description
NONE	0	Keyboard without keys.
UNKNOWN	1	Keyboard with unknown keys.
ALPHABETIC_KEYBOARD	2	Full keyboard.
DIGITAL_KEYBOARD	3	Keypad.
HANDWRITING_PEN	4	Stylus.
REMOTE_CONTROL	5	Remote control.

@ohos.multimodalInput.inputDevice (Input Device)

Modules to Import

inputDevice.getDeviceList9+

inputDevice.getDeviceList9+

inputDevice.getDeviceInfo9+

inputDevice.getDeviceInfo9+

inputDevice.on9+

inputDevice.off9+

inputDevice.getDeviceIds(deprecated)

inputDevice.getDevice(deprecated)

inputDevice.getDevice(deprecated)

inputDevice.supportKeys9+

inputDevice.supportKeys9+

inputDevice.getKeyboardType9+

inputDevice.getKeyboardType9+

DeviceListener9+

InputDeviceData

AxisType9+

AxisRange

SourceType9+

ChangedType9+

KeyboardType9+

inputDevice.getDeviceList⁹⁺

inputDevice.getDeviceList⁹⁺

inputDevice.getDeviceInfo⁹⁺

inputDevice.getDeviceInfo⁹⁺

inputDevice.on⁹⁺

inputDevice.off⁹⁺

inputDevice.getDeviceIds^(deprecated)

inputDevice.getDevice^(deprecated)

inputDevice.getDevice^(deprecated)

inputDevice.supportKeys⁹⁺

inputDevice.supportKeys⁹⁺

inputDevice.getKeyboardType⁹⁺

inputDevice.getKeyboardType⁹⁺

DeviceListener⁹⁺

AxisType⁹⁺

SourceType⁹⁺

ChangedType⁹⁺

KeyboardType⁹⁺