类 WakeupEngine
- java.lang.Object
-
- com.aispeech.dui.dds.agent.wakeup.WakeupEngine
-
public class WakeupEngine extends java.lang.Object
Created by nemo on 18-1-9.
-
-
构造器概要
构造器 限定符 构造器 说明 protectedWakeupEngine(java.lang.String lBridgeAddr)
-
方法概要
所有方法 静态方法 实例方法 具体方法 已过时的方法 修饰符和类型 方法 说明 voidaddCommandWakeupWord(WakeupWord wakeupWord)添加一条命令唤醒词,且不会覆盖之前的命令唤醒词voidaddCommandWakeupWord(java.lang.String[] actions, java.lang.String[] words, java.lang.String[] pinyin, java.lang.String[] threshold, java.lang.String[][] greetings)已过时。voidaddCommandWakeupWords(java.util.List<WakeupWord> wakeupWordList)添加多条命令唤醒词,且不会覆盖之前的命令唤醒词voidaddMainWakeupWord(WakeupWord wakeupWord)添加一条主唤醒词voidaddMainWakeupWord(java.lang.String[] words, java.lang.String[] pinyin, java.lang.String[] threshold, java.lang.String[][] greetings)已过时。voidaddMainWakeupWords(java.util.List<WakeupWord> wakeupWordList)添加多条主唤醒词voidaddQuickStartWords(java.util.List<WakeupWord> wakeupWordList)添加多条QuickStart词 QuickStart词为类似“导航去”、“我想听”等,此类唤醒词只在oneshot模式下生效, 作用为在未唤醒状态下语音输入“导航去天安门”,可直接进入对话流程。voidaddShortcutWakeupWord(WakeupWord wakeupWord)添加一条新的打断唤醒词,且不会覆盖之前的唤醒词voidaddShortcutWakeupWord(java.lang.String[] words, java.lang.String[] pinyin, java.lang.String[] threshold)已过时。voidaddShortcutWakeupWords(java.util.List<WakeupWord> wakeupWordList)添加多条新的打断唤醒词,且不会覆盖之前的唤醒词voidcatchWakeupResult(boolean isCatch)拦截唤醒结果 wakeup.result,voidclearCommandWakeupWord()清空命令唤醒词的接口voidclearIncrementCommandWakeupWord()清空本地热词命令唤醒词的接口voidclearIncrementShortCutWakeupWord()清空本地热词打断唤醒词的接口voidclearIncrementWakeupWord()移除所有本地热词voidclearMainWakeupWord()清空主唤醒词的接口voidclearQuickStartWords()清空QuickStart词的接口voidclearShortCutWakeupWord()清空打断唤醒词的接口voiddestroy()voiddisableCommandWakeupWord()设置快捷命令唤醒词不可唤醒voiddisableHotwordOutOfDialog(boolean disable)已过时。voiddisableIncrementWakeup()设置可见即可说不可用voiddisableIncrementWakeup(org.json.JSONObject inputObj)设置可见即可说不可用 inputObj : {"type":"all"} type: all:所有 hotWord:可见即可说词 globalWord:全局免唤醒词voiddisableIncrementWakeupPriority()关闭本地热词分级功能voiddisableIncrementWakeupWordPriority(java.lang.String priority)关闭本地热词分级功能voiddisableMainWakeupWord()设置主唤醒词不可唤醒voiddisableMinorWakeupWord()设置副唤醒词不可唤醒voiddisableOneShot()关闭oneshotvoiddisableQuickStartWakeupWord()设置QuickStart唤醒词不可唤醒voiddisableShortCutWakeupWord()设置打断唤醒词不可唤醒voiddisableWakeup()关闭唤醒voiddisableWakeupWhenAsr()不允许识别过程中响应唤醒voidenableCommandWakeupWord()设置快捷命令唤醒词可唤醒,默认开启 (在已经调用enableWakeup的情况下临时使用, disableWakeup情况下无效)voidenableGlobalWakeup(boolean enable)是否开启全局免唤醒功能voidenableIncrementWakeup()设置可见即可说可用voidenableIncrementWakeup(org.json.JSONObject inputObj)设置可见即可说可用 inputObj : {"type":"all"} type: all 所有 hotWord 可见即可说词 globalWord 全局免唤醒词voidenableIncrementWakeupPriority()关闭本地热词分级功能voidenableIncrementWakeupWordPriority(java.lang.String priority)开启本地热词分级功能voidenableMainWakeupWord()设置主唤醒词可唤醒,默认开启 (在已经调用enableWakeup的情况下临时使用, disableWakeup情况下无效)voidenableMinorWakeupWord()设置副唤醒词可唤醒,默认开启 (在已经调用enableWakeup的情况下临时使用, disableWakeup情况下无效)voidenableNearWakeup(boolean enable)已过时。voidenableOneShot()开启oneshotvoidenableQuickStartWakeupWord()设置QuickStart唤醒词可唤醒,默认开启 (在已经调用enableWakeup的情况下临时使用, disableWakeup情况下无效)voidenableShortCutWakeupWord()设置打断唤醒词可唤醒,默认开启 (在已经调用enableWakeup的情况下临时使用, disableWakeup情况下无效)voidenableWakeup()开启唤醒voidenableWakeupWhenAsr()允许识别过程中响应唤醒voidenableWakeupWhenAsr(boolean enable)是否允许识别过程中响应唤醒static WakeupEnginegetInstance()static WakeupEnginegetInstance(java.lang.String lBridgeAddr)获取WakeupEnginestatic WakeupEnginegetInstanceSnapshot()获取 WakeupEngine 实例快照java.util.List<WakeupWord>getMainWakeupWords()获取主唤醒词列表,默认返回WakeupEngine所设置的主唤醒词,如果没有设置过则返回产品配置的主唤醒词。java.lang.StringgetMinorWakeupWord()获取当前的副唤醒词booleangetOneshotState()获取当前oneshot开关状态,如果有本地接口调用开关,以本地接口调用优先。java.lang.StringgetWakeupVersion()获取当前唤醒库版本号java.lang.String[]getWakeupWords()获取当前的唤醒词voidnotifyNearWakeupNetworkChange(java.lang.String ipAddress, org.json.JSONObject otherParams)设置就近唤醒网络变化 仅在就近唤醒状态下生效(线双麦/线四麦)voidremoveCommandWakeupWord(WakeupWord wakeupWord)移除一条指定的命令唤醒词voidremoveCommandWakeupWord(java.lang.String[] words)已过时。voidremoveCommandWakeupWords(java.util.List<WakeupWord> wakeupWordList)移除一条指定的命令唤醒词voidremoveMainWakeupWord(WakeupWord wakeupWord)移除一条指定的主唤醒词voidremoveMainWakeupWord(java.lang.String[] words)已过时。voidremoveMainWakeupWords(java.util.List<WakeupWord> wakeupWordList)移除多条指定的主唤醒词voidremoveQuickStartWord(WakeupWord wakeupWord)移除一条指定的QuickStart词voidremoveQuickStartWords(java.util.List<WakeupWord> wakeupWordList)移除多条指定的QuickStart词voidremoveShortcutWakeupWord(WakeupWord wakeupWord)移除一条指定的打断唤醒词voidremoveShortcutWakeupWord(java.lang.String[] words)已过时。voidremoveShortcutWakeupWords(java.util.List<WakeupWord> wakeupWordList)移除多条指定的打断唤醒词voidsetAudioRecordEnable(boolean enable)设置录音机是否可用 true 录音机可用,但真正打开录音还需依赖功能打开。voidsetBfListener(BfListener listener)设置Beamforming监听器, 时时回调Beamforming音频voidsetDriveDoaManually(int doaManually)在定位模式或者全车模式下,手动设置为主驾唤醒或者副驾唤醒voidsetIncrementPriority(WakeupPriorityType type)如果可见即可说和全局免唤醒词有相同的词,设置哪一个优先响应, 默认可见即可说优先voidsetLpSwitch(boolean mode)已过时。voidsetNearWakeupParams(org.json.JSONObject paramsObj)已过时。voidsetOnSplitChannelAudioCallback(com.aispeech.libcomm.callback.OnSplitChannelAudioCallback callback)设置回调,可以回调信号处理后的各路音频voidsetResBin(java.lang.String sspeBinPath, java.lang.String wakeupBinPath, boolean backRowRestrainEnable)更新 sspe(前端信号处理) 与 wakeup(唤醒) 资源voidsetVoipListener(VoipListener listener)设置voip监听器, 时时回调voip音频voidsetWakeupCallback(WakeupCallback wakeupCallback)设置自定义欢迎语的回调voidsetWakeupChannelMask(int wakeupChannelMask)设置可唤醒路数掩码voidsetWakeupDoa(int doa)修改唤醒增强角度voidsetWakeupMode(int mode)修改驾驶模式voidsetWakeupPriority(WakeupPriorityType type, boolean priority)已过时。voidsetWakeupSwitch(boolean mode)设置是唤醒模块的模式(信号处理不变,环麦中暂不支持)voidupdateCommandWakeupWord(WakeupWord wakeupWord)更新一条命令唤醒词的接口,这类唤醒词会在唤醒之后执行一条指令,不能打断正在播报的语音voidupdateCommandWakeupWord(java.lang.String[] actions, java.lang.String[] words, java.lang.String[] pinyin, java.lang.String[] threshold, java.lang.String[][] greetings)已过时。voidupdateCommandWakeupWords(java.util.List<WakeupWord> wakeupWordList)更新多条命令唤醒词的接口,这类唤醒词会在唤醒之后执行一条指令,不能打断正在播报的语音voidupdateHotWords(HotWords hotWords)更新热词voidupdateIncrementWakeupBlackWords(java.util.List<java.lang.String> blackWordList)更新黑名单词库,覆盖式更新,如需要清除则传nullvoidupdateMainWakeupWords(java.util.List<WakeupWord> wakeupWordList)更新多条主唤醒词的接口,覆盖原有的主唤醒词voidupdateMinorWakeupWord(WakeupWord wakeupWord)更新副唤醒词的接口voidupdateMinorWakeupWord(java.lang.String word, java.lang.String pinyin, java.lang.String threshold, java.lang.String[] greetings)已过时。voidupdateQuickStartWords(java.util.List<WakeupWord> wakeupWordList)更新多条QuickStart词的接口,覆盖原有的QuickStart词voidupdateShortcutWakeupWord(WakeupWord wakeupWord)更新一条打断唤醒词的接口,这类唤醒词能打断正在播报的语音并且将唤醒词送入识别voidupdateShortcutWakeupWord(java.lang.String[] words, java.lang.String[] pinyin, java.lang.String[] threshold)已过时。voidupdateShortcutWakeupWords(java.util.List<WakeupWord> wakeupWordList)更新多条打断唤醒词的接口,这类唤醒词能打断正在播报的语音并且将唤醒词送入识别voidupdateWakeupWords(java.util.List<WakeupWordIntent> intents)更新唤醒词,合并请求voidupdateWkupRouter(java.lang.String type)动态设置对话模式voiduseAsrPPInWakeUp(boolean enable)动态设置是否在唤醒中启用AsrppvoiduseVprintInWakeUp(boolean enable)动态设置是否在唤醒中启用声纹
-
-
-
构造器详细资料
-
WakeupEngine
protected WakeupEngine(java.lang.String lBridgeAddr)
-
-
方法详细资料
-
getInstance
public static WakeupEngine getInstance()
-
setWakeupCallback
public void setWakeupCallback(WakeupCallback wakeupCallback)
设置自定义欢迎语的回调- 参数:
wakeupCallback- 自定义唤醒的回调
-
setOnSplitChannelAudioCallback
public void setOnSplitChannelAudioCallback(com.aispeech.libcomm.callback.OnSplitChannelAudioCallback callback)
设置回调,可以回调信号处理后的各路音频- 参数:
callback- 回调
-
setVoipListener
public void setVoipListener(VoipListener listener) throws DDSNotInitCompleteException
设置voip监听器, 时时回调voip音频- 参数:
listener-- 抛出:
DDSNotInitCompleteException
-
setBfListener
public void setBfListener(BfListener listener) throws DDSNotInitCompleteException
设置Beamforming监听器, 时时回调Beamforming音频- 参数:
listener-- 抛出:
DDSNotInitCompleteException
-
getInstance
public static WakeupEngine getInstance(java.lang.String lBridgeAddr)
获取WakeupEngine- 参数:
lBridgeAddr- 指定busserver地址- 返回:
- WakeupEngine实例
-
getInstanceSnapshot
public static WakeupEngine getInstanceSnapshot()
获取 WakeupEngine 实例快照- 返回:
- WakeupEngine
-
setWakeupDoa
public void setWakeupDoa(int doa) throws DDSNotInitCompleteException
修改唤醒增强角度- 参数:
doa- 角度- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
setWakeupMode
public void setWakeupMode(int mode) throws DDSNotInitCompleteException
修改驾驶模式如果需要支持音区控制,请每次更新唤醒模式后,再次同步音区配置信息
DDS.getInstance().getAgent().getWakeupEngine().setWakeupChannelMask(0b0100)- 参数:
mode- 驾驶模式, 0:定位模式, 1:主驾模式, 2: 副驾模式 3:全车模式- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
setDriveDoaManually
public void setDriveDoaManually(int doaManually) throws DDSNotInitCompleteException
在定位模式或者全车模式下,手动设置为主驾唤醒或者副驾唤醒- 参数:
doaManually- 1为主驾唤醒; 2为副驾唤醒;- 抛出:
DDSNotInitCompleteException
-
setResBin
public void setResBin(java.lang.String sspeBinPath, java.lang.String wakeupBinPath, boolean backRowRestrainEnable) throws DDSNotInitCompleteException
更新 sspe(前端信号处理) 与 wakeup(唤醒) 资源- 参数:
sspeBinPath- sspe资源wakeupBinPath- 唤醒资源backRowRestrainEnable- 后排抑制开关,true:开启、false:关闭- 抛出:
DDSNotInitCompleteException
-
setWakeupChannelMask
public void setWakeupChannelMask(int wakeupChannelMask) throws DDSNotInitCompleteException
设置可唤醒路数掩码4麦有4位二进制表示对应的路数是否可以唤醒,最低位表示第1路。 比如设置 wakeupChannelMask 为 3(0011) 表示第1路和第2路唤醒
只有使用 dmasp 算法的多麦唤醒配置才有效
设置只有第3路可用的代码示例:
DDS.getInstance().getAgent().getWakeupEngine().setWakeupChannelMask(0b0100)- 参数:
wakeupChannelMask- 可唤醒路数掩码- 抛出:
DDSNotInitCompleteException
-
addMainWakeupWord
@Deprecated public void addMainWakeupWord(java.lang.String[] words, java.lang.String[] pinyin, java.lang.String[] threshold, java.lang.String[][] greetings) throws DDSNotInitCompleteException
已过时。添加主唤醒词的接口支持添加多个主唤醒词,调用此接口会覆盖控制台配置的主唤醒词,直到通过removeMainWakeupWord接口移除。
- 参数:
words- 主唤醒词,不为nullpinyin- 主唤醒词的拼音,不为nullthreshold- 主唤醒词的阈值,不为nullgreetings- 主唤醒词的欢迎语,不为null;如果某个唤醒词不想要欢迎语,在对应的维度设为null- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
addMainWakeupWord
public void addMainWakeupWord(WakeupWord wakeupWord) throws DDSNotInitCompleteException
添加一条主唤醒词调用此接口会覆盖控制台配置的主唤醒词,直到通过removeMainWakeupWord接口移除。
- 参数:
wakeupWord- 唤醒词业对象必填参数:
word: 唤醒词的汉字
pinyin: 唤醒词的拼音
threshold: 唤醒词的阈值
选填参数:
greeting: 唤醒词的欢迎语, 若不设置,则与主唤醒词保持一致
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
addMainWakeupWords
public void addMainWakeupWords(java.util.List<WakeupWord> wakeupWordList) throws DDSNotInitCompleteException
添加多条主唤醒词调用此接口会覆盖控制台配置的主唤醒词,直到通过removeMainWakeupWord接口移除。
- 参数:
wakeupWordList- 唤醒词业对象集合必填参数:
word: 唤醒词的汉字
pinyin: 唤醒词的拼音
threshold: 唤醒词的阈值
选填参数:
greeting: 唤醒词的欢迎语, 若不设置,则与主唤醒词保持一致
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
removeMainWakeupWord
@Deprecated public void removeMainWakeupWord(java.lang.String[] words) throws DDSNotInitCompleteException
已过时。移除指定的主唤醒词如果移除了所有通过addMainWakeupWord接口添加的主唤醒词,则主唤醒词重置为控制台所配置的
- 参数:
words- 主唤醒词的汉字(必须)- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
enableIncrementWakeupPriority
public void enableIncrementWakeupPriority() throws DDSNotInitCompleteException
关闭本地热词分级功能
-
updateIncrementWakeupBlackWords
public void updateIncrementWakeupBlackWords(java.util.List<java.lang.String> blackWordList) throws DDSNotInitCompleteException
更新黑名单词库,覆盖式更新,如需要清除则传null
-
disableIncrementWakeupPriority
public void disableIncrementWakeupPriority() throws DDSNotInitCompleteException
关闭本地热词分级功能
-
enableIncrementWakeupWordPriority
public void enableIncrementWakeupWordPriority(java.lang.String priority) throws DDSNotInitCompleteException
开启本地热词分级功能
-
disableIncrementWakeupWordPriority
public void disableIncrementWakeupWordPriority(java.lang.String priority) throws DDSNotInitCompleteException
关闭本地热词分级功能
-
clearIncrementCommandWakeupWord
public void clearIncrementCommandWakeupWord() throws DDSNotInitCompleteException
清空本地热词命令唤醒词的接口
-
clearIncrementShortCutWakeupWord
public void clearIncrementShortCutWakeupWord() throws DDSNotInitCompleteException
清空本地热词打断唤醒词的接口
-
clearIncrementWakeupWord
public void clearIncrementWakeupWord() throws DDSNotInitCompleteException
移除所有本地热词- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
removeMainWakeupWord
public void removeMainWakeupWord(WakeupWord wakeupWord) throws DDSNotInitCompleteException
移除一条指定的主唤醒词如果移除了所有通过addMainWakeupWord接口添加的主唤醒词,则主唤醒词重置为控制台所配置的
- 参数:
wakeupWord- 唤醒词的对象必填参数:
word: 唤醒词的汉字
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
removeMainWakeupWords
public void removeMainWakeupWords(java.util.List<WakeupWord> wakeupWordList) throws DDSNotInitCompleteException
移除多条指定的主唤醒词如果移除了所有通过addMainWakeupWord接口添加的主唤醒词,则主唤醒词重置为控制台所配置的
- 参数:
wakeupWordList- 唤醒词的对象集合必填参数:
word: 唤醒词的汉字
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
updateMainWakeupWords
public void updateMainWakeupWords(java.util.List<WakeupWord> wakeupWordList) throws DDSNotInitCompleteException
更新多条主唤醒词的接口,覆盖原有的主唤醒词支持设置多个主唤醒词,所以参数为数组,重复调用会以最新的主唤醒词数组为准。
- 参数:
wakeupWordList- 唤醒词对象集合必填参数:
word: 唤醒词的汉字
pinyin: 唤醒词的拼音
threshold: 唤醒词的阈值
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
clearMainWakeupWord
public void clearMainWakeupWord() throws DDSNotInitCompleteException
清空主唤醒词的接口- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
updateMinorWakeupWord
@Deprecated public void updateMinorWakeupWord(java.lang.String word, java.lang.String pinyin, java.lang.String threshold, java.lang.String[] greetings) throws DDSNotInitCompleteException
已过时。更新副唤醒词的接口支持设置一个副唤醒词,重复调用会以最新的副唤醒词为准
- 参数:
word- 副唤醒词, 若设置null,则清空当前的副唤醒词pinyin- 副唤醒词的拼音threshold- 副唤醒词的阈值, 若设置null,则自动估算greetings- 副唤醒词的欢迎语, 若设置null,则与主唤醒词保持一致- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
updateMinorWakeupWord
public void updateMinorWakeupWord(WakeupWord wakeupWord) throws DDSNotInitCompleteException
更新副唤醒词的接口支持设置一个副唤醒词,重复调用会以最新的副唤醒词为准
- 参数:
wakeupWord- 唤醒词对象选填参数:
word: 唤醒词的汉字, 若不设置,则清空当前的副唤醒词
pinyin: 唤醒词的拼音, 若不设置,则清空当前的副唤醒词
threshold: 唤醒词的阈值, 若不设置,则自动估算
greeting: 唤醒词的欢迎语, 若不设置,则与主唤醒词保持一致
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
getMinorWakeupWord
public java.lang.String getMinorWakeupWord() throws DDSNotInitCompleteException
获取当前的副唤醒词- 返回:
- String 副唤醒词, 若无则返回null
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
updateCommandWakeupWord
@Deprecated public void updateCommandWakeupWord(java.lang.String[] actions, java.lang.String[] words, java.lang.String[] pinyin, java.lang.String[] threshold, java.lang.String[][] greetings) throws DDSNotInitCompleteException
已过时。更新命令唤醒词的接口,这类唤醒词会在唤醒之后执行一条指令,不能打断正在播报的语音支持设置多个命令唤醒词,所以参数为数组,重复调用会以最新的命令唤醒词数组为准。
- 参数:
actions- 命令唤醒词对应的command命令(必须)words- 命令唤醒词的汉字(必须)pinyin- 命令唤醒词的拼音(必须)threshold- 命令唤醒词的阈值(必须greetings- 命令唤醒词对应的唤醒语,一个唤醒词可以设置多条欢迎语,所以参数为二维数组,如果想要某个唤醒词不要欢迎语,那么该第二维数组的string可以设置为空字符串""- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
updateCommandWakeupWord
public void updateCommandWakeupWord(WakeupWord wakeupWord) throws DDSNotInitCompleteException
更新一条命令唤醒词的接口,这类唤醒词会在唤醒之后执行一条指令,不能打断正在播报的语音支持设置多个命令唤醒词,所以参数为数组,重复调用会以最新的命令唤醒词数组为准。
- 参数:
wakeupWord- 唤醒词对象必填参数:
action: 唤醒词对应的command命令
word: 唤醒词的汉字
pinyin: 唤醒词的拼音
threshold: 唤醒词的阈值
选填参数:
greeting: 唤醒词对应的欢迎语,一个唤醒词可以设置多条欢迎语
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
updateCommandWakeupWords
public void updateCommandWakeupWords(java.util.List<WakeupWord> wakeupWordList) throws DDSNotInitCompleteException
更新多条命令唤醒词的接口,这类唤醒词会在唤醒之后执行一条指令,不能打断正在播报的语音支持设置多个命令唤醒词,所以参数为数组,重复调用会以最新的命令唤醒词数组为准。
- 参数:
wakeupWordList- 唤醒词对象集合必填参数:
action: 唤醒词对应的command命令
word: 唤醒词的汉字
pinyin: 唤醒词的拼音
threshold: 唤醒词的阈值
选填参数:
greeting: 唤醒词对应的欢迎语,一个唤醒词可以设置多条欢迎语
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
addCommandWakeupWord
@Deprecated public void addCommandWakeupWord(java.lang.String[] actions, java.lang.String[] words, java.lang.String[] pinyin, java.lang.String[] threshold, java.lang.String[][] greetings) throws DDSNotInitCompleteException
已过时。添加命令唤醒词,且不会覆盖之前的命令唤醒词- 参数:
actions- 命令唤醒词对应的command命令(必须)words- 命令唤醒词的汉字(必须)pinyin- 命令唤醒词的拼音(必须)threshold- 命令唤醒词的阈值(必须greetings- 命令唤醒词对应的唤醒语,一个唤醒词可以设置多条欢迎语,所以参数为二维数组,如果想要某个唤醒词不要欢迎语,那么该第二维数组的string可以设置为空字符串""- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
addCommandWakeupWord
public void addCommandWakeupWord(WakeupWord wakeupWord) throws DDSNotInitCompleteException
添加一条命令唤醒词,且不会覆盖之前的命令唤醒词- 参数:
wakeupWord- 唤醒词对象必填参数:
action: 唤醒词对应的command命令
word: 唤醒词的汉字
pinyin: 唤醒词的拼音
threshold: 唤醒词的阈值
选填参数:
greeting: 唤醒词对应的欢迎语,一个唤醒词可以设置多条欢迎语
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
addCommandWakeupWords
public void addCommandWakeupWords(java.util.List<WakeupWord> wakeupWordList) throws DDSNotInitCompleteException
添加多条命令唤醒词,且不会覆盖之前的命令唤醒词- 参数:
wakeupWordList- 唤醒词对象集合必填参数:
action: 唤醒词对应的command命令
word: 唤醒词的汉字
pinyin: 唤醒词的拼音
threshold: 唤醒词的阈值
选填参数:
greeting: 唤醒词对应的欢迎语,一个唤醒词可以设置多条欢迎语
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
removeCommandWakeupWord
@Deprecated public void removeCommandWakeupWord(java.lang.String[] words) throws DDSNotInitCompleteException
已过时。移除指定的命令唤醒词- 参数:
words- 命令唤醒词的汉字(必须)- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
removeCommandWakeupWord
public void removeCommandWakeupWord(WakeupWord wakeupWord) throws DDSNotInitCompleteException
移除一条指定的命令唤醒词- 参数:
wakeupWord- 唤醒词对象必填参数:
word: 唤醒词的汉字
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
removeCommandWakeupWords
public void removeCommandWakeupWords(java.util.List<WakeupWord> wakeupWordList) throws DDSNotInitCompleteException
移除一条指定的命令唤醒词- 参数:
wakeupWordList- 唤醒词对象集合必填参数:
word: 唤醒词的汉字
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
clearCommandWakeupWord
public void clearCommandWakeupWord() throws DDSNotInitCompleteException
清空命令唤醒词的接口- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
clearShortCutWakeupWord
public void clearShortCutWakeupWord() throws DDSNotInitCompleteException
清空打断唤醒词的接口- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
updateShortcutWakeupWord
@Deprecated public void updateShortcutWakeupWord(java.lang.String[] words, java.lang.String[] pinyin, java.lang.String[] threshold) throws DDSNotInitCompleteException
已过时。更新打断唤醒词的接口,这类唤醒词能打断正在播报的语音并且将唤醒词送入识别支持设置多个打断唤醒词,所以参数为数组,重复调用会以最新的打断唤醒词数组为准。
- 参数:
words- 打断唤醒词的汉字(必须)pinyin- 打断唤醒词的拼音(必须)threshold- 打断唤醒词的阈值(必须- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
updateShortcutWakeupWord
public void updateShortcutWakeupWord(WakeupWord wakeupWord) throws DDSNotInitCompleteException
更新一条打断唤醒词的接口,这类唤醒词能打断正在播报的语音并且将唤醒词送入识别支持设置多个打断唤醒词,所以参数为数组,重复调用会以最新的打断唤醒词数组为准。
- 参数:
wakeupWord- 唤醒词对象必填参数:
word: 唤醒词的汉字
pinyin: 唤醒词的拼音
threshold: 唤醒词的阈值
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
updateShortcutWakeupWords
public void updateShortcutWakeupWords(java.util.List<WakeupWord> wakeupWordList) throws DDSNotInitCompleteException
更新多条打断唤醒词的接口,这类唤醒词能打断正在播报的语音并且将唤醒词送入识别支持设置多个打断唤醒词,所以参数为数组,重复调用会以最新的打断唤醒词数组为准。
- 参数:
wakeupWordList- 唤醒词对象集合必填参数:
word: 唤醒词的汉字
pinyin: 唤醒词的拼音
threshold: 唤醒词的阈值
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
addShortcutWakeupWord
@Deprecated public void addShortcutWakeupWord(java.lang.String[] words, java.lang.String[] pinyin, java.lang.String[] threshold) throws DDSNotInitCompleteException
已过时。添加新的打断唤醒词,且不会覆盖之前的唤醒词- 参数:
words- 打断唤醒词的汉字(必须)pinyin- 打断唤醒词的拼音(必须)threshold- 打断唤醒词的阈值(必须- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
addShortcutWakeupWord
public void addShortcutWakeupWord(WakeupWord wakeupWord) throws DDSNotInitCompleteException
添加一条新的打断唤醒词,且不会覆盖之前的唤醒词- 参数:
wakeupWord- 唤醒词对象必填参数:
word: 唤醒词的汉字
pinyin: 唤醒词的拼音
threshold: 唤醒词的阈值
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
addShortcutWakeupWords
public void addShortcutWakeupWords(java.util.List<WakeupWord> wakeupWordList) throws DDSNotInitCompleteException
添加多条新的打断唤醒词,且不会覆盖之前的唤醒词- 参数:
wakeupWordList- 唤醒词对象集合必填参数:
word: 唤醒词的汉字
pinyin: 唤醒词的拼音
threshold: 唤醒词的阈值
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
updateHotWords
public void updateHotWords(HotWords hotWords) throws DDSNotInitCompleteException
更新热词- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
removeShortcutWakeupWord
@Deprecated public void removeShortcutWakeupWord(java.lang.String[] words) throws DDSNotInitCompleteException
已过时。移除指定的打断唤醒词- 参数:
words- 打断唤醒词的汉字(必须)- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
removeShortcutWakeupWord
public void removeShortcutWakeupWord(WakeupWord wakeupWord) throws DDSNotInitCompleteException
移除一条指定的打断唤醒词- 参数:
wakeupWord- 唤醒词对象必填参数:
word: 唤醒词的汉字
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
removeShortcutWakeupWords
public void removeShortcutWakeupWords(java.util.List<WakeupWord> wakeupWordList) throws DDSNotInitCompleteException
移除多条指定的打断唤醒词- 参数:
wakeupWordList- 唤醒词对象集合必填参数:
word: 唤醒词的汉字
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
updateWakeupWords
public void updateWakeupWords(java.util.List<WakeupWordIntent> intents) throws DDSNotInitCompleteException
更新唤醒词,合并请求- 参数:
intents- 合并请求意图- 抛出:
DDSNotInitCompleteException
-
addQuickStartWords
public void addQuickStartWords(java.util.List<WakeupWord> wakeupWordList) throws DDSNotInitCompleteException
添加多条QuickStart词 QuickStart词为类似“导航去”、“我想听”等,此类唤醒词只在oneshot模式下生效, 作用为在未唤醒状态下语音输入“导航去天安门”,可直接进入对话流程。- 参数:
wakeupWordList- QuickStart词对象集合必填参数:
word: QuickStart词的汉字
pinyin: QuickStart词的拼音
threshold: QuickStart词的阈值
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
removeQuickStartWord
public void removeQuickStartWord(WakeupWord wakeupWord) throws DDSNotInitCompleteException
移除一条指定的QuickStart词- 参数:
wakeupWord- QuickStart词的对象必填参数:
word: QuickStart词的汉字
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
removeQuickStartWords
public void removeQuickStartWords(java.util.List<WakeupWord> wakeupWordList) throws DDSNotInitCompleteException
移除多条指定的QuickStart词- 参数:
wakeupWordList- QuickStart词的对象集合必填参数:
word: QuickStart词的汉字
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
updateQuickStartWords
public void updateQuickStartWords(java.util.List<WakeupWord> wakeupWordList) throws DDSNotInitCompleteException
更新多条QuickStart词的接口,覆盖原有的QuickStart词支持设置多个QuickStart词,所以参数为数组,重复调用会以最新的QuickStart词数组为准。
- 参数:
wakeupWordList- QuickStart词对象集合必填参数:
word: QuickStart词的汉字
pinyin: QuickStart词的拼音
threshold: QuickStart词的阈值
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
clearQuickStartWords
public void clearQuickStartWords() throws DDSNotInitCompleteException
清空QuickStart词的接口- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
enableMainWakeupWord
public void enableMainWakeupWord() throws DDSNotInitCompleteException
设置主唤醒词可唤醒,默认开启 (在已经调用enableWakeup的情况下临时使用, disableWakeup情况下无效)
-
setNearWakeupParams
@Deprecated public void setNearWakeupParams(org.json.JSONObject paramsObj) throws DDSNotInitCompleteException
已过时。设置就近唤醒参数与调度参数 仅在就近唤醒状态下生效(线双麦/线四麦)
-
notifyNearWakeupNetworkChange
public void notifyNearWakeupNetworkChange(java.lang.String ipAddress, org.json.JSONObject otherParams) throws DDSNotInitCompleteException
设置就近唤醒网络变化 仅在就近唤醒状态下生效(线双麦/线四麦)
-
disableMainWakeupWord
public void disableMainWakeupWord() throws DDSNotInitCompleteException
设置主唤醒词不可唤醒
-
enableMinorWakeupWord
public void enableMinorWakeupWord() throws DDSNotInitCompleteException
设置副唤醒词可唤醒,默认开启 (在已经调用enableWakeup的情况下临时使用, disableWakeup情况下无效)
-
disableMinorWakeupWord
public void disableMinorWakeupWord() throws DDSNotInitCompleteException
设置副唤醒词不可唤醒
-
enableCommandWakeupWord
public void enableCommandWakeupWord() throws DDSNotInitCompleteException
设置快捷命令唤醒词可唤醒,默认开启 (在已经调用enableWakeup的情况下临时使用, disableWakeup情况下无效)
-
disableCommandWakeupWord
public void disableCommandWakeupWord() throws DDSNotInitCompleteException
设置快捷命令唤醒词不可唤醒
-
enableQuickStartWakeupWord
public void enableQuickStartWakeupWord() throws DDSNotInitCompleteException
设置QuickStart唤醒词可唤醒,默认开启 (在已经调用enableWakeup的情况下临时使用, disableWakeup情况下无效)
-
disableQuickStartWakeupWord
public void disableQuickStartWakeupWord() throws DDSNotInitCompleteException
设置QuickStart唤醒词不可唤醒
-
enableShortCutWakeupWord
public void enableShortCutWakeupWord() throws DDSNotInitCompleteException
设置打断唤醒词可唤醒,默认开启 (在已经调用enableWakeup的情况下临时使用, disableWakeup情况下无效)
-
disableShortCutWakeupWord
public void disableShortCutWakeupWord() throws DDSNotInitCompleteException
设置打断唤醒词不可唤醒
-
enableWakeup
public void enableWakeup() throws DDSNotInitCompleteException
开启唤醒- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
enableWakeupWhenAsr
public void enableWakeupWhenAsr(boolean enable) throws DDSNotInitCompleteException
是否允许识别过程中响应唤醒- 参数:
enable- true: 允许识别过程中响应唤醒, false: 不允许识别过程中响应唤醒- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
setAudioRecordEnable
public void setAudioRecordEnable(boolean enable) throws DDSNotInitCompleteException
设置录音机是否可用- true 录音机可用,但真正打开录音还需依赖功能打开。比如
enableWakeup() - false 录音机不可用,如果正在录音会关闭录音机
从 setAudioRecordEnable(false) 到 setAudioRecordEnable(true) 后, 还需要 enableWakeup() 或者 Agent.startDialog() 等方法触发录音操作
- 参数:
enable- true 录音机可用,false 不可用- 抛出:
DDSNotInitCompleteException
- true 录音机可用,但真正打开录音还需依赖功能打开。比如
-
enableGlobalWakeup
public void enableGlobalWakeup(boolean enable) throws DDSNotInitCompleteException
是否开启全局免唤醒功能- 参数:
enable- true: 允许全局免唤醒, false: 不允许全局免唤醒- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
enableWakeupWhenAsr
public void enableWakeupWhenAsr() throws DDSNotInitCompleteException
允许识别过程中响应唤醒- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
disableWakeupWhenAsr
public void disableWakeupWhenAsr() throws DDSNotInitCompleteException
不允许识别过程中响应唤醒- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
disableWakeup
public void disableWakeup() throws DDSNotInitCompleteException
关闭唤醒- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
updateWkupRouter
public void updateWkupRouter(java.lang.String type) throws DDSNotInitCompleteException
动态设置对话模式- 参数:
type- 对话模式 partner- 抛出:
DDSNotInitCompleteException
-
setWakeupSwitch
public void setWakeupSwitch(boolean mode) throws DDSNotInitCompleteException
设置是唤醒模块的模式(信号处理不变,环麦中暂不支持)- 参数:
mode- 是否关闭唤醒 true-开启唤醒 ;false-关闭唤醒- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
setLpSwitch
@Deprecated public void setLpSwitch(boolean mode) throws DDSNotInitCompleteException
已过时。从1.2.16.1开始,内核不再支持此功能 设置低功耗模式, 开启低功耗模式后, 唤醒功能不可用, cpu会降低- 参数:
mode- 是否开启低功耗模式 true-开启 ;false-关闭- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
enableNearWakeup
@Deprecated public void enableNearWakeup(boolean enable) throws DDSNotInitCompleteException
已过时。动态切换就近唤醒功能(暂时支持线性双麦/线性四麦)- 参数:
enable- 是否开启就近唤醒 true-开启 ;false-关闭- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
catchWakeupResult
public void catchWakeupResult(boolean isCatch) throws DDSNotInitCompleteException
拦截唤醒结果 wakeup.result,- 参数:
isCatch- 是否拦截唤醒结果 true-拦截 ;false-取消拦截- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
enableOneShot
public void enableOneShot() throws DDSNotInitCompleteException
开启oneshot- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
disableOneShot
public void disableOneShot() throws DDSNotInitCompleteException
关闭oneshot- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
getOneshotState
public boolean getOneshotState() throws DDSNotInitCompleteException
获取当前oneshot开关状态,如果有本地接口调用开关,以本地接口调用优先。- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
getWakeupWords
public java.lang.String[] getWakeupWords() throws DDSNotInitCompleteException
获取当前的唤醒词- 返回:
- String[] 唤醒词数组
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
getWakeupVersion
public java.lang.String getWakeupVersion() throws DDSNotInitCompleteException
获取当前唤醒库版本号- 返回:
- 唤醒库版本号
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
getMainWakeupWords
public java.util.List<WakeupWord> getMainWakeupWords() throws DDSNotInitCompleteException
获取主唤醒词列表,默认返回WakeupEngine所设置的主唤醒词,如果没有设置过则返回产品配置的主唤醒词。- 返回:
- 唤醒词列表
- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
useVprintInWakeUp
public void useVprintInWakeUp(boolean enable) throws DDSNotInitCompleteException
动态设置是否在唤醒中启用声纹- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
useAsrPPInWakeUp
public void useAsrPPInWakeUp(boolean enable) throws DDSNotInitCompleteException
动态设置是否在唤醒中启用Asrpp- 抛出:
DDSNotInitCompleteException- 如果DDS没有初始化完成,会抛出exception
-
setWakeupPriority
@Deprecated public void setWakeupPriority(WakeupPriorityType type, boolean priority) throws DDSNotInitCompleteException
已过时。动态设置唤醒词优先级
-
disableHotwordOutOfDialog
@Deprecated public void disableHotwordOutOfDialog(boolean disable) throws DDSNotInitCompleteException
已过时。非对话情况下不使用可见即可说词- 参数:
disable-- 抛出:
DDSNotInitCompleteException
-
destroy
public void destroy()
-
disableIncrementWakeup
public void disableIncrementWakeup() throws DDSNotInitCompleteException
设置可见即可说不可用
-
disableIncrementWakeup
public void disableIncrementWakeup(org.json.JSONObject inputObj) throws DDSNotInitCompleteException
设置可见即可说不可用 inputObj : {"type":"all"} type: all:所有 hotWord:可见即可说词 globalWord:全局免唤醒词
-
enableIncrementWakeup
public void enableIncrementWakeup() throws DDSNotInitCompleteException
设置可见即可说可用
-
enableIncrementWakeup
public void enableIncrementWakeup(org.json.JSONObject inputObj) throws DDSNotInitCompleteException
设置可见即可说可用 inputObj : {"type":"all"} type: all 所有 hotWord 可见即可说词 globalWord 全局免唤醒词
-
setIncrementPriority
public void setIncrementPriority(WakeupPriorityType type) throws DDSNotInitCompleteException
如果可见即可说和全局免唤醒词有相同的词,设置哪一个优先响应, 默认可见即可说优先- 参数:
type- WakeupPriorityType.HOTWORD_FIRST : 可见即可说优先 WakeupPriorityType.GLOBALWORD_FIRST : 全局免唤醒优先- 抛出:
DDSNotInitCompleteException
-
-