AIFespCarEngine (DUI Lite SDK

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

public class AIFespCarEngine
extends BaseEngine

Created by wanbing on 2021/9/6 11:57

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`COMBINATION_POSITION_COPILOT`
`static int`	`COMBINATION_POSITION_ENTIRE`
`static int`	`COMBINATION_POSITION_LEFT_BACKSEAT`
`static int`	`COMBINATION_POSITION_MAIN`
`static int`	`COMBINATION_POSITION_RIGHT_BACKSEAT`
`static int`	`FESP_CAR_DOA_COPILOT` 副驾驶方位 doa
`static int`	`FESP_CAR_DOA_LEFT_BACKSEAT` 左后 doa
`static int`	`FESP_CAR_DOA_MAIN` 主驾驶方位 doa
`static int`	`FESP_CAR_DOA_RIGHT_BACKSEAT` 右后 doa
`static int`	`FESP_CAR_DRIVE_MODE_COPILOT` 副驾驶模式,beamforming 指向副驾驶方位
`static int`	`FESP_CAR_DRIVE_MODE_ENTIRE` 全车模式,beamforming无指向
`static int`	`FESP_CAR_DRIVE_MODE_FREE_COMBINATION` 自由自核模式,无指向
`static int`	`FESP_CAR_DRIVE_MODE_MAIN` 主驾模式,beamforming指向主驾驶方位
`static int`	`FESP_CAR_DRIVE_MODE_POSITIONING` 定位模式,beamforming 全指向
`static int`	`FESP_CAR_MIC_FOUR` Fesp引擎类型四麦
`static int`	`FESP_CAR_MIC_TWO` Fesp引擎类型双麦
`static int`	`FESPCAR_DOUBLEVAD_DATARECEIVED_ENABLE` 双vad根据驾驶模式抛出音频，全车模式抛出混音开关
`static int`	`FESPCAR_MIXING_DATARECEIVED_ENABLE` 直接抛出混合音频，与驾驶模式无关
`static int`	`FESPCAR_SINGLEVAD_DATARECEIVED_ENABLE` 单根据驾驶模式抛出音频，全车模式抛出混音开关

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()` 销毁信号处理模块和唤醒引擎该方法会停止录音机和销毁录音机
`void`	`feedData(byte[] data, int size)` 传入数据,在不使用SDK录音机时调用
`int`	`getDriveMode()` 获取驾驶模式，只有车载双麦模块有这个功能
`FespxProcessor`	`getFespxProcessor()`
`static AIFespCarEngine`	`getInstance()` 创建前端信号处理引擎对象
`java.lang.String`	`getTag()`
`int`	`getValueOf(java.lang.String param)` get value
`void`	`init(AIFespCarConfig config, AIFespCarListener listener)`
`void`	`notifyDialogEnd()` 定位模式下通知引擎回正 beamforming 指向，定位模式下需要外部在结束对话状态后通知到引擎内部,和 `AIFespCarIntent.setAutoHoldBeamforming(boolean)` 配置搭配使用
`void`	`resetDriveMode()`
`void`	`setBoundary(int boundary)` 开启/关闭声纹唤醒词截断
`void`	`setDoaManually(int doa)` 在定位模式下，手动设置为主驾唤醒或者副驾唤醒
`void`	`setDriveMode(int driveMode)` 动态设置唤醒env，在其中加入 driveMode 参数设置模式后，会取消beamforming指向。
`void`	`setDriveMode(int driveMode, int wakeupChannelMask)`
`void`	`setResBin(java.lang.String sspeBinPath, java.lang.String wakeupBinPath, boolean backRowRestrainEnable)` 动态设置 sspe（前端信号处理）与 wakeup（唤醒）资源
`void`	`setWakeupWords(java.lang.String[] words, float[] thresholds)` 设置唤醒词
`void`	`setWakeupWords(java.lang.String[] words, float[] thresholds, int[] majors)` 设置唤醒词
`void`	`setWakeupWords(java.lang.String[] words, float[] thresholds, int[] majors, int[] ranges)` 设置唤醒词
`void`	`start(AIFespCarIntent aiFespCarIntent)` 启动信号处理模块和唤醒引擎
`void`	`stop()` 停止信号处理模块和唤醒引擎该方法会停止接收录音数据和停止信号处理，唤醒，程序退出时可以调用

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

- Field Detail
  - FESP_CAR_DRIVE_MODE_POSITIONING
```
public static final int FESP_CAR_DRIVE_MODE_POSITIONING
```
    定位模式,beamforming 全指向
    
    See Also:
    
    Constant Field Values
  - FESP_CAR_DRIVE_MODE_MAIN
```
public static final int FESP_CAR_DRIVE_MODE_MAIN
```
    主驾模式,beamforming指向主驾驶方位
    
    See Also:
    
    Constant Field Values
  - FESP_CAR_DRIVE_MODE_COPILOT
```
public static final int FESP_CAR_DRIVE_MODE_COPILOT
```
    副驾驶模式,beamforming 指向副驾驶方位
    
    See Also:
    
    Constant Field Values
  - FESP_CAR_DRIVE_MODE_ENTIRE
```
public static final int FESP_CAR_DRIVE_MODE_ENTIRE
```
    全车模式,beamforming无指向
    
    See Also:
    
    Constant Field Values
  - FESP_CAR_DRIVE_MODE_FREE_COMBINATION
```
public static final int FESP_CAR_DRIVE_MODE_FREE_COMBINATION
```
    自由自核模式,无指向
    
    See Also:
    
    Constant Field Values
  - COMBINATION_POSITION_MAIN
```
public static final int COMBINATION_POSITION_MAIN
```
    See Also:
    
    Constant Field Values
  - COMBINATION_POSITION_COPILOT
```
public static final int COMBINATION_POSITION_COPILOT
```
    See Also:
    
    Constant Field Values
  - COMBINATION_POSITION_LEFT_BACKSEAT
```
public static final int COMBINATION_POSITION_LEFT_BACKSEAT
```
    See Also:
    
    Constant Field Values
  - COMBINATION_POSITION_RIGHT_BACKSEAT
```
public static final int COMBINATION_POSITION_RIGHT_BACKSEAT
```
    See Also:
    
    Constant Field Values
  - COMBINATION_POSITION_ENTIRE
```
public static final int COMBINATION_POSITION_ENTIRE
```
    See Also:
    
    Constant Field Values
  - FESP_CAR_DOA_MAIN
```
public static final int FESP_CAR_DOA_MAIN
```
    主驾驶方位 doa
    
    See Also:
    
    Constant Field Values
  - FESP_CAR_DOA_COPILOT
```
public static final int FESP_CAR_DOA_COPILOT
```
    副驾驶方位 doa
    
    See Also:
    
    Constant Field Values
  - FESP_CAR_DOA_LEFT_BACKSEAT
```
public static final int FESP_CAR_DOA_LEFT_BACKSEAT
```
    左后 doa
    
    See Also:
    
    Constant Field Values
  - FESP_CAR_DOA_RIGHT_BACKSEAT
```
public static final int FESP_CAR_DOA_RIGHT_BACKSEAT
```
    右后 doa
    
    See Also:
    
    Constant Field Values
  - FESP_CAR_MIC_TWO
```
public static final int FESP_CAR_MIC_TWO
```
    Fesp引擎类型双麦
    
    See Also:
    
    Constant Field Values
  - FESP_CAR_MIC_FOUR
```
public static final int FESP_CAR_MIC_FOUR
```
    Fesp引擎类型四麦
    
    See Also:
    
    Constant Field Values
  - FESPCAR_DOUBLEVAD_DATARECEIVED_ENABLE
```
public static final int FESPCAR_DOUBLEVAD_DATARECEIVED_ENABLE
```
    双vad根据驾驶模式抛出音频，全车模式抛出混音开关
    
    See Also:
    
    Constant Field Values
  - FESPCAR_SINGLEVAD_DATARECEIVED_ENABLE
```
public static final int FESPCAR_SINGLEVAD_DATARECEIVED_ENABLE
```
    单根据驾驶模式抛出音频，全车模式抛出混音开关
    
    See Also:
    
    Constant Field Values
  - FESPCAR_MIXING_DATARECEIVED_ENABLE
```
public static final int FESPCAR_MIXING_DATARECEIVED_ENABLE
```
    直接抛出混合音频，与驾驶模式无关
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getTag
```
public java.lang.String getTag()
```
    Specified by:
    
    getTag in class BaseEngine
  - getInstance
```
public static AIFespCarEngine getInstance()
```
    创建前端信号处理引擎对象
    
    Returns:
    
    AILocalSignalAndWakeupEngine 返回实例对象，可支持多实例
  - init
```
public void init(AIFespCarConfig config,
                 AIFespCarListener listener)
```
  - start
```
public void start(AIFespCarIntent aiFespCarIntent)
```
    启动信号处理模块和唤醒引擎
    
    Parameters:
    
    aiFespCarIntent - 前端信号处理参数
    
    See Also:
    
    AIFespCarIntent
  - getValueOf
```
public int getValueOf(java.lang.String param)
```
    get value
    
    Parameters:
    
    param - key
    
    Returns:
    
    value
  - setBoundary
```
public void setBoundary(int boundary)
```
    开启/关闭声纹唤醒词截断
    
    Parameters:
    
    boundary - 0:关闭，1：开启
  - setWakeupWords
```
public void setWakeupWords(java.lang.String[] words,
                           float[] thresholds)
```
    设置唤醒词
    
    Parameters:
    
    words - 唤醒词
    
    thresholds - 阈值
  - setWakeupWords
```
public void setWakeupWords(java.lang.String[] words,
                           float[] thresholds,
                           int[] majors)
```
    设置唤醒词
    
    Parameters:
    
    words - 唤醒词
    
    thresholds - 阈值
    
    majors - 1主 0副
  - setWakeupWords
```
public void setWakeupWords(java.lang.String[] words,
                           float[] thresholds,
                           int[] majors,
                           int[] ranges)
```
    设置唤醒词
    
    Parameters:
    
    words - 唤醒词
    
    thresholds - 阈值
    
    majors - 1主 0副
    
    ranges - 是否定位模式下切换音区，1切换， 0 不切换
  - getDriveMode
```
public int getDriveMode()
```
    获取驾驶模式，只有车载双麦模块有这个功能
    
    Returns:
    
    0为定位模式, 按照声源定位;1为主驾模式;2为副驾模式;3为全车模式，-1 错误，没有获取到
  - setDriveMode
```
public void setDriveMode(int driveMode)
```
    动态设置唤醒env，在其中加入 driveMode 参数设置模式后，会取消beamforming指向。
    注意：设置为定位模式后，会根据唤醒角度自动设置为主驾或者副驾模式，对话完成后需要调用 notifyDialogEnd()
    
    Parameters:
    
    driveMode - 0为定位模式,按照声源定位; 1为主驾模式; 2为副驾模式; 3为全车模式
  - setDriveMode
```
public void setDriveMode(int driveMode,
                         int wakeupChannelMask)
```
  - setDoaManually
```
public void setDoaManually(int doa)
```
    在定位模式下，手动设置为主驾唤醒或者副驾唤醒
    
    Parameters:
    
    doa - 1为主驾唤醒; 2为副驾唤醒;
  - notifyDialogEnd
```
public void notifyDialogEnd()
```
    定位模式下通知引擎回正 beamforming 指向，定位模式下需要外部在结束对话状态后通知到引擎内部,和 AIFespCarIntent.setAutoHoldBeamforming(boolean) 配置搭配使用
  - resetDriveMode
```
public void resetDriveMode()
```
  - stop
```
public void stop()
```
    停止信号处理模块和唤醒引擎该方法会停止接收录音数据和停止信号处理，唤醒，程序退出时可以调用
    
    Overrides:
    
    stop in class BaseEngine
  - destroy
```
public void destroy()
```
    销毁信号处理模块和唤醒引擎该方法会停止录音机和销毁录音机
    
    Overrides:
    
    destroy in class BaseEngine
  - feedData
```
public void feedData(byte[] data,
                     int size)
```
    传入数据,在不使用SDK录音机时调用
    
    Parameters:
    
    data - 音频数据流
    
    size - 数据大小
    
    See Also:
    
    BaseIntent.setUseCustomFeed(boolean)
  - setResBin
```
public void setResBin(java.lang.String sspeBinPath,
                      java.lang.String wakeupBinPath,
                      boolean backRowRestrainEnable)
```
    动态设置 sspe（前端信号处理）与 wakeup（唤醒）资源
    
    Parameters:
    
    sspeBinPath - sspe资源
    
    wakeupBinPath - 唤醒资源
    
    backRowRestrainEnable - 后排抑制开关，true：开启、false：关闭
  - getFespxProcessor
```
public FespxProcessor getFespxProcessor()
```

Class AIFespCarEngine

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

Field Detail

FESP_CAR_DRIVE_MODE_POSITIONING

FESP_CAR_DRIVE_MODE_MAIN

FESP_CAR_DRIVE_MODE_COPILOT

FESP_CAR_DRIVE_MODE_ENTIRE

FESP_CAR_DRIVE_MODE_FREE_COMBINATION

COMBINATION_POSITION_MAIN

COMBINATION_POSITION_COPILOT

COMBINATION_POSITION_LEFT_BACKSEAT

COMBINATION_POSITION_RIGHT_BACKSEAT

COMBINATION_POSITION_ENTIRE

FESP_CAR_DOA_MAIN

FESP_CAR_DOA_COPILOT

FESP_CAR_DOA_LEFT_BACKSEAT

FESP_CAR_DOA_RIGHT_BACKSEAT

FESP_CAR_MIC_TWO

FESP_CAR_MIC_FOUR

FESPCAR_DOUBLEVAD_DATARECEIVED_ENABLE

FESPCAR_SINGLEVAD_DATARECEIVED_ENABLE

FESPCAR_MIXING_DATARECEIVED_ENABLE

Method Detail

getTag

getInstance

init

start

getValueOf

setBoundary

setWakeupWords

setWakeupWords

setWakeupWords

getDriveMode

setDriveMode

setDriveMode

setDoaManually

notifyDialogEnd

resetDriveMode

stop

destroy

feedData

setResBin

getFespxProcessor