AILocalWakeupAndVprintEngine (DUI Lite SDK

java.lang.Object
- com.aispeech.export.engines2.AILocalWakeupAndVprintEngine

public class AILocalWakeupAndVprintEngine
extends java.lang.Object

Created by wuwei on 2018/7/12.

字段概要

字段
限定符和类型字段和说明

static java.lang.String TAG

字段
限定符和类型	字段和说明
`static java.lang.String`	`TAG`

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`static boolean`	`checkLibValid()`
`void`	`destroy()` 销毁声纹引擎
`void`	`feedData(byte[] data)` 已过时。
`void`	`feedData(byte[] data, int size)` 传入数据,在不使用SDK内部录音机时调用
`static AILocalWakeupAndVprintEngine`	`getInstance()`
`static int`	`getOneShotCacheTime()`
`java.lang.String`	`getVprintMode()` 获取当前声纹模式
`void`	`init(AILocalWakeupAndVprintListener localVprintListener)` 初始化声纹引擎
`void`	`queryModuleInfo()` 获取当前声纹模型中的注册信息，需要在init成功后调用生效。
`void`	`setClippingRateThreshold(double clippingRateThreshold)` 设置音频衰减率(截幅)阈值，高于该阈值声纹训练会无效，需要重新训练，同时抛出错误 id: 70953 `AIError.ERR_AUDIO_CLIPPING` error: "音频已截幅，请距离远一点再试一下" `AIError.ERR_DESCRIPTION_AUDIO_CLIPPING`
`void`	`setDcheck(java.lang.String[] dcheck)` 已过时。
`void`	`setDeleteWord(java.lang.String deleteWord)` 设置删除唤醒词须在start之前设置生效
`void`	`setGenderResBin(java.lang.String genderResBin)` 设置性别识别资源文件名，需提前放置与assets目录下须在init之前设置才生效
`void`	`setGenderResBinPath(java.lang.String genderResBinPath)` 设置性别识别资源文件自定义绝对路径，包含文件名须在init之前设置才生效
`void`	`setGenderResFileName(java.lang.String genderResFileName)` 已过时。
`void`	`setInputContinuousAudio(boolean inputContinuousAudio)` 设置是否输入实时的长音频，默认接受长音频为true(如果是一二级唤醒，即每个唤醒词独立且非实时，则需要设置为false，如果不设置会影响性能) 须在start之前设置生效
`void`	`setOneShotCacheTime(int time)` 设置oneshot功能下需要缓存的音频时长,根据具体的硬件性能和唤醒词长度调节
`void`	`setSaveAudioFilePath(java.lang.String path)` 设置原始单路音频保存路径，例如"/sdcard/speech"。
`void`	`setSNRValidThreshold(double snrValidThreshold)` 设置SNR检查的有效阈值，低于该阈值声纹训练会无效，同时抛出错误须在start之前设置生效
`void`	`setSpeakerName(java.lang.String name)` 设置训练或删除的说话人名字须在start之前设置生效
`void`	`setThreshold(java.lang.String[] threshold)` 已过时。
`void`	`setTrainNum(int trainNum)` 设置注册时训练声纹的次数。
`void`	`setUpgradeAudioPath(java.lang.String upgradeAudioPath)` 设置用于自动升级声纹模型的原始声纹音频的保存路径，例如"/sdcard/speech" 。
`void`	`setUseCustomFeed(boolean useCustomFeed)` 设置是否自行feed数据,不使用内部录音机(包括MockRecord和AIAudioRecord), 须init之前调用, 默认为false
`void`	`setUseOneShotFunction(boolean useOneShot)` 设置是否使用oneshot功能,默认为false 须在start之前设置才生效,默认为false
`void`	`setVadResBinPath(java.lang.String vadResBinPath)` 设置VAD资源的绝对路径,包括文件名, 需要在init之前调用
`void`	`setVadResource(java.lang.String vadRes)` 设置VAD资源名字需要在init之前调用
`void`	`setVoiceDetectTimeOut(int milliSecond)` 设置声纹环境噪声检测定时器，单位毫秒，默认值为5000ms ；如果达到该设置值时，则会提示错误，并重新开启新的一轮检测。
`void`	`setVprintMode(java.lang.String vprintMode)` 设置声纹功能模式现支持：注册，`AIConstant.VP_REGISTER` 测试/签到，`AIConstant.VP_TEST` 删除，`AIConstant.VP_UNREGISTER` 更新。
`void`	`setVprintModuleFilePath(java.lang.String moduleFilePath)` 设置生成的声纹模型保存路径，包含文件名须在init之前设置才生效
`void`	`setVprintResBin(java.lang.String vprintResBin)` 设置声纹资源文件名，需提前放置与assets目录下须在init之前设置才生效
`void`	`setVprintResBinPath(java.lang.String vprintResBinPath)` 设置声纹资源文件自定义绝对路径，包含文件名须在init之前设置才生效
`void`	`setVprintResFileName(java.lang.String vprintResFileName)` 已过时。
`void`	`setVprintWord(java.lang.String[] words)` 设置声纹唤醒词须在start之前设置生效
`void`	`setWakeupDcheck(java.lang.String[] dcheck)` 设置唤醒是否开启校验，"1"表示开启校验，"0"表示不开启校验须在start之前设置生效
`void`	`setWakeupResBin(java.lang.String wakeupResBin)` 设置唤醒资源文件名，需提前放置与assets目录下须在init之前设置才生效
`void`	`setWakeupResBinPath(java.lang.String wakeupResBinPath)` 设置唤醒资源文件自定义绝对路径，包含文件名须在init之前设置才生效
`void`	`setWakeupResFileName(java.lang.String wakeupResFileName)` 已过时。
`void`	`setWakeupThreshold(java.lang.String[] threshold)` 设置声纹唤醒词的阈值须在start之前设置生效
`void`	`start()` 启动声纹引擎
`void`	`stop()` 停止声纹引擎

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - TAG
```
public static final java.lang.String TAG
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - checkLibValid
```
public static boolean checkLibValid()
```
  - getInstance
```
public static AILocalWakeupAndVprintEngine getInstance()
```
  - setOneShotCacheTime
```
public void setOneShotCacheTime(int time)
```
    设置oneshot功能下需要缓存的音频时长,根据具体的硬件性能和唤醒词长度调节
    
    参数:
    
    time - 缓存时间须在init之前设置才生效单位毫秒，默认为1200ms
  - getOneShotCacheTime
```
public static int getOneShotCacheTime()
```
  - setUseOneShotFunction
```
public void setUseOneShotFunction(boolean useOneShot)
```
    设置是否使用oneshot功能,默认为false 须在start之前设置才生效,默认为false
    
    参数:
    
    useOneShot - useOneShot
  - setVprintResBin
```
public void setVprintResBin(java.lang.String vprintResBin)
```
    设置声纹资源文件名，需提前放置与assets目录下须在init之前设置才生效
    
    参数:
    
    vprintResBin - 声纹资源文件名
  - setVprintResFileName
```
@Deprecated
public void setVprintResFileName(java.lang.String vprintResFileName)
```
    已过时。
  - setVprintResBinPath
```
public void setVprintResBinPath(java.lang.String vprintResBinPath)
```
    设置声纹资源文件自定义绝对路径，包含文件名须在init之前设置才生效
    
    参数:
    
    vprintResBinPath - 声纹资源文件自定义绝对路径
  - setVadResBinPath
```
public void setVadResBinPath(java.lang.String vadResBinPath)
```
    设置VAD资源的绝对路径,包括文件名, 需要在init之前调用
    
    参数:
    
    vadResBinPath - vadResBinPath
  - setVadResource
```
public void setVadResource(java.lang.String vadRes)
```
    设置VAD资源名字需要在init之前调用
    
    参数:
    
    vadRes - vad资源名
  - setGenderResBin
```
public void setGenderResBin(java.lang.String genderResBin)
```
    设置性别识别资源文件名，需提前放置与assets目录下须在init之前设置才生效
    
    参数:
    
    genderResBin - 性别识别资源文件名
  - setGenderResFileName
```
@Deprecated
public void setGenderResFileName(java.lang.String genderResFileName)
```
    已过时。
  - setGenderResBinPath
```
public void setGenderResBinPath(java.lang.String genderResBinPath)
```
    设置性别识别资源文件自定义绝对路径，包含文件名须在init之前设置才生效
    
    参数:
    
    genderResBinPath - 性别识别资源文件自定义绝对路径
  - setWakeupResBin
```
public void setWakeupResBin(java.lang.String wakeupResBin)
```
    设置唤醒资源文件名，需提前放置与assets目录下须在init之前设置才生效
    
    参数:
    
    wakeupResBin - 唤醒资源文件名
  - setWakeupResFileName
```
@Deprecated
public void setWakeupResFileName(java.lang.String wakeupResFileName)
```
    已过时。
  - setWakeupResBinPath
```
public void setWakeupResBinPath(java.lang.String wakeupResBinPath)
```
    设置唤醒资源文件自定义绝对路径，包含文件名须在init之前设置才生效
    
    参数:
    
    wakeupResBinPath - 唤醒资源文件自定义绝对路径
  - setVprintModuleFilePath
```
public void setVprintModuleFilePath(java.lang.String moduleFilePath)
```
    设置生成的声纹模型保存路径，包含文件名须在init之前设置才生效
    
    参数:
    
    moduleFilePath - 声纹模型保存路径
  - setVprintMode
```
public void setVprintMode(java.lang.String vprintMode)
```
    设置声纹功能模式现支持：注册，AIConstant.VP_REGISTER 测试/签到，AIConstant.VP_TEST 删除，AIConstant.VP_UNREGISTER 更新。AIConstant.VP_UPDATE 须在start之前设置生效
    
    参数:
    
    vprintMode - vprintMode
  - setUseCustomFeed
```
public void setUseCustomFeed(boolean useCustomFeed)
```
    设置是否自行feed数据,不使用内部录音机(包括MockRecord和AIAudioRecord), 须init之前调用, 默认为false
    
    参数:
    
    useCustomFeed - the useCustomFeed to set
  - setSaveAudioFilePath
```
public void setSaveAudioFilePath(java.lang.String path)
```
    设置原始单路音频保存路径，例如"/sdcard/speech"。文件保存为path/wakeup_vprint_时间戳.pcm
    
    参数:
    
    path - 音频保存路径须init之前调用,默认不保存
  - setUpgradeAudioPath
```
public void setUpgradeAudioPath(java.lang.String upgradeAudioPath)
```
    设置用于自动升级声纹模型的原始声纹音频的保存路径，例如"/sdcard/speech" 。默认路径为/sdcard/Android/包名/data/cache下
    
    参数:
    
    upgradeAudioPath - 原始声纹音频的保存路径须init之前调用
  - setVprintWord
```
public void setVprintWord(java.lang.String[] words)
```
    设置声纹唤醒词须在start之前设置生效
    
    参数:
    
    words - 唤醒词
  - setThreshold
```
@Deprecated
public void setThreshold(java.lang.String[] threshold)
```
    已过时。
    
    设置声纹唤醒词的阈值须在start之前设置生效
    
    参数:
    
    threshold - 阈值
  - setWakeupThreshold
```
public void setWakeupThreshold(java.lang.String[] threshold)
```
    设置声纹唤醒词的阈值须在start之前设置生效
    
    参数:
    
    threshold - 阈值
  - setDcheck
```
@Deprecated
public void setDcheck(java.lang.String[] dcheck)
```
    已过时。
    
    设置唤醒是否开启校验，"1"表示开启校验，"0"表示不开启校验须在start之前设置生效
    
    参数:
    
    dcheck - 校验值
  - setWakeupDcheck
```
public void setWakeupDcheck(java.lang.String[] dcheck)
```
    设置唤醒是否开启校验，"1"表示开启校验，"0"表示不开启校验须在start之前设置生效
    
    参数:
    
    dcheck - 校验值
  - getVprintMode
```
public java.lang.String getVprintMode()
```
    获取当前声纹模式
    
    返回:
    
    当前声纹模式
  - setSNRValidThreshold
```
public void setSNRValidThreshold(double snrValidThreshold)
```
    设置SNR检查的有效阈值，低于该阈值声纹训练会无效，同时抛出错误须在start之前设置生效
    
    参数:
    
    snrValidThreshold - NR检查的有效阈值
  - setClippingRateThreshold
```
public void setClippingRateThreshold(double clippingRateThreshold)
```
    设置音频衰减率(截幅)阈值，高于该阈值声纹训练会无效，需要重新训练，同时抛出错误 id: 70953 AIError.ERR_AUDIO_CLIPPING error: "音频已截幅，请距离远一点再试一下" AIError.ERR_DESCRIPTION_AUDIO_CLIPPING
    
    参数:
    
    clippingRateThreshold - 音频衰减率(截幅)阈值, 默认0.05
  - setInputContinuousAudio
```
public void setInputContinuousAudio(boolean inputContinuousAudio)
```
    设置是否输入实时的长音频，默认接受长音频为true(如果是一二级唤醒，即每个唤醒词独立且非实时，则需要设置为false，如果不设置会影响性能) 须在start之前设置生效
    
    参数:
    
    inputContinuousAudio - 是否输入实时的长音频
  - queryModuleInfo
```
public void queryModuleInfo()
```
    获取当前声纹模型中的注册信息，需要在init成功后调用生效。查询结果从AILocalWakeupAndVprintListener.onResults(AIResult)回调抛出
  - setVoiceDetectTimeOut
```
public void setVoiceDetectTimeOut(int milliSecond)
```
    设置声纹环境噪声检测定时器，单位毫秒，默认值为5000ms ；如果达到该设置值时，则会提示错误，并重新开启新的一轮检测。须在start之前设置生效
    
    参数:
    
    milliSecond - 声纹环境噪声检测时长
  - setSpeakerName
```
public void setSpeakerName(java.lang.String name)
```
    设置训练或删除的说话人名字须在start之前设置生效
    
    参数:
    
    name - 说话人名字
  - setDeleteWord
```
public void setDeleteWord(java.lang.String deleteWord)
```
    设置删除唤醒词须在start之前设置生效
    
    参数:
    
    deleteWord - 删除的唤醒词
  - setTrainNum
```
public void setTrainNum(int trainNum)
```
    设置注册时训练声纹的次数。默认为3次，值越大训练越充分，声纹检测效果越好须在start之前设置生效
    
    参数:
    
    trainNum - trainNum
  - init
```
public void init(AILocalWakeupAndVprintListener localVprintListener)
```
    初始化声纹引擎
    
    参数:
    
    localVprintListener - 声纹回调
  - start
```
public void start()
```
    启动声纹引擎
  - feedData
```
@Deprecated
public void feedData(byte[] data)
```
    已过时。
    
    传入数据,在不使用SDK内部录音机时调用
    
    参数:
    
    data - 音频数据流
    
    另请参阅:
    
    setUseCustomFeed(boolean)
  - feedData
```
public void feedData(byte[] data,
                     int size)
```
    传入数据,在不使用SDK内部录音机时调用
    
    参数:
    
    data - 音频数据流
    
    size - 音频数据大小
    
    另请参阅:
    
    setUseCustomFeed(boolean)
  - stop
```
public void stop()
```
    停止声纹引擎
  - destroy
```
public void destroy()
```
    销毁声纹引擎

类 AILocalWakeupAndVprintEngine

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

TAG

方法详细资料

checkLibValid

getInstance

setOneShotCacheTime

getOneShotCacheTime

setUseOneShotFunction

setVprintResBin

setVprintResFileName

setVprintResBinPath

setVadResBinPath

setVadResource

setGenderResBin

setGenderResFileName

setGenderResBinPath

setWakeupResBin

setWakeupResFileName

setWakeupResBinPath

setVprintModuleFilePath

setVprintMode

setUseCustomFeed

setSaveAudioFilePath

setUpgradeAudioPath

setVprintWord

setThreshold

setWakeupThreshold

setDcheck

setWakeupDcheck

getVprintMode

setSNRValidThreshold

setClippingRateThreshold

setInputContinuousAudio

queryModuleInfo

setVoiceDetectTimeOut

setSpeakerName

setDeleteWord

setTrainNum

init

start

feedData

feedData

stop

destroy