鴻蒙OS SpeechEvent

SpeechEvent

java.lang.Object

|---ohos.multimodalinput.event.MultimodalEvent

|---|---ohos.multimodalinput.event.SpeechEvent

public class SpeechEvent
extends MultimodalEvent

定義語音事件。 您可以使用該類來獲取語音識別結果。

系統(tǒng)提供語音識別功能來識別用戶語音，并將識別結果作為事件發(fā)送給您。 該事件攜帶識別出的語音動作、熱詞等信息。

Since:

3

嵌套類摘要

從接口 ohos.utils.Sequenceable 繼承的嵌套類/接口
Sequenceable.ProducerT

字段摘要

修飾符和類型	字段	描述
static int	ACTION_HIT_HOTWORD	表示點擊熱詞的動作。
static int	ACTION_SWITCH_OFF	表示將開關設置為 OFF 狀態(tài)的動作。
static int	ACTION_SWITCH_ON	表示將開關設置為 ON 狀態(tài)的動作。
static int	MATCH_MODE_EXACT	表示精確匹配模式。
static int	MATCH_MODE_FUZZY	表示模糊匹配模式。
static int	SCENES_AUDIO	指示對音頻執(zhí)行操作的場景。
static int	SCENES_COMMON	表示執(zhí)行語音操作的常見場景。
static int	SCENES_PAGE	指示對頁面執(zhí)行操作的場景。
static int	SCENES_SWITCH	指示為切換執(zhí)行操作的場景。
static int	SCENES_VIDEO	指示對視頻執(zhí)行操作的場景。

從類 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)	用于創(chuàng)建 SpeechEvent 實例的構造函數(shù)。
int	getAction()	獲取此語音事件的動作。
String	getActionProperty()	獲取action中攜帶的屬性值。
String	getDeviceId()	獲取產(chǎn)生當前事件的輸入設備的承載設備ID。
int	getInputDeviceId()	獲取產(chǎn)生當前事件的輸入設備的ID。
int	getMatchMode()	獲取當前識別結果的匹配模式。
long	getOccurredTime()	獲取當前事件的產(chǎn)生時間。
int	getScene()	獲取執(zhí)行動作的場景。
int	getSourceDevice()	獲取產(chǎn)生當前事件的輸入設備的類型。

從類 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 狀態(tài)的動作。

Since:

3

ACTION_SWITCH_ON

public static final int ACTION_SWITCH_ON

表示將開關設置為 ON 狀態(tài)的動作。表示將開關設置為 ON 狀態(tài)的動作。

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

指示對音頻執(zhí)行操作的場景。

Since:

3

SCENES_COMMON

public static final int SCENES_COMMON

表示執(zhí)行語音操作的常見場景。

Since:

3

SCENES_PAGE

public static final int SCENES_PAGE

指示對頁面執(zhí)行操作的場景。

Since:

3

SCENES_SWITCH

public static final int SCENES_SWITCH

指示為切換執(zhí)行操作的場景。

Since:

3

SCENES_VIDEO

public static final int SCENES_VIDEO

指示對視頻執(zhí)行操作的場景。

Since:

3

方法詳情

createEvent

public static OptionalSpeechEvent createEvent(long occurTime, int action, String value)

用于創(chuàng)建 SpeechEvent 實例的構造函數(shù)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
occurTime	指示事件發(fā)生的時間。
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()

獲取執(zhí)行動作的場景。

返回:

返回場景，可以是 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

獲取產(chǎn)生當前事件的輸入設備的類型。

指定者：

類 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

獲取產(chǎn)生當前事件的輸入設備的承載設備ID。

例如，如果兩個鼠標設備連接到同一個設備，則該設備是兩個鼠標設備的承載設備。

指定者：

類 MultimodalEvent 中的 getDeviceId

返回:

返回產(chǎn)生當前事件的輸入設備的承載設備ID； 如果沒有輸入設備，則返回 null。

getInputDeviceId

public int getInputDeviceId()

從類復制的描述：MultimodalEvent

獲取產(chǎn)生當前事件的輸入設備的ID。

輸入設備由唯一 ID 標識。 例如，當兩個鼠標設備分別產(chǎn)生一個事件時，產(chǎn)生的事件中的設備ID是不同的。 這允許您的應用程序使用設備 ID 來識別實際的輸入設備。

指定者：

類 MultimodalEvent 中的 getInputDeviceId

返回:

返回產(chǎn)生當前事件的輸入設備的 ID； 如果沒有輸入設備，則返回 -1。

getOccurredTime

public long getOccurredTime()

從類復制的描述：MultimodalEvent

獲取當前事件的產(chǎn)生時間。

指定者：

類 MultimodalEvent 中的 getOccurredTime

返回:

返回生成當前事件的時間（以毫秒為單位）。