Skip to content

Most visited

Recently visited

navigation

InputDevice

public final class InputDevice
extends Object implements Parcelable

java.lang.Object
   ↳ android.view.InputDevice


Describes the capabilities of a particular input device.

Each input device may support multiple classes of input. For example, a multi-function keyboard may compose the capabilities of a standard keyboard together with a track pad mouse or other pointing device.

Some input devices present multiple distinguishable sources of input. Applications can query the framework about the characteristics of each distinct source.

As a further wrinkle, different kinds of input sources uses different coordinate systems to describe motion events. Refer to the comments on the input source constants for the appropriate interpretation.

Summary

Nested classes

class InputDevice.MotionRange

Provides information about the range of values for a particular MotionEvent axis. 

Constants

int KEYBOARD_TYPE_ALPHABETIC

The keyboard supports a complement of alphabetic keys.

int KEYBOARD_TYPE_NONE

There is no keyboard.

int KEYBOARD_TYPE_NON_ALPHABETIC

The keyboard is not fully alphabetic.

int MOTION_RANGE_ORIENTATION

This constant was deprecated in API level 12. Use AXIS_ORIENTATION instead.

int MOTION_RANGE_PRESSURE

This constant was deprecated in API level 12. Use AXIS_PRESSURE instead.

int MOTION_RANGE_SIZE

This constant was deprecated in API level 12. Use AXIS_SIZE instead.

int MOTION_RANGE_TOOL_MAJOR

This constant was deprecated in API level 12. Use AXIS_TOOL_MAJOR instead.

int MOTION_RANGE_TOOL_MINOR

This constant was deprecated in API level 12. Use AXIS_TOOL_MINOR instead.

int MOTION_RANGE_TOUCH_MAJOR

This constant was deprecated in API level 12. Use AXIS_TOUCH_MAJOR instead.

int MOTION_RANGE_TOUCH_MINOR

This constant was deprecated in API level 12. Use AXIS_TOUCH_MINOR instead.

int MOTION_RANGE_X

This constant was deprecated in API level 12. Use AXIS_X instead.

int MOTION_RANGE_Y

This constant was deprecated in API level 12. Use AXIS_Y instead.

int SOURCE_ANY

A special input source constant that is used when filtering input devices to match devices that provide any type of input source.

int SOURCE_BLUETOOTH_STYLUS

The input device is a Bluetooth stylus.

int SOURCE_CLASS_BUTTON

The input source has buttons or keys.

int SOURCE_CLASS_JOYSTICK

The input source is a joystick.

int SOURCE_CLASS_MASK

A mask for input source classes.

int SOURCE_CLASS_NONE

The input source has no class.

int SOURCE_CLASS_POINTER

The input source is a pointing device associated with a display.

int SOURCE_CLASS_POSITION

The input source is an absolute positioning device not associated with a display (unlike SOURCE_CLASS_POINTER).

int SOURCE_CLASS_TRACKBALL

The input source is a trackball navigation device.

int SOURCE_DPAD

The input source is a DPad.

int SOURCE_GAMEPAD

The input source is a game pad.

int SOURCE_HDMI

The input source is a device connected through HDMI-based bus.

int SOURCE_JOYSTICK

The input source is a joystick.

int SOURCE_KEYBOARD

The input source is a keyboard.

int SOURCE_MOUSE

The input source is a mouse pointing device.

int SOURCE_STYLUS

The input source is a stylus pointing device.

int SOURCE_TOUCHPAD

The input source is a touch pad or digitizer tablet that is not associated with a display (unlike SOURCE_TOUCHSCREEN).

int SOURCE_TOUCHSCREEN

The input source is a touch screen pointing device.

int SOURCE_TOUCH_NAVIGATION

The input source is a touch device whose motions should be interpreted as navigation events.

int SOURCE_TRACKBALL

The input source is a trackball.

int SOURCE_UNKNOWN

The input source is unknown.

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<InputDevice> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

int getControllerNumber()

The controller number for a given input device.

String getDescriptor()

Gets the input device descriptor, which is a stable identifier for an input device.

static InputDevice getDevice(int id)

Gets information about the input device with the specified id.

static int[] getDeviceIds()

Gets the ids of all input devices in the system.

int getId()

Gets the input device id.

KeyCharacterMap getKeyCharacterMap()

Gets the key character map associated with this input device.

int getKeyboardType()

Gets the keyboard type.

InputDevice.MotionRange getMotionRange(int axis)

Gets information about the range of values for a particular MotionEvent axis.

InputDevice.MotionRange getMotionRange(int axis, int source)

Gets information about the range of values for a particular MotionEvent axis used by a particular source on the device.

List<InputDevice.MotionRange> getMotionRanges()

Gets the ranges for all axes supported by the device.

String getName()

Gets the name of this input device.

int getProductId()

Gets the product id for the given device, if available.

int getSources()

Gets the input sources supported by this input device as a combined bitfield.

int getVendorId()

Gets the vendor id for the given device, if available.

Vibrator getVibrator()

Gets the vibrator service associated with the device, if there is one.

boolean[] hasKeys(int... keys)

Gets whether the device is capable of producing the list of keycodes.

boolean hasMicrophone()

Reports whether the device has a built-in microphone.

boolean isVirtual()

Returns true if the device is a virtual input device rather than a real one, such as the virtual keyboard (see VIRTUAL_KEYBOARD).

boolean supportsSource(int source)

Determines whether the input device supports the given source or sources.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel out, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Constants

KEYBOARD_TYPE_ALPHABETIC

Added in API level 9
int KEYBOARD_TYPE_ALPHABETIC

The keyboard supports a complement of alphabetic keys.

Constant Value: 2 (0x00000002)

KEYBOARD_TYPE_NONE

Added in API level 9
int KEYBOARD_TYPE_NONE

There is no keyboard.

Constant Value: 0 (0x00000000)

KEYBOARD_TYPE_NON_ALPHABETIC

Added in API level 9
int KEYBOARD_TYPE_NON_ALPHABETIC

The keyboard is not fully alphabetic. It may be a numeric keypad or an assortment of buttons that are not mapped as alphabetic keys suitable for text input.

Constant Value: 1 (0x00000001)

MOTION_RANGE_ORIENTATION

Added in API level 9
int MOTION_RANGE_ORIENTATION

This constant was deprecated in API level 12.
Use AXIS_ORIENTATION instead.

Constant for retrieving the range of values for AXIS_ORIENTATION.

See also:

Constant Value: 8 (0x00000008)

MOTION_RANGE_PRESSURE

Added in API level 9
int MOTION_RANGE_PRESSURE

This constant was deprecated in API level 12.
Use AXIS_PRESSURE instead.

Constant for retrieving the range of values for AXIS_PRESSURE.

See also:

Constant Value: 2 (0x00000002)

MOTION_RANGE_SIZE

Added in API level 9
int MOTION_RANGE_SIZE

This constant was deprecated in API level 12.
Use AXIS_SIZE instead.

Constant for retrieving the range of values for AXIS_SIZE.

See also:

Constant Value: 3 (0x00000003)

MOTION_RANGE_TOOL_MAJOR

Added in API level 9
int MOTION_RANGE_TOOL_MAJOR

This constant was deprecated in API level 12.
Use AXIS_TOOL_MAJOR instead.

Constant for retrieving the range of values for AXIS_TOOL_MAJOR.

See also:

Constant Value: 6 (0x00000006)

MOTION_RANGE_TOOL_MINOR

Added in API level 9
int MOTION_RANGE_TOOL_MINOR

This constant was deprecated in API level 12.
Use AXIS_TOOL_MINOR instead.

Constant for retrieving the range of values for AXIS_TOOL_MINOR.

See also:

Constant Value: 7 (0x00000007)

MOTION_RANGE_TOUCH_MAJOR

Added in API level 9
int MOTION_RANGE_TOUCH_MAJOR

This constant was deprecated in API level 12.
Use AXIS_TOUCH_MAJOR instead.

Constant for retrieving the range of values for AXIS_TOUCH_MAJOR.

See also:

Constant Value: 4 (0x00000004)

MOTION_RANGE_TOUCH_MINOR

Added in API level 9
int MOTION_RANGE_TOUCH_MINOR

This constant was deprecated in API level 12.
Use AXIS_TOUCH_MINOR instead.

Constant for retrieving the range of values for AXIS_TOUCH_MINOR.

See also:

Constant Value: 5 (0x00000005)

MOTION_RANGE_X

Added in API level 9
int MOTION_RANGE_X

This constant was deprecated in API level 12.
Use AXIS_X instead.

Constant for retrieving the range of values for AXIS_X.

See also:

Constant Value: 0 (0x00000000)

MOTION_RANGE_Y

Added in API level 9
int MOTION_RANGE_Y

This constant was deprecated in API level 12.
Use AXIS_Y instead.

Constant for retrieving the range of values for AXIS_Y.

See also:

Constant Value: 1 (0x00000001)

SOURCE_ANY

Added in API level 9
int SOURCE_ANY

A special input source constant that is used when filtering input devices to match devices that provide any type of input source.

Constant Value: -256 (0xffffff00)

SOURCE_BLUETOOTH_STYLUS

Added in API level 23
int SOURCE_BLUETOOTH_STYLUS

The input device is a Bluetooth stylus.

Note that this bit merely indicates that an input device is capable of obtaining input from a Bluetooth stylus. To determine whether a given touch event was produced by a stylus, examine the tool type returned by getToolType(int) for each individual pointer.

A single touch event may multiple pointers with different tool types, such as an event that has one pointer with tool type TOOL_TYPE_FINGER and another pointer with tool type TOOL_TYPE_STYLUS. So it is important to examine the tool type of each pointer, regardless of the source reported by getSource().

A bluetooth stylus generally receives its pressure and button state information from the stylus itself, and derives the rest from another source. For example, a Bluetooth stylus used in conjunction with a touchscreen would derive its contact position and pointer size from the touchscreen and may not be any more accurate than other tools such as fingers.

See also:

Constant Value: 49154 (0x0000c002)

SOURCE_CLASS_BUTTON

Added in API level 9
int SOURCE_CLASS_BUTTON

The input source has buttons or keys. Examples: SOURCE_KEYBOARD, SOURCE_DPAD. A KeyEvent should be interpreted as a button or key press. Use getKeyCharacterMap() to query the device's button and key mappings.

Constant Value: 1 (0x00000001)

SOURCE_CLASS_JOYSTICK

Added in API level 12
int SOURCE_CLASS_JOYSTICK

The input source is a joystick. A MotionEvent should be interpreted as absolute joystick movements. Use getMotionRange(int) to query the range of positions.

Constant Value: 16 (0x00000010)

SOURCE_CLASS_MASK

Added in API level 9
int SOURCE_CLASS_MASK

A mask for input source classes. Each distinct input source constant has one or more input source class bits set to specify the desired interpretation for its input events.

Constant Value: 255 (0x000000ff)

SOURCE_CLASS_NONE

Added in API level 18
int SOURCE_CLASS_NONE

The input source has no class. It is up to the application to determine how to handle the device based on the device type.

Constant Value: 0 (0x00000000)

SOURCE_CLASS_POINTER

Added in API level 9
int SOURCE_CLASS_POINTER

The input source is a pointing device associated with a display. Examples: SOURCE_TOUCHSCREEN, SOURCE_MOUSE. A MotionEvent should be interpreted as absolute coordinates in display units according to the View hierarchy. Pointer down/up indicated when the finger touches the display or when the selection button is pressed/released. Use getMotionRange(int) to query the range of the pointing device. Some devices permit touches outside the display area so the effective range may be somewhat smaller or larger than the actual display size.

Constant Value: 2 (0x00000002)

SOURCE_CLASS_POSITION

Added in API level 9
int SOURCE_CLASS_POSITION

The input source is an absolute positioning device not associated with a display (unlike SOURCE_CLASS_POINTER). A MotionEvent should be interpreted as absolute coordinates in device-specific surface units. Use getMotionRange(int) to query the range of positions.

Constant Value: 8 (0x00000008)

SOURCE_CLASS_TRACKBALL

Added in API level 9
int SOURCE_CLASS_TRACKBALL

The input source is a trackball navigation device. Examples: SOURCE_TRACKBALL. A MotionEvent should be interpreted as relative movements in device-specific units used for navigation purposes. Pointer down/up indicates when the selection button is pressed/released. Use getMotionRange(int) to query the range of motion.

Constant Value: 4 (0x00000004)

SOURCE_DPAD

Added in API level 9
int SOURCE_DPAD

The input source is a DPad.

See also:

Constant Value: 513 (0x00000201)

SOURCE_GAMEPAD

Added in API level 12
int SOURCE_GAMEPAD

The input source is a game pad. (It may also be a SOURCE_JOYSTICK).

See also:

Constant Value: 1025 (0x00000401)

SOURCE_HDMI

Added in API level 21
int SOURCE_HDMI

The input source is a device connected through HDMI-based bus. The key comes in through HDMI-CEC or MHL signal line, and is treated as if it were generated by a locally connected DPAD or keyboard.

Constant Value: 33554433 (0x02000001)

SOURCE_JOYSTICK

Added in API level 12
int SOURCE_JOYSTICK

The input source is a joystick. (It may also be a SOURCE_GAMEPAD).

See also:

Constant Value: 16777232 (0x01000010)

SOURCE_KEYBOARD

Added in API level 9
int SOURCE_KEYBOARD

The input source is a keyboard. This source indicates pretty much anything that has buttons. Use getKeyboardType() to determine whether the keyboard has alphabetic keys and can be used to enter text.

See also:

Constant Value: 257 (0x00000101)

SOURCE_MOUSE

Added in API level 9
int SOURCE_MOUSE

The input source is a mouse pointing device. This code is also used for other mouse-like pointing devices such as trackpads and trackpoints.

See also:

Constant Value: 8194 (0x00002002)

SOURCE_STYLUS

Added in API level 14
int SOURCE_STYLUS

The input source is a stylus pointing device.

Note that this bit merely indicates that an input device is capable of obtaining input from a stylus. To determine whether a given touch event was produced by a stylus, examine the tool type returned by getToolType(int) for each individual pointer.

A single touch event may multiple pointers with different tool types, such as an event that has one pointer with tool type TOOL_TYPE_FINGER and another pointer with tool type TOOL_TYPE_STYLUS. So it is important to examine the tool type of each pointer, regardless of the source reported by getSource().

See also:

Constant Value: 16386 (0x00004002)

SOURCE_TOUCHPAD

Added in API level 9
int SOURCE_TOUCHPAD

The input source is a touch pad or digitizer tablet that is not associated with a display (unlike SOURCE_TOUCHSCREEN).

See also:

Constant Value: 1048584 (0x00100008)

SOURCE_TOUCHSCREEN

Added in API level 9
int SOURCE_TOUCHSCREEN

The input source is a touch screen pointing device.

See also:

Constant Value: 4098 (0x00001002)

SOURCE_TOUCH_NAVIGATION

Added in API level 18
int SOURCE_TOUCH_NAVIGATION

The input source is a touch device whose motions should be interpreted as navigation events. For example, an upward swipe should be as an upward focus traversal in the same manner as pressing up on a D-Pad would be. Swipes to the left, right and down should be treated in a similar manner.

See also:

Constant Value: 2097152 (0x00200000)

SOURCE_TRACKBALL

Added in API level 9
int SOURCE_TRACKBALL

The input source is a trackball.

See also:

Constant Value: 65540 (0x00010004)

SOURCE_UNKNOWN

Added in API level 9
int SOURCE_UNKNOWN

The input source is unknown.

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 9
Creator<InputDevice> CREATOR

Public methods

describeContents

Added in API level 9
int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

getControllerNumber

Added in API level 19
int getControllerNumber ()

The controller number for a given input device.

Each gamepad or joystick is given a unique, positive controller number when initially configured by the system. This number may change due to events such as device disconnects / reconnects or user initiated reassignment. Any change in number will trigger an event that can be observed by registering an InputManager.InputDeviceListener.

All input devices which are not gamepads or joysticks will be assigned a controller number of 0.

Returns
int The controller number of the device.

getDescriptor

Added in API level 16
String getDescriptor ()

Gets the input device descriptor, which is a stable identifier for an input device.

An input device descriptor uniquely identifies an input device. Its value is intended to be persistent across system restarts, and should not change even if the input device is disconnected, reconnected or reconfigured at any time.

It is possible for there to be multiple InputDevice instances that have the same input device descriptor. This might happen in situations where a single human input device registers multiple InputDevice instances (HID collections) that describe separate features of the device, such as a keyboard that also has a trackpad. Alternately, it may be that the input devices are simply indistinguishable, such as two keyboards made by the same manufacturer.

The input device descriptor returned by getDescriptor() should only be used when an application needs to remember settings associated with a particular input device. For all other purposes when referring to a logical InputDevice instance at runtime use the id returned by getId().

Returns
String The input device descriptor.

getDevice

Added in API level 9
InputDevice getDevice (int id)

Gets information about the input device with the specified id.

Parameters
id int: The device id.
Returns
InputDevice The input device or null if not found.

getDeviceIds

Added in API level 9
int[] getDeviceIds ()

Gets the ids of all input devices in the system.

Returns
int[] The input device ids.

getId

Added in API level 9
int getId ()

Gets the input device id.

Each input device receives a unique id when it is first configured by the system. The input device id may change when the system is restarted or if the input device is disconnected, reconnected or reconfigured at any time. If you require a stable identifier for a device that persists across boots and reconfigurations, use getDescriptor().

Returns
int The input device id.

getKeyCharacterMap

Added in API level 9
KeyCharacterMap getKeyCharacterMap ()

Gets the key character map associated with this input device.

Returns
KeyCharacterMap The key character map.

getKeyboardType

Added in API level 9
int getKeyboardType ()

Gets the keyboard type.

Returns
int The keyboard type.

getMotionRange

Added in API level 9
InputDevice.MotionRange getMotionRange (int axis)

Gets information about the range of values for a particular MotionEvent axis. If the device supports multiple sources, the same axis may have different meanings for each source. Returns information about the first axis found for any source. To obtain information about the axis for a specific source, use getMotionRange(int, int).

Parameters
axis int: The axis constant.
Returns
InputDevice.MotionRange The range of values, or null if the requested axis is not supported by the device.

See also:

getMotionRange

Added in API level 12
InputDevice.MotionRange getMotionRange (int axis, 
                int source)

Gets information about the range of values for a particular MotionEvent axis used by a particular source on the device. If the device supports multiple sources, the same axis may have different meanings for each source.

Parameters
axis int: The axis constant.
source int: The source for which to return information.
Returns
InputDevice.MotionRange The range of values, or null if the requested axis is not supported by the device.

See also:

getMotionRanges

Added in API level 12
List<InputDevice.MotionRange> getMotionRanges ()

Gets the ranges for all axes supported by the device.

Returns
List<InputDevice.MotionRange> The motion ranges for the device.

See also:

getName

Added in API level 9
String getName ()

Gets the name of this input device.

Returns
String The input device name.

getProductId

Added in API level 19
int getProductId ()

Gets the product id for the given device, if available.

A product id uniquely identifies which product within the address space of a given vendor, identified by the device's vendor id. A value of 0 will be assigned where a product id is not available.

Returns
int The product id of a given device

getSources

Added in API level 9
int getSources ()

Gets the input sources supported by this input device as a combined bitfield.

Returns
int The supported input sources.

getVendorId

Added in API level 19
int getVendorId ()

Gets the vendor id for the given device, if available.

A vendor id uniquely identifies the company who manufactured the device. A value of 0 will be assigned where a vendor id is not available.

Returns
int The vendor id of a given device

getVibrator

Added in API level 16
Vibrator getVibrator ()

Gets the vibrator service associated with the device, if there is one. Even if the device does not have a vibrator, the result is never null. Use hasVibrator() to determine whether a vibrator is present. Note that the vibrator associated with the device may be different from the system vibrator. To obtain an instance of the system vibrator instead, call getSystemService(Class) with VIBRATOR_SERVICE as argument.

Returns
Vibrator The vibrator service associated with the device, never null.

hasKeys

Added in API level 19
boolean[] hasKeys (int... keys)

Gets whether the device is capable of producing the list of keycodes.

Parameters
keys int: The list of android keycodes to check for.
Returns
boolean[] An array of booleans where each member specifies whether the device is capable of generating the keycode given by the corresponding value at the same index in the keys array.

hasMicrophone

Added in API level 23
boolean hasMicrophone ()

Reports whether the device has a built-in microphone.

Returns
boolean Whether the device has a built-in microphone.

isVirtual

Added in API level 16
boolean isVirtual ()

Returns true if the device is a virtual input device rather than a real one, such as the virtual keyboard (see VIRTUAL_KEYBOARD).

Virtual input devices are provided to implement system-level functionality and should not be seen or configured by users.

Returns
boolean True if the device is virtual.

See also:

supportsSource

Added in API level 21
boolean supportsSource (int source)

Determines whether the input device supports the given source or sources.

Parameters
source int: The input source or sources to check against. This can be a generic device type such as SOURCE_MOUSE, a more generic device class, such as SOURCE_CLASS_POINTER, or a combination of sources bitwise ORed together.
Returns
boolean Whether the device can produce all of the given sources.

toString

Added in API level 9
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

Added in API level 9
void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
out Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.