MultimodalEvent

java.lang.Object
- ohos.multimodalinput.event.MultimodalEvent

所有已实现的接口:

Sequenceable

直接已知子类:

CompositeEvent, KeyEvent, ManipulationEvent, RotationEvent, SpeechEvent
```
public abstract class MultimodalEvent
extends Object
implements Sequenceable
```
Represents the base class of all event types.
This class defines a series of high-level event types that represent abstracted user behaviors or intents. In addition, it defines the methods and information shared by various child classes. If you only want to capture the abstracted behaviors in events, you just need to rewrite the callback interfaces defined in this class. If you want to obtain more information, then you can directly use the methods defined in this class. If the callback and event processing methods for abstracted events cannot meet your needs, you can also convert the events into more specific event types. For example, you can convert MultimodalEvent into KeyboardEvent, so as to obtain more detailed information or use a more direct and simple callback interface.

从以下版本开始:

1

SystemCapability

SystemCapability.MultimodalInput#MULTIMODAL_INPUT

嵌套类概要
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

字段概要

字段
限定符和类型	字段	说明
`static int`	`BUILTIN_KEY`	Indicates a builtin key input event.
`static int`	`DEFAULT_TYPE`	Indicates the default value of the standard high-level event supported by the OS system.
`protected int`	`highLevelEvent`	Indicates a high-level event.
`static int`	`KEYBOARD`	Indicates a keyboard input event.
`static int`	`MOUSE`	Indicates a mouse input event.
`static int`	`ROTATION`	Indicates the event generated by a rotation component.
`static int`	`SPEECH`	Indicates the event generated by Speech component.
`static int`	`STYLUS`	Indicates a stylus input event.
`static int`	`TOUCH_PANEL`	Indicates a touch panel (TP) input event.
`static int`	`UNSUPPORTED_DEVICE`	Indicates that there is no input device.
`protected UUID`	`uuid`	Indicates a globally unique ID that helps distinguish one event from others.

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法	说明
`abstract String`	`getDeviceId()`	Obtains the ID of the bearing device for the input device that generates the current event.
`abstract int`	`getInputDeviceId()`	Obtains the ID of the input device that generates the current event.
`abstract long`	`getOccurredTime()`	Obtains the time when the current event is generated.
`abstract int`	`getSourceDevice()`	Obtains the type of the input device that generates the current event.
`UUID`	`getUuid()`	Obtains the UUID of the event.
`boolean`	`isSameEvent(UUID id)`	Checks whether the current event is the same as the event with the specified UUID.
`boolean`	`marshalling(Parcel parcel)`	Marshals this `Sequenceable` object into a `Parcel`.
`boolean`	`unmarshalling(Parcel parcel)`	Unmarshals this `Sequenceable` object from a `Parcel`.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 字段详细资料
  - BUILTIN_KEY
```
public static final int BUILTIN_KEY
```
    Indicates a builtin key input event.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - DEFAULT_TYPE
```
public static final int DEFAULT_TYPE
```
    Indicates the default value of the standard high-level event supported by the OS system.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - KEYBOARD
```
public static final int KEYBOARD
```
    Indicates a keyboard input event.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - MOUSE
```
public static final int MOUSE
```
    Indicates a mouse input event.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - ROTATION
```
public static final int ROTATION
```
    Indicates the event generated by a rotation component.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - SPEECH
```
public static final int SPEECH
```
    Indicates the event generated by Speech component.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - STYLUS
```
public static final int STYLUS
```
    Indicates a stylus input event.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - TOUCH_PANEL
```
public static final int TOUCH_PANEL
```
    Indicates a touch panel (TP) input event.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - UNSUPPORTED_DEVICE
```
public static final int UNSUPPORTED_DEVICE
```
    Indicates that there is no input device. It is usually used as the default value.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - highLevelEvent
```
protected int highLevelEvent
```
    Indicates a high-level event. This field needs to be set only if the event of a class that extends MultimodalEvent can be converted to a high-level event.
    
    从以下版本开始:
    
    1
  - uuid
```
protected final UUID uuid
```
    Indicates a globally unique ID that helps distinguish one event from others. For details, see isSameEvent(java.util.UUID).
    
    从以下版本开始:
    
    1
- 方法详细资料
  - isSameEvent
```
public boolean isSameEvent(UUID id)
```
    Checks whether the current event is the same as the event with the specified UUID.
    
    参数:
    
    id - Specifies UUID of the event to be checked.
    
    返回:
    
    Returns true if the current event is the same as the event with the specified UUID; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getSourceDevice
```
public abstract int getSourceDevice()
```
    Obtains the type of the input device that generates the current event.
    
    返回:
    
    Returns the type of the input device that generates the event. The return values are as follows: UNSUPPORTED_DEVICE: no input device. Generally, this is the default value. TOUCH_PANEL: touch panel KEYBOARD: keyboard MOUSE: mouse STYLUS: stylus BUILTIN_KEY: built-in key ROTATION: rotation component SPEECH: speech component
    
    从以下版本开始:
    
    3
  - getDeviceId
```
public abstract String getDeviceId()
```
    Obtains the ID of the bearing device for the input device that generates the current event.
    For example, if two mouse devices are connected to the same device, this device is the bearing device of the two mouse devices.
    
    返回:
    
    Returns the ID of the bearing device for the input device that generates the current event; returns null if there is no input device.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    getInputDeviceId()
  - getInputDeviceId
```
public abstract int getInputDeviceId()
```
    Obtains the ID of the input device that generates the current event.
    An input device is identified by a unique ID. For example, when two mouse devices generate an event respectively, the device ID in the generated events are different. This allows your application to use the device ID to identify the actual input device.
    
    返回:
    
    Returns the ID of the input device that generates the current event; returns -1 if there is no input device.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    getDeviceId()
  - getOccurredTime
```
public abstract long getOccurredTime()
```
    Obtains the time when the current event is generated.
    
    返回:
    
    Returns the time (in ms) when the current event is generated.
    
    从以下版本开始:
    
    1
  - getUuid
```
public UUID getUuid()
```
    Obtains the UUID of the event.
    
    返回:
    
    Returns the UUID of the event.
    
    从以下版本开始:
    
    1
  - marshalling
```
public boolean marshalling(Parcel parcel)
```
    从接口复制的说明: Sequenceable
    
    Marshals this Sequenceable object into a Parcel.
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    parcel - Indicates the Parcel object to which the Sequenceable object will be marshaled..
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
  - unmarshalling
```
public boolean unmarshalling(Parcel parcel)
```
    从接口复制的说明: Sequenceable
    
    Unmarshals this Sequenceable object from a Parcel.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    parcel - Indicates the Parcel object into which the Sequenceable object has been marshaled.
    
    返回:
    
    Returns true if the unmarshalling is successful; returns false otherwise.

类 MultimodalEvent

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

字段概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 ohos.utils.Sequenceable

字段详细资料

BUILTIN_KEY

DEFAULT_TYPE

KEYBOARD

MOUSE

ROTATION

SPEECH

STYLUS

TOUCH_PANEL

UNSUPPORTED_DEVICE

highLevelEvent

uuid

方法详细资料

isSameEvent

getSourceDevice

getDeviceId

getInputDeviceId

getOccurredTime

getUuid

marshalling

unmarshalling