SpeechEvent

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

所有已实现的接口:

Sequenceable
```
public class SpeechEvent
extends MultimodalEvent
```
Defines speech events. You can use this class to obtain the speech recognition result.
The system offers the speech recognition capability to recognize user speeches and sends the recognition result to you as an event. This event carries such information as the recognized speech action, hot words.

从以下版本开始:

3

另请参阅:

MultimodalEvent

SystemCapability

SystemCapability.MultimodalInput#MULTIMODAL_INPUT

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

字段概要

字段
限定符和类型	字段	说明
`static int`	`ACTION_HIT_HOTWORD`	Indicates the action of hitting a hot word.
`static int`	`ACTION_SWITCH_OFF`	Indicates the action of setting the switch to the OFF state.
`static int`	`ACTION_SWITCH_ON`	Indicates the action of setting the switch to the ON state.
`static int`	`MATCH_MODE_EXACT`	Indicates the exact match mode.
`static int`	`MATCH_MODE_FUZZY`	Indicates the fuzzy match mode.
`static int`	`SCENES_AUDIO`	Indicates the scene where the action is performed for an audio.
`static int`	`SCENES_COMMON`	Indicates the common scene where voice action is performed.
`static int`	`SCENES_PAGE`	Indicates the scene where the action is performed for a page.
`static int`	`SCENES_SWITCH`	Indicates the scene where the action is performed for a switch.
`static int`	`SCENES_VIDEO`	Indicates the scene where the action is performed for a video.

从类继承的字段 ohos.multimodalinput.event.MultimodalEvent
BUILTIN_KEY, DEFAULT_TYPE, highLevelEvent, KEYBOARD, MOUSE, ROTATION, SPEECH, STYLUS, TOUCH_PANEL, UNSUPPORTED_DEVICE, uuid

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`static Optional<SpeechEvent>`	`createEvent(long occurTime, int action, String value)`	A constructor used to create a `SpeechEvent` instance.
`int`	`getAction()`	Obtains the action of this speech event.
`String`	`getActionProperty()`	Obtains the property value carried in `action`.
`String`	`getDeviceId()`	Obtains the ID of the bearing device for the input device that generates the current event.
`int`	`getInputDeviceId()`	Obtains the ID of the input device that generates the current event.
`int`	`getMatchMode()`	Obtains the match mode for the current recognition result.
`long`	`getOccurredTime()`	Obtains the time when the current event is generated.
`int`	`getScene()`	Obtains the scene where the action is performed.
`int`	`getSourceDevice()`	Obtains the type of the input device that generates the current event.

从类继承的方法 ohos.multimodalinput.event.MultimodalEvent
getUuid, isSameEvent, marshalling, unmarshalling

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

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

- 字段详细资料
  - ACTION_HIT_HOTWORD
```
public static final int ACTION_HIT_HOTWORD
```
    Indicates the action of hitting a hot word.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - ACTION_SWITCH_OFF
```
public static final int ACTION_SWITCH_OFF
```
    Indicates the action of setting the switch to the OFF state.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - ACTION_SWITCH_ON
```
public static final int ACTION_SWITCH_ON
```
    Indicates the action of setting the switch to the ON state.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - MATCH_MODE_EXACT
```
public static final int MATCH_MODE_EXACT
```
    Indicates the exact match mode.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - MATCH_MODE_FUZZY
```
public static final int MATCH_MODE_FUZZY
```
    Indicates the fuzzy match mode.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - SCENES_AUDIO
```
public static final int SCENES_AUDIO
```
    Indicates the scene where the action is performed for an audio.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - SCENES_COMMON
```
public static final int SCENES_COMMON
```
    Indicates the common scene where voice action is performed.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - SCENES_PAGE
```
public static final int SCENES_PAGE
```
    Indicates the scene where the action is performed for a page.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - SCENES_SWITCH
```
public static final int SCENES_SWITCH
```
    Indicates the scene where the action is performed for a switch.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - SCENES_VIDEO
```
public static final int SCENES_VIDEO
```
    Indicates the scene where the action is performed for a video.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - createEvent
```
public static Optional<SpeechEvent> createEvent(long occurTime,
                                                int action,
                                                String value)
```
    A constructor used to create a SpeechEvent instance.
    
    参数:
    
    occurTime - Indicates the time when the event occurs.
    
    action - Indicates the action of the event. The value should be ACTION_SWITCH_ON, ACTION_SWITCH_OFF or ACTION_HIT_HOTWORD.
    
    value - Indicates the property value carried in action.
    
    返回:
    
    Returns the SpeechEvent object. In a valid SpeechEvent object, the SCENE value is SCENES_PAGE and the matchmode value is MATCH_MODE_EXACT.
    
    从以下版本开始:
    
    3
  - getAction
```
public int getAction()
```
    Obtains the action of this speech event.
    
    返回:
    
    Returns the action of this event. The value can be ACTION_SWITCH_ON, ACTION_SWITCH_OFF or ACTION_HIT_HOTWORD.
    
    从以下版本开始:
    
    3
  - getScene
```
public int getScene()
```
    Obtains the scene where the action is performed.
    
    返回:
    
    Returns the scene, which can be SCENES_VIDEO, SCENES_AUDIO, SCENES_PAGE, SCENES_SWITCH or SCENES_COMMON.
    
    从以下版本开始:
    
    3
  - getActionProperty
```
public String getActionProperty()
```
    Obtains the property value carried in action.
    
    返回:
    
    Returns the property value carried in action.
    
    从以下版本开始:
    
    3
  - getMatchMode
```
public int getMatchMode()
```
    Obtains the match mode for the current recognition result.
    
    返回:
    
    Returns the match mode for the current recognition result, which can be MATCH_MODE_EXACT or MATCH_MODE_FUZZY.
    
    从以下版本开始:
    
    3
  - getSourceDevice
```
public int getSourceDevice()
```
    从类复制的说明: MultimodalEvent
    
    Obtains the type of the input device that generates the current event.
    
    指定者:
    
    getSourceDevice 在类中 MultimodalEvent
    
    返回:
    
    Returns the type of the input device that generates the event. The return values are as follows: MultimodalEvent.UNSUPPORTED_DEVICE: no input device. Generally, this is the default value. MultimodalEvent.TOUCH_PANEL: touch panel MultimodalEvent.KEYBOARD: keyboard MultimodalEvent.MOUSE: mouse MultimodalEvent.STYLUS: stylus MultimodalEvent.BUILTIN_KEY: built-in key MultimodalEvent.ROTATION: rotation component MultimodalEvent.SPEECH: speech component
  - getDeviceId
```
public String getDeviceId()
```
    从类复制的说明: MultimodalEvent
    
    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.
    
    指定者:
    
    getDeviceId 在类中 MultimodalEvent
    
    返回:
    
    Returns the ID of the bearing device for the input device that generates the current event; returns null if there is no input device.
    
    另请参阅:
    
    MultimodalEvent.getInputDeviceId()
  - getInputDeviceId
```
public int getInputDeviceId()
```
    从类复制的说明: MultimodalEvent
    
    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.
    
    指定者:
    
    getInputDeviceId 在类中 MultimodalEvent
    
    返回:
    
    Returns the ID of the input device that generates the current event; returns -1 if there is no input device.
    
    另请参阅:
    
    MultimodalEvent.getDeviceId()
  - getOccurredTime
```
public long getOccurredTime()
```
    从类复制的说明: MultimodalEvent
    
    Obtains the time when the current event is generated.
    
    指定者:
    
    getOccurredTime 在类中 MultimodalEvent
    
    返回:
    
    Returns the time (in ms) when the current event is generated.

类 SpeechEvent

嵌套类概要

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

字段概要

从类继承的字段 ohos.multimodalinput.event.MultimodalEvent

方法概要

从类继承的方法 ohos.multimodalinput.event.MultimodalEvent

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

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

字段详细资料

ACTION_HIT_HOTWORD

ACTION_SWITCH_OFF

ACTION_SWITCH_ON

MATCH_MODE_EXACT

MATCH_MODE_FUZZY

SCENES_AUDIO

SCENES_COMMON

SCENES_PAGE

SCENES_SWITCH

SCENES_VIDEO

方法详细资料

createEvent

getAction

getScene

getActionProperty

getMatchMode

getSourceDevice

getDeviceId

getInputDeviceId

getOccurredTime