java.lang.Object
com.iflytek.cloud.msc.module.SpeechInterface
com.iflytek.cloud.VoiceWakeuper
public class VoiceWakeuper extends com.iflytek.cloud.msc.module.SpeechInterface| 从类继承的嵌套类/接口 com.iflytek.cloud.msc.module.SpeechInterface |
|---|
com.iflytek.cloud.msc.module.SpeechInterface.ENGINE_MODE |
| 限定符和类型 | 方法和说明 |
|---|---|
void | cancel() 取消会话 通过此函数取消当前的会话。 |
static VoiceWakeuper | createWakeuper(android.content.Context context, InitListener listener) 创建单例对象 使用此函数创建一个本类单例对象。 |
boolean | destroy() 销毁单例对象 通过本函数,销毁由createWakeuper(android.content.Context, com.iflytek.cloud.InitListener)创建的单例对象。 |
int | downloadResource(java.lang.String downloadUrl, java.lang.String filePath, java.lang.String fileMd5, FileDownloadListener listener) 下载唤醒词资源 调用此函数,通过参数传入下载url和文件保存路径,可下载资源至相应路径目录下。 |
java.lang.String | getParameter(java.lang.String key) 获取参数 获取指定的参数的当前值。 |
static VoiceWakeuper | getWakeuper() 获取单例对象 通过函数获取已创建的单例对象。 |
boolean | isListening() 是否在会话中 通过此函数,获取当前SDK是否正在进行会话。 |
int | queryResource(java.lang.String resourcePath, RequestListener listener) 查询唤醒词资源 调用此函数,查询唤醒词优化资源,能够查询的前提是应用开启唤醒闭环优化, 并且云端成功训练出唤醒词优化资源,调用此函数发送查询请求,若有优化的模型 资源,会返回开发者相应的资源下载链接,如果开发者未开启唤醒闭环优化功能, 此函数会通过回调监听返回相应错误码 调用此函数仅仅模型查询,下载模型资源请参考downloadResource(java.lang.String, java.lang.String, java.lang.String, com.iflytek.cloud.util.FileDownloadListener) 注:该接口仅加强型支持,基础性暂无优化功能 |
boolean | setParameter(java.lang.String key, java.lang.String value) 参数设置 可设置的参数有: SpeechConstant.IVW_SST:唤醒类务类型,必须; SpeechConstant.IVW_THRESHOLD:唤醒门限值; SpeechConstant.KEEP_ALIVE:持续唤醒; SpeechConstant.IVW_RES_PATH:唤醒资源路径,必须; SpeechConstant.ENGINE_TYPE:引擎类型;(在唤醒里,引擎类型 仅作用于唤醒识别时的识别部分,而唤醒部分始终在离线模式。) |
int | startListening(WakeuperListener listener) 开始录音 调用此函数,开始唤醒和注册会话。 |
void | stopListening() 停止录音 调用本函数告知SDK,当前会话音频已全部录入。 |
int | [writeAudio(byte] buffer, int offset, int length) 写入录音数据 通过调用此函数,把音频数据传给SDK。 |
| 从类继承的方法 com.iflytek.cloud.msc.module.SpeechInterface |
|---|
| setParameter |
| 从类继承的方法 java.lang.Object |
|---|
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public static VoiceWakeuper createWakeuper(android.content.Context context,
InitListener listener)public static VoiceWakeuper getWakeuper()public int downloadResource(java.lang.String downloadUrl,
java.lang.String filePath,
java.lang.String fileMd5,
FileDownloadListener listener)public int startListening(WakeuperListener listener)public int writeAudio(byte[] buffer,
int offset,
int length)public void stopListening()public boolean isListening()public void cancel()public boolean setParameter(java.lang.String key,
java.lang.String value)public java.lang.String getParameter(java.lang.String key)public boolean destroy()java.lang.Object
com.iflytek.cloud.WakeuperResultpublic class WakeuperResult
extends java.lang.Object
implements android.os.Parcelable| 从接口继承的嵌套类/接口 android.os.Parcelable |
|---|
android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T> |
| 限定符和类型 | 字段和说明 |
|---|---|
static android.os.Parcelable.Creator<WakeuperResult> | CREATOR |
| 从接口继承的字段 android.os.Parcelable |
|---|
| CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE |
| 构造器和说明 |
|---|
WakeuperResult(android.os.Parcel in) |
| WakeuperResult(java.lang.String result) 构造函数 应用层只通过WakeuperListener.onResult(com.iflytek.cloud.WakeuperResult)得到结果,可忽略此类的构造函数。 |
WakeuperResult(java.lang.String result, byte[] buffer) |
| 限定符和类型 | 方法和说明 |
|---|---|
int | describeContents() |
byte[] | getBuffer() 获取唤醒音频 唤醒音频,仅在SpeechConstant.IVW_CHANNEL_NUM大于0时, 有意义,其他时侯为null。 |
java.lang.String | getResultString() 获取唤醒结果 结果各参数请参考类说明。 |
void | writeToParcel(android.os.Parcel dest, int flags) |
| 从类继承的方法 java.lang.Object |
|---|
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public static final android.os.Parcelable.Creator<WakeuperResult> CREATORpublic WakeuperResult(java.lang.String result,
byte[] buffer)public WakeuperResult(android.os.Parcel in)public WakeuperResult(java.lang.String result)public int describeContents()public java.lang.String getResultString()public byte[] getBuffer()public void writeToParcel(android.os.Parcel dest,
int flags)public interface WakeuperListener| 限定符和类型 | 方法和说明 |
|---|---|
void | onBeginOfSpeech() 开始说话 在录音模式(音频源参数设为 > -1时 )下, 调用开始录音函数后,会自动开启系统的录音 机,并在录音机开启后,会回调此函数(这中间的过程应该在几毫秒内,可以忽略,除非系 统响应很慢)。 |
void | onError(SpeechError error) 错误回调 当此函数回调时,说明当次会话出现错误,会话自动结束,录音也会停止。 |
void | onEvent(int eventType, int arg1, int arg2, android.os.Bundle obj) 事件 扩展用接口,唤醒的主要事件是音频事件,以及在唤醒识别时,返回识别结果(在唤醒结果之后返回)。 |
void | onResult(WakeuperResult result) 返回结果 返回的结果可能为null,请增加判断处理。 |
void | onVolumeChanged(int volume) 音量变化 当开始录音,到停止录音(停止写入音频流)为止, SDK检测到音频数据(正在录音或写入音频流)的音量变化时,会多次通过此函数回调,告 知应用层当前的音量值。 |
void onBeginOfSpeech()void onResult(WakeuperResult result)void onError(SpeechError error)void onEvent(int eventType,
int arg1,
int arg2,
android.os.Bundle obj)void onVolumeChanged(int volume)