AIWakeupIntent (DUI Lite SDK

java.lang.Object
- com.aispeech.lite.base.BaseIntent
- - com.aispeech.export.intent.AIWakeupIntent

public class AIWakeupIntent
extends BaseIntent

wakeup 引擎 start 时的参数设置。

Field Summary
- Fields inherited from class com.aispeech.lite.base.BaseIntent
  needCopyFeedData, needCopyResultData, useCustomFeed

Constructor Summary

Constructors
Constructor and Description

AIWakeupIntent()

Constructors
Constructor and Description
`AIWakeupIntent()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`enableDulWakeup(java.lang.String[] customNet, java.lang.String[] enableNet)` 设置双唤醒,双唤醒即基于当前唤醒模型，对不同的唤醒词做更好的响应。普通的唤醒词对某些唤醒词响应较好，如对 "你好小驰"响应比较好，则对"小吃小吃"识别不是那么完美，双唤醒主要用于更好的兼容不同的唤醒词设置的数量必须和唤醒词保持数量一致`setWakeupWord(String[], float[])`
`void`	`enableDulWakeupWithE2E(java.lang.String[] customNet, java.lang.String[] enableNet, float[] threshHigh, float[] threshLow)` E2E提供两个计算网络，使用双计算网络综合计算，综合最后的结果对特定的唤醒词达到提高唤醒率与降低误唤醒率的作用。 Note:E2E仅支持资源内内置的唤醒词设置的数量必须和唤醒词数量保持一致`setWakeupWord(String[], float[])` 同时，E2E要求同时设置普通唤醒词和E2E的唤醒词，E2E唤醒词用下划线做拼音之间的连接，如"ni_hao_xiao_chi"，即如果唤醒词为 “你好小驰”，则需要同时配置普通网络模型的唤醒词"ni hao xiao chi"，并将其网络模型设置为主网络即，"0";同时，设置E2E网络模型唤醒词"ni_hao_xiao_chi"，网络模型设置为"1"，这样才完成了一个基本的E2E 双唤醒设置，可参考如下示例 `setWakeupWord(new String[]{"ni hao xiao chi", "ni_hao_xiao_chi"}, new float[]{0.5f, 0.6f}); enableDulWakeupWithE2E(new String[] {"0","1"}, new String[] {"1", "1"}, new float[] {0.9f, 0.8f}, new float[] {0.1f, 0.2f});`
`java.lang.String[]`	`getCustomNet()`
`java.lang.String[]`	`getDcheck()`
`java.lang.String`	`getDumpWakeupAudioPath()`
`int`	`getDumpWakeupTime()`
`java.lang.String[]`	`getEnableNet()`
`int[]`	`getMajors()`
`java.lang.String[]`	`getPinyin()`
`java.lang.String`	`getSaveAudioFilePath()`
`float[]`	`getThreshHigh()`
`float[]`	`getThreshLow()`
`float[]`	`getThreshold()`
`boolean`	`isAddExtraAudioWhenFeedNotContinuousAudio()`
`boolean`	`isInputContinuousAudio()`
`boolean`	`isUseOneShot()`
`boolean`	`isVadEnable()`
`void`	`setAiOneshotConfig(AIOneshotConfig aiOneshotConfig)` Deprecated.
`void`	`setDcheck(int[] dcheck)` 设置唤醒是否开启校验，"1"表示开启校验，"0"表示不开启校验
`void`	`setDcheck(java.lang.String[] dcheck)` 设置唤醒是否开启校验，"1"表示开启校验，"0"表示不开启校验
`void`	`setDumpWakeupAudioPath(java.lang.String dumpWakeupAudioPath)` 设置dump唤醒音频保存的文件夹，比如/sdcard/speech/dumpwkp。不设置则不dump音频
`void`	`setDumpWakeupTime(int dumpWakeupTime)` 设置dump唤醒点回退音频时长，默认5000ms。
`void`	`setInputContinuousAudio(boolean inputContinuousAudio)` 设置是否输入实时的长音频，默认接受长音频为true(如果是一二级唤醒，即每个唤醒词独立且非实时，则需要设置为false，如果不设置会影响性能)
`void`	`setInputContinuousAudio(boolean inputContinuousAudio, boolean addExtraAudioWhenFeedNotContinuousAudio)` 设置是否输入实时的长音频，默认接受长音频为true(如果是一二级唤醒，即每个唤醒词独立且非实时，则需要设置为false，如果不设置会影响性能)
`void`	`setMajors(int[] majors)` 设置唤醒词的major，主唤醒词为1,副唤醒词为0
`void`	`setSaveAudioFilePath(java.lang.String saveAudioFilePath)` Deprecated. 统一规范这里不生效
`void`	`setThreshold(float[] threshold)` 设置唤醒阈值
`void`	`setUseOneShot(boolean useOneShot)` 设置是否使用 oneshot 功能,default is false
`void`	`setVadEnable(boolean vadEnable)` 设置是否启动vad功能，需要资源配合。在资源支持vad功能的情况下，默认启动vad。 vad 需引擎 stop 后重新 start 才能生效
`void`	`setWakeupWord(java.lang.String[] pinyin, float[] threshold)` 设置唤醒词列表
`void`	`setWakeupWords(java.lang.String[] wakeupWords)` 设置唤醒词列表
`java.lang.String`	`toString()`

Methods inherited from class com.aispeech.lite.base.BaseIntent
isNeedCopyFeedData, isNeedCopyResultData, isUseCustomFeed, setNeedCopyFeedData, setNeedCopyResultData, setUseCustomFeed

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AIWakeupIntent
```
public AIWakeupIntent()
```
- Method Detail
  - setUseOneShot
```
public void setUseOneShot(boolean useOneShot)
```
    设置是否使用 oneshot 功能,default is false
    oneshot 功能即唤醒词+命令词，如用户说：你好小弛，打开设置。 “你好小弛”是唤醒词，唤醒回调出发，此时使用 asr识别，可以识别出“打开设置”
    
    Parameters:
    
    useOneShot - useOneShot true 使用 oneshot 功能，false(default) 不使用
  - setInputContinuousAudio
```
public void setInputContinuousAudio(boolean inputContinuousAudio)
```
    设置是否输入实时的长音频，默认接受长音频为true(如果是一二级唤醒，即每个唤醒词独立且非实时，则需要设置为false，如果不设置会影响性能)
    当设置为false时,每次送一段音频段都会给予是否唤醒的反馈，如果没有被唤醒，则抛出wakeupWord:null, confidence:0的信息
    
    Parameters:
    
    inputContinuousAudio - 是否输入实时的长音频
  - setInputContinuousAudio
```
public void setInputContinuousAudio(boolean inputContinuousAudio,
                                    boolean addExtraAudioWhenFeedNotContinuousAudio)
```
    设置是否输入实时的长音频，默认接受长音频为true(如果是一二级唤醒，即每个唤醒词独立且非实时，则需要设置为false，如果不设置会影响性能)
    当设置为false时,每次送一段音频段都会给予是否唤醒的反馈，如果没有被唤醒，则抛出wakeupWord:null, confidence:0的信息
    
    当 inputContinuousAudio 设置为 false 时，可以设置 addExtraAudioWhenFeedNotContinuousAudio 为 true，会在段音频尾部再加上一些音频，使本应能够唤醒的音频更容易唤醒
    
    Parameters:
    
    inputContinuousAudio - 是否输入实时的长音频,默认为true
    
    addExtraAudioWhenFeedNotContinuousAudio - false（默认）不增加额外音频，true 增加额外音频
  - setWakeupWord
```
public void setWakeupWord(java.lang.String[] pinyin,
                          float[] threshold)
```
    设置唤醒词列表
    
    Parameters:
    
    pinyin - 唤醒词的拼音，建议三到五字，如：["ni hao xiao chi","xiao chi ni hao"] 当设置E2E双唤醒的情形下，E2E支持的唤醒词需要_做拼音的连接，如["ni_hao_xiao_chi","xiao_chi_xiao_chi"]
    
    threshold - 阈值，0-1，可根据需求自行调整，如：[0.1, 0.1]
  - setWakeupWords
```
public void setWakeupWords(java.lang.String[] wakeupWords)
```
    设置唤醒词列表
    
    Parameters:
    
    wakeupWords - 唤醒词的拼音，建议三到五字，如：["ni hao xiao chi","xiao chi ni hao"]
  - setThreshold
```
public void setThreshold(float[] threshold)
```
    设置唤醒阈值
    
    Parameters:
    
    threshold - 阈值，0-1，可根据需求自行调整，如：[0.1, 0.1]
  - setMajors
```
public void setMajors(int[] majors)
```
    设置唤醒词的major，主唤醒词为1,副唤醒词为0
    
    Parameters:
    
    majors - 如 [1,0,0]
  - setDcheck
```
public void setDcheck(java.lang.String[] dcheck)
```
    设置唤醒是否开启校验，"1"表示开启校验，"0"表示不开启校验
    
    Parameters:
    
    dcheck - 校验值，如：["1","0"]
  - setDcheck
```
public void setDcheck(int[] dcheck)
```
    设置唤醒是否开启校验，"1"表示开启校验，"0"表示不开启校验
    
    Parameters:
    
    dcheck - 校验值，如：[1,0]
  - isUseOneShot
```
public boolean isUseOneShot()
```
  - isInputContinuousAudio
```
public boolean isInputContinuousAudio()
```
  - getPinyin
```
public java.lang.String[] getPinyin()
```
  - getThreshold
```
public float[] getThreshold()
```
  - getDcheck
```
public java.lang.String[] getDcheck()
```
  - isVadEnable
```
public boolean isVadEnable()
```
  - setVadEnable
```
public void setVadEnable(boolean vadEnable)
```
    设置是否启动vad功能，需要资源配合。在资源支持vad功能的情况下，默认启动vad。
    vad 需引擎 stop 后重新 start 才能生效
    
    Parameters:
    
    vadEnable - true 启动，false 不启动
  - getDumpWakeupAudioPath
```
public java.lang.String getDumpWakeupAudioPath()
```
  - setDumpWakeupAudioPath
```
public void setDumpWakeupAudioPath(java.lang.String dumpWakeupAudioPath)
```
    设置dump唤醒音频保存的文件夹，比如/sdcard/speech/dumpwkp。不设置则不dump音频
    
    Parameters:
    
    dumpWakeupAudioPath - dump唤醒音频保存的文件夹
  - setDumpWakeupTime
```
public void setDumpWakeupTime(int dumpWakeupTime)
```
    设置dump唤醒点回退音频时长，默认5000ms。
    
    Parameters:
    
    dumpWakeupTime - dump唤醒点回退音频的时长
  - getDumpWakeupTime
```
public int getDumpWakeupTime()
```
  - isAddExtraAudioWhenFeedNotContinuousAudio
```
public boolean isAddExtraAudioWhenFeedNotContinuousAudio()
```
  - setSaveAudioFilePath
```
public void setSaveAudioFilePath(java.lang.String saveAudioFilePath)
```
    Deprecated. 统一规范这里不生效
    
    设置音频保存路径，会保存原始单声道音频如果设置了就会保存，全局DUILiteConfig.setLocalSaveAudioPath(String)没设置不会保存
    
    Parameters:
    
    saveAudioFilePath - 文件夹路径
  - getSaveAudioFilePath
```
public java.lang.String getSaveAudioFilePath()
```
  - enableDulWakeup
```
public void enableDulWakeup(java.lang.String[] customNet,
                            java.lang.String[] enableNet)
```
    设置双唤醒,双唤醒即基于当前唤醒模型，对不同的唤醒词做更好的响应。普通的唤醒词对某些唤醒词响应较好，如对 "你好小驰"响应比较好，则对"小吃小吃"识别不是那么完美，双唤醒主要用于更好的兼容不同的唤醒词设置的数量必须和唤醒词保持数量一致setWakeupWord(String[], float[])
    
    Parameters:
    
    customNet - 设置唤醒词对应的网络，分为主网络和自定义网络，主网络是"0",自定义网络设置"1"
    
    enableNet - 设置是否启用当前唤醒词对应的网络，"0"为关闭,"1"为启用
  - enableDulWakeupWithE2E
```
public void enableDulWakeupWithE2E(java.lang.String[] customNet,
                                   java.lang.String[] enableNet,
                                   float[] threshHigh,
                                   float[] threshLow)
```
    E2E提供两个计算网络，使用双计算网络综合计算，综合最后的结果对特定的唤醒词达到提高唤醒率与降低误唤醒率的作用。 Note:E2E仅支持资源内内置的唤醒词设置的数量必须和唤醒词数量保持一致setWakeupWord(String[], float[]) 同时，E2E要求同时设置普通唤醒词和E2E的唤醒词，E2E唤醒词用下划线做拼音之间的连接，如"ni_hao_xiao_chi"，即如果唤醒词为 “你好小驰”，则需要同时配置普通网络模型的唤醒词"ni hao xiao chi"，并将其网络模型设置为主网络即，"0";同时，设置E2E网络模型唤醒词"ni_hao_xiao_chi"，网络模型设置为"1"，这样才完成了一个基本的E2E 双唤醒设置，可参考如下示例 setWakeupWord(new String[]{"ni hao xiao chi", "ni_hao_xiao_chi"}, new float[]{0.5f, 0.6f}); enableDulWakeupWithE2E(new String[] {"0","1"}, new String[] {"1", "1"}, new float[] {0.9f, 0.8f}, new float[] {0.1f, 0.2f});
    
    Parameters:
    
    customNet - 设置唤醒词对应的网络，分为主网络和自定义网络，主网络是"0",E2E网络设置"1"
    
    enableNet - 设置是否启用当前唤醒词对应的网络，"0"为关闭,"1"为启用
    
    threshHigh - 高唤醒阈值，用于E2E的内部计算，设置数据请咨询思必驰研究
    
    threshLow - 低唤醒阈值，用于E2E的内部计算，设置数据请咨询思必驰研究
  - getCustomNet
```
public java.lang.String[] getCustomNet()
```
  - getEnableNet
```
public java.lang.String[] getEnableNet()
```
  - getThreshLow
```
public float[] getThreshLow()
```
  - getThreshHigh
```
public float[] getThreshHigh()
```
  - getMajors
```
public int[] getMajors()
```
  - setAiOneshotConfig
```
@Deprecated
public void setAiOneshotConfig(AIOneshotConfig aiOneshotConfig)
```
    Deprecated.
    
    此方法无效，请在初始化之前调用
    
    Parameters:
    
    aiOneshotConfig -
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AIWakeupIntent

Field Summary

Fields inherited from class com.aispeech.lite.base.BaseIntent

Constructor Summary

Method Summary

Methods inherited from class com.aispeech.lite.base.BaseIntent

Methods inherited from class java.lang.Object

Constructor Detail

AIWakeupIntent

Method Detail

setUseOneShot

setInputContinuousAudio

setInputContinuousAudio

setWakeupWord

setWakeupWords

setThreshold

setMajors

setDcheck

setDcheck

isUseOneShot

isInputContinuousAudio

getPinyin

getThreshold

getDcheck

isVadEnable

setVadEnable

getDumpWakeupAudioPath

setDumpWakeupAudioPath

setDumpWakeupTime

getDumpWakeupTime

isAddExtraAudioWhenFeedNotContinuousAudio

setSaveAudioFilePath

getSaveAudioFilePath

enableDulWakeup

enableDulWakeupWithE2E

getCustomNet

getEnableNet

getThreshLow

getThreshHigh

getMajors

setAiOneshotConfig

toString