com.iflytek.cloud

类 SpeechUtility

java.lang.Object

com.iflytek.cloud.msc.module.SpeechInterface

com.iflytek.cloud.SpeechUtility

public class SpeechUtility
extends com.iflytek.cloud.msc.module.SpeechInterface

SDK配置类

本类为SDK入口类，除Setting、Version类外，第一次使用任意一个其 他的业务类前，都至少创建一次本类的实例，以初始化SDK。

本类使用单例，调用者使用本类的对象，只需要通过createUtility(Context, java.lang.String)创建 一次对象后，便可一直使用该对象，直到通过调用destroy()进行单例对象销毁。调 用者可通过getUtility()获取当前已经创建的单例。在销毁本类的单例对象后， 需要先通过createUtility(Context, java.lang.String)再次创建单例对象，方可再使用。

从以下版本开始:

version:1073

作者:

另请参阅:

SpeechRecognizer, SpeechSynthesizer, SpeechUnderstander, TextUnderstander, SpeakerVerifier

嵌套类概要

从类继承的嵌套类/接口 com.iflytek.cloud.msc.module.SpeechInterface

com.iflytek.cloud.msc.module.SpeechInterface.ENGINE_MODE

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	TAG_RESOURCE_CONTENT 本地资源信息JSON格式的字符串类型
static java.lang.String	TAG_RESOURCE_RESULT 本地资源信息JSON返回的result
static java.lang.String	TAG_RESOURCE_RET 本地资源信息JSON返回的code

方法概要

限定符和类型	方法和说明
boolean	checkServiceInstalled() 检查服务安装状态
static SpeechUtility	createUtility(Context context, java.lang.String params) 创建配置单例 创建配置单例，同时，也是初始化SDK的操作。
boolean	destroy() 销毁单例对象 通过本函数，销毁由createUtility(Context, java.lang.String)创建的单例对象，同时也是逆 初始化SDK。
java.lang.String	getComponentUrl() 直接获取组件下载地址
com.iflytek.cloud.msc.module.SpeechInterface.ENGINE_MODE	getEngineMode() 获得引擎选择模式
java.lang.String	getParameter(java.lang.String key) 获取MSC引擎的状态参数
java.lang.String	getPlusLocalInfo(java.lang.String key) key可设置的参数有: SpeechConstant.PLUS_LOCAL_ALL：所有资源 SpeechConstant.PLUS_LOCAL_TTS：合成资源} SpeechConstant.PLUS_LOCAL_ASR：识别资源} SpeechConstant.PLUS_LOCAL_IVW：唤醒资源}
int	getServiceVersion() 获取服务的版本信息
static SpeechUtility	getUtility() 获取配置单例 通过函数获取已创建的单例对象。
int	openEngineSettings(java.lang.String engineName) 打开引擎设置下载页面
java.lang.String[]	queryAvailableEngines() 查询本地组件支持的引擎列表 引擎列表：local.tts，cloud.tts，local.asr，cloud.asr，local.nlu，cloud.nlu 更多请参考开发者网站：。
boolean	setParameter(java.lang.String key, java.lang.String value) 设置MSC引擎的状态参数

从类继承的方法 com.iflytek.cloud.msc.module.SpeechInterface

setParameter

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

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

TAG_RESOURCE_CONTENT

public static final java.lang.String TAG_RESOURCE_CONTENT

本地资源信息JSON格式的字符串类型

另请参阅:

常量字段值

TAG_RESOURCE_RET

public static final java.lang.String TAG_RESOURCE_RET

本地资源信息JSON返回的code

另请参阅:

常量字段值

TAG_RESOURCE_RESULT

public static final java.lang.String TAG_RESOURCE_RESULT

本地资源信息JSON返回的result

另请参阅:

常量字段值

方法详细资料

createUtility

public static SpeechUtility createUtility(Context context,
                                          java.lang.String params)

创建配置单例

创建配置单例，同时，也是初始化SDK的操作。

注册应用请前往开发者网站，。

参数:

params - 启动参数，包含以下参数：
SpeechConstant.APPID，必须，如：12345678；
server_url，可选，如：；
SpeechConstant.LIB_NAME，可选，如：mylibname；
各参数间，以英文逗号分隔，如"appid=12345678,server_url= ,lib_name=mylibname"。

返回:

配置对象

getUtility

public static SpeechUtility getUtility()

获取配置单例

通过函数获取已创建的单例对象。当单例对象未创建时，将返回null，此时应先通过 createUtility(Context, java.lang.String)创建单例对象。

返回:

配置单例

另请参阅:

createUtility(Context, java.lang.String), destroy()

destroy

public boolean destroy()

销毁单例对象

通过本函数，销毁由createUtility(Context, java.lang.String)创建的单例对象，同时也是逆 初始化SDK。

在调用本函数进行销毁前，应先保证所有业务的会话均已结束，否则可能引起在 当前应用的生命周期内，无法再使用SDK进行业务会话的问题。

在调用本函数成功销毁对象后，所有业务会话在下一次通过createUtility(Context, java.lang.String) 创建实例前，将不能再使用。

返回:

销毁成功：true；销毁失败：false。

另请参阅:

createUtility(Context, java.lang.String), getUtility()

checkServiceInstalled

public boolean checkServiceInstalled()

检查服务安装状态

返回:

true, 已安装；false，未安装。

另请参阅:

SpeechConstant.ENGINE_MODE

queryAvailableEngines

public java.lang.String[] queryAvailableEngines()

查询本地组件支持的引擎列表

引擎列表：local.tts，cloud.tts，local.asr，cloud.asr，local.nlu，cloud.nlu
更多请参考开发者网站：。 如果返回为空，则表示需要提示用户下载组件，如果返回的引擎不满足需求，则通知组件下载引擎。

返回:

本地支持的引擎列表

openEngineSettings

public int openEngineSettings(java.lang.String engineName)

打开引擎设置下载页面

参数:

engineNames - 引擎名称

返回:

错误码，0表示成功

getComponentUrl

public java.lang.String getComponentUrl()

直接获取组件下载地址

setParameter

public boolean setParameter(java.lang.String key,
                            java.lang.String value)

设置MSC引擎的状态参数

覆盖:

setParameter 在类中 com.iflytek.cloud.msc.module.SpeechInterface

参数:

key - 参数名称

value - 参数值

返回:

错误码，0表示成功

另请参阅:

SpeechConstant

getParameter

public java.lang.String getParameter(java.lang.String key)

获取MSC引擎的状态参数

覆盖:

getParameter 在类中 com.iflytek.cloud.msc.module.SpeechInterface

参数:

key - 参数名称

返回:

参数值

另请参阅:

SpeechConstant

getPlusLocalInfo

public java.lang.String getPlusLocalInfo(java.lang.String key)
                                  throws JSONException

key可设置的参数有:
SpeechConstant.PLUS_LOCAL_ALL：所有资源
SpeechConstant.PLUS_LOCAL_TTS：合成资源}
SpeechConstant.PLUS_LOCAL_ASR：识别资源}
SpeechConstant.PLUS_LOCAL_IVW：唤醒资源}

参数:

key -

返回:

抛出:

JSONException

getEngineMode

public com.iflytek.cloud.msc.module.SpeechInterface.ENGINE_MODE getEngineMode()

获得引擎选择模式

返回:

引擎模式

另请参阅:

SpeechConstant.ENGINE_MODE

getServiceVersion

public int getServiceVersion()

获取服务的版本信息

返回:

服务版本号