lightbulb_outline Please take our October 2018 developer survey. Start survey

InputEvent

public abstract class InputEvent
extends Object implements Parcelable

java.lang.Object
   ↳ android.view.InputEvent


Common base class for input events.

Summary

Inherited constants

Fields

public static final Creator<InputEvent> CREATOR

Public methods

int describeContents()

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

final InputDevice getDevice()

Gets the device that this event came from.

abstract int getDeviceId()

Gets the id for the device that this event came from.

abstract long getEventTime()

Retrieve the time this event occurred, in the SystemClock.uptimeMillis() time base.

abstract int getSource()

Gets the source of the event.

boolean isFromSource(int source)

Determines whether the event is from the given source.

Inherited methods

Fields

CREATOR

added in API level 9
public static final Creator<InputEvent> CREATOR

Public methods

describeContents

added in API level 1
public 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.

getDevice

added in API level 9
public final InputDevice getDevice ()

Gets the device that this event came from.

Returns
InputDevice The device, or null if unknown.

getDeviceId

added in API level 9
public abstract int getDeviceId ()

Gets the id for the device that this event came from. An id of zero indicates that the event didn't come from a physical device and maps to the default keymap. The other numbers are arbitrary and you shouldn't depend on the values.

Returns
int The device id.

getEventTime

added in API level 16
public abstract long getEventTime ()

Retrieve the time this event occurred, in the SystemClock.uptimeMillis() time base.

Returns
long Returns the time this event occurred, in the SystemClock.uptimeMillis() time base.

getSource

added in API level 9
public abstract int getSource ()

Gets the source of the event.

Returns
int The event source or InputDevice.SOURCE_UNKNOWN if unknown.

isFromSource

added in API level 18
public boolean isFromSource (int source)

Determines whether the event is from the given source.

Parameters
source int: The input source to check against. This can be a specific device type, such as InputDevice.SOURCE_TOUCH_NAVIGATION, or a more generic device class, such as InputDevice.SOURCE_CLASS_POINTER.

Returns
boolean Whether the event is from the given source.