AIWakeupEngine (DUI Lite SDK

java.lang.Object
- com.aispeech.lite.base.BaseEngine
- - com.aispeech.export.engines2.AIWakeupEngine

public class AIWakeupEngine
extends BaseEngine

本地唤醒引擎

Field Summary
- Fields inherited from class com.aispeech.lite.base.BaseEngine
  mBaseProcessor, TAG, tagSuffix

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static AIWakeupEngine`	`createInstance()` 唤醒引擎
`void`	`destroy()` 销毁唤醒内核和录音机
`void`	`feedData(byte[] data, int size)` 自行feed音频数据，不使用内部录音机时可用
`void`	`forceRequestWakeupResult()` 强制请求唤醒结果，即使没有唤醒也会给出唤醒词为null的结果
`static int`	`getOneShotCacheTime()`
`java.lang.String`	`getTag()`
`void`	`init(AIWakeupConfig config, AIWakeupListener listener)` 唤醒引擎初始化
`void`	`setDynamicParam(org.json.JSONObject envJson)` 设置唤醒env热更新，可以在引擎初始化成功后动态设置,当前只支持更新thresh
`void`	`setDynamicParam(java.lang.String env)` 动态调整参数，参数只能是 `AIWakeupIntent` 内的参数，不同引擎可以动态设置的参数不一样，建议使用 `setDynamicParam(String[], float[])` 方法
`void`	`setDynamicParam(java.lang.String[] pinyin, float[] thresh)` 动态调整参数,只能调整唤醒词的thresh
`void`	`setDynamicParamEnv(java.util.Map<java.lang.String,?> dynamicParam)` 动态调整参数，具体请参照 demo
`void`	`setWakeupWords(java.lang.String[] wakeupWord, float[] threshold, int[] majors)` Deprecated. `AIWakeupIntent.setWakeupWord(String[], float[])`
`void`	`start(AIWakeupIntent aiWakeupIntent)` 开启唤醒，如果使用内部录音机的话一并开启
`void`	`stop()` 关闭唤醒，如果使用内部录音机的话一并关闭
`void`	`updateWakeupThreshold(java.lang.String[] wakeupWord, float[] threshold, int[] majors)` 动态调整参数，具体请参照 demo 仅支持intent中设置的唤醒词的阈值修改

Methods inherited from class com.aispeech.lite.base.BaseEngine
cancel, init, initTAG, parseConfig, parseIntent, start

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

- Method Detail
  - getTag
```
public java.lang.String getTag()
```
    Specified by:
    
    getTag in class BaseEngine
  - createInstance
```
public static AIWakeupEngine createInstance()
```
    唤醒引擎
    
    Returns:
    
    唤醒引擎实例
  - getOneShotCacheTime
```
public static int getOneShotCacheTime()
```
  - init
```
public void init(AIWakeupConfig config,
                 AIWakeupListener listener)
```
    唤醒引擎初始化
    
    Parameters:
    
    config - 配置参数
    
    listener - 唤醒相关时间的回调
  - setDynamicParam
```
public void setDynamicParam(java.lang.String[] pinyin,
                            float[] thresh)
```
    动态调整参数,只能调整唤醒词的thresh
    
    Parameters:
    
    pinyin - 唤醒词，必须在AIWakeupIntent设置过，参数示例：["ni hao xiao chi"]
    
    thresh - 唤醒词对应的阈值，参数示例：[0.2]
    
    See Also:
    
    AIWakeupIntent.setWakeupWord(java.lang.String[], float[]), setDynamicParam(String)
  - setDynamicParamEnv
```
public void setDynamicParamEnv(java.util.Map<java.lang.String,?> dynamicParam)
```
    动态调整参数，具体请参照 demo
    
    Parameters:
    
    dynamicParam - env 里的参数，key可以是 words thresh 等, value 类型可以是基础类型、字符串、数组、列表
  - setDynamicParam
```
public void setDynamicParam(java.lang.String env)
```
    动态调整参数，参数只能是 AIWakeupIntent 内的参数，不同引擎可以动态设置的参数不一样，建议使用 setDynamicParam(String[], float[]) 方法
    
    Parameters:
    
    env - 参数字符串，如："words=ni hao xiao chi;thresh=0.2;"
    
    See Also:
    
    setDynamicParam(String[], float[])
  - setDynamicParam
```
public void setDynamicParam(org.json.JSONObject envJson)
```
    设置唤醒env热更新，可以在引擎初始化成功后动态设置,当前只支持更新thresh
    
    Parameters:
    
    envJson - setJson 须在start启动成功后可以调用
  - updateWakeupThreshold
```
public void updateWakeupThreshold(java.lang.String[] wakeupWord,
                                  float[] threshold,
                                  int[] majors)
                           throws IllegalPinyinException
```
    动态调整参数，具体请参照 demo 仅支持intent中设置的唤醒词的阈值修改
    
    Parameters:
    
    wakeupWord - 唤醒词，参数示例：["ni hao xiao chi","xiao bu xiao bu"]
    
    threshold - 唤醒词对应的阈值，参数示例：[0.2, 0.3]
    
    majors - 是否主唤醒词，主唤醒词为1，副唤醒词为0，如 [1,0] 设置主唤醒词后，内核会对唤醒词部分音频进行回溯
    
    Throws:
    
    IllegalPinyinException - IllegalPinyinException 非法拼音异常
  - setWakeupWords
```
public void setWakeupWords(java.lang.String[] wakeupWord,
                           float[] threshold,
                           int[] majors)
                    throws IllegalPinyinException
```
    Deprecated. AIWakeupIntent.setWakeupWord(String[], float[])
    
    设置唤醒词此功能先内部先执行stop，再执行start，调用者无需再执行start
    
    Parameters:
    
    wakeupWord - 唤醒词，参数示例：["ni hao xiao chi","xiao bu xiao bu"]
    
    threshold - 唤醒词对应的阈值，参数示例：[0.2, 0.3]
    
    majors - 是否主唤醒词，主唤醒词为1，副唤醒词为0，如 [1,0] 设置主唤醒词后，内核会对唤醒词部分音频进行回溯
    
    Throws:
    
    IllegalPinyinException - IllegalPinyinException 非法拼音异常
  - feedData
```
public void feedData(byte[] data,
                     int size)
```
    自行feed音频数据，不使用内部录音机时可用
    
    Parameters:
    
    data - 音频数据
    
    size - 音频数据大小
    
    See Also:
    
    BaseIntent.setUseCustomFeed(boolean)
  - start
```
public void start(AIWakeupIntent aiWakeupIntent)
```
    开启唤醒，如果使用内部录音机的话一并开启
    
    Parameters:
    
    aiWakeupIntent - 配置参数
  - stop
```
public void stop()
```
    关闭唤醒，如果使用内部录音机的话一并关闭
    
    Overrides:
    
    stop in class BaseEngine
  - forceRequestWakeupResult
```
public void forceRequestWakeupResult()
```
    强制请求唤醒结果，即使没有唤醒也会给出唤醒词为null的结果
  - destroy
```
public void destroy()
```
    销毁唤醒内核和录音机
    
    Overrides:
    
    destroy in class BaseEngine

Class AIWakeupEngine

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

getTag

createInstance

getOneShotCacheTime

init

setDynamicParam

setDynamicParamEnv

setDynamicParam

setDynamicParam

updateWakeupThreshold

setWakeupWords

feedData

start

stop

forceRequestWakeupResult

destroy