SpeechEvent
java.lang.Object
|—ohos.multimodalinput.event.MultimodalEvent
|—|—ohos.multimodalinput.event.SpeechEvent
public class SpeechEvent
extends MultimodalEvent
定义语音事件。 您可以使用该类来获取语音识别结果。
系统提供语音识别功能来识别用户语音,并将识别结果作为事件发送给您。 该事件携带识别出的语音动作、热词等信息。
Since:
3
嵌套类摘要
从接口 ohos.utils.Sequenceable 继承的嵌套类/接口 |
---|
Sequenceable.ProducerT |
字段摘要
修饰符和类型 | 字段 | 描述 |
---|---|---|
static int | ACTION_HIT_HOTWORD | 表示点击热词的动作。 |
static int | ACTION_SWITCH_OFF | 表示将开关设置为 OFF 状态的动作。 |
static int | ACTION_SWITCH_ON | 表示将开关设置为 ON 状态的动作。 |
static int | MATCH_MODE_EXACT | 表示精确匹配模式。 |
static int | MATCH_MODE_FUZZY | 表示模糊匹配模式。 |
static int | SCENES_AUDIO | 指示对音频执行操作的场景。 |
static int | SCENES_COMMON | 表示执行语音操作的常见场景。 |
static int | SCENES_PAGE | 指示对页面执行操作的场景。 |
static int | SCENES_SWITCH | 指示为切换执行操作的场景。 |
static int | SCENES_VIDEO | 指示对视频执行操作的场景。 |
从类 ohos.multimodalinput.event.MultimodalEvent 继承的字段 |
---|
BUILTIN_KEY, DEFAULT_TYPE, highLevelEvent, KEYBOARD, MOUSE, ROTATION, SPEECH, STYLUS, TOUCH_PANEL, UNSUPPORTED_DEVICE, uuid |
方法总结
修饰符和类型 | 方法 | 描述 |
---|---|---|
static OptionalSpeechEvent | createEvent(long occurTime, int action, String value) | 用于创建 SpeechEvent 实例的构造函数。 |
int | getAction() | 获取此语音事件的动作。 |
String | getActionProperty() | 获取action中携带的属性值。 |
String | getDeviceId() | 获取产生当前事件的输入设备的承载设备ID。 |
int | getInputDeviceId() | 获取产生当前事件的输入设备的ID。 |
int | getMatchMode() | 获取当前识别结果的匹配模式。 |
long | getOccurredTime() | 获取当前事件的产生时间。 |
int | getScene() | 获取执行动作的场景。 |
int | getSourceDevice() | 获取产生当前事件的输入设备的类型。 |
从类 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
表示点击热词的动作。
Since:
3
ACTION_SWITCH_OFF
public static final int ACTION_SWITCH_OFF
表示将开关设置为 OFF 状态的动作。
Since:
3
ACTION_SWITCH_ON
public static final int ACTION_SWITCH_ON
表示将开关设置为 ON 状态的动作。表示将开关设置为 ON 状态的动作。
Since:
3
MATCH_MODE_EXACT
public static final int MATCH_MODE_EXACT
表示精确匹配模式。
Since:
3
MATCH_MODE_FUZZY
public static final int MATCH_MODE_FUZZY
表示模糊匹配模式。
Since:
3
SCENES_AUDIO
public static final int SCENES_AUDIO
指示对音频执行操作的场景。
Since:
3
SCENES_COMMON
public static final int SCENES_COMMON
表示执行语音操作的常见场景。
Since:
3
SCENES_PAGE
public static final int SCENES_PAGE
指示对页面执行操作的场景。
Since:
3
SCENES_SWITCH
public static final int SCENES_SWITCH
指示为切换执行操作的场景。
Since:
3
SCENES_VIDEO
public static final int SCENES_VIDEO
指示对视频执行操作的场景。
Since:
3
方法详情
createEvent
public static OptionalSpeechEvent createEvent(long occurTime, int action, String value)
用于创建 SpeechEvent 实例的构造函数。
参数:
参数名称 | 参数描述 |
---|---|
occurTime | 指示事件发生的时间。 |
action | 表示事件的动作。 该值应为 ACTION_SWITCH_ON、ACTION_SWITCH_OFF 或 ACTION_HIT_HOTWORD。 |
value | 表示动作中携带的属性值。 |
返回:
返回 SpeechEvent 对象。 在有效的 SpeechEvent 对象中,SCENE 值为 SCENES_PAGE,matchmode 值为 MATCH_MODE_EXACT。
Since:
3
getAction
public int getAction()
获取此语音事件的动作。
返回:
返回此事件的操作。 该值可以是 ACTION_SWITCH_ON、ACTION_SWITCH_OFF 或 ACTION_HIT_HOTWORD。
Since:
3
getScene
public int getScene()
获取执行动作的场景。
返回:
返回场景,可以是 SCENES_VIDEO、SCENES_AUDIO、SCENES_PAGE、SCENES_SWITCH 或 SCENES_COMMON。
Since:
3
getActionProperty
public String getActionProperty()
获取action中携带的属性值。
返回:
返回action中携带的属性值。
Since:
3
getMatchMode
public int getMatchMode()
获取当前识别结果的匹配模式。
返回:
返回当前识别结果的匹配模式,可以是 MATCH_MODE_EXACT 或 MATCH_MODE_FUZZY。
Since:
3
getSourceDevice
public int getSourceDevice()
从类复制的描述:MultimodalEvent
获取产生当前事件的输入设备的类型。
指定者:
类 MultimodalEvent 中的 getSourceDevice
返回:
返回生成事件的输入设备的类型。 返回值如下: MultimodalEvent.UNSUPPORTED_DEVICE:无输入设备。 通常,这是默认值。 MultimodalEvent.TOUCH_PANEL:触控面板 MultimodalEvent.KEYBOARD:键盘 MultimodalEvent.MOUSE:鼠标 MultimodalEvent.STYLUS:手写笔 MultimodalEvent.BUILTIN_KEY:内置按键 MultimodalEvent.ROTATION:旋转组件 MultimodalEvent.SPEECH:语音组件
getDeviceId
public String getDeviceId()
从类复制的描述:MultimodalEvent
获取产生当前事件的输入设备的承载设备ID。
例如,如果两个鼠标设备连接到同一个设备,则该设备是两个鼠标设备的承载设备。
指定者:
类 MultimodalEvent 中的 getDeviceId
返回:
返回产生当前事件的输入设备的承载设备ID; 如果没有输入设备,则返回 null。
getInputDeviceId
public int getInputDeviceId()
从类复制的描述:MultimodalEvent
获取产生当前事件的输入设备的ID。
输入设备由唯一 ID 标识。 例如,当两个鼠标设备分别产生一个事件时,产生的事件中的设备ID是不同的。 这允许您的应用程序使用设备 ID 来识别实际的输入设备。
指定者:
类 MultimodalEvent 中的 getInputDeviceId
返回:
返回产生当前事件的输入设备的 ID; 如果没有输入设备,则返回 -1。
getOccurredTime
public long getOccurredTime()
从类复制的描述:MultimodalEvent
获取当前事件的产生时间。
指定者:
类 MultimodalEvent 中的 getOccurredTime
返回:
返回生成当前事件的时间(以毫秒为单位)。