SDK初始化

这里介绍的是Android API关于SDK初始化配置的相关说明，点击右侧目录可快速找到相应文件。

#类SpeechUtility

com.iflytek.cloud

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

#嵌套类概要

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

#字段概要

限定符和类型	字段和说明
static com.iflytek.cloud.msc.module.SpeechInterface.ENGINE_MODE	DEF_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

#方法概要

限定符和类型	字段和说明
static SpeechUtility	createUtility(android.content.Context context, java.lang.String params) 创建配置单例创建配置单例，同时，也是初始化SDK的操作。
boolean	destroy() 销毁单例对象通过本函数，销毁由createutility(android.content.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引擎的状态参数
static SpeechUtility	getUtility() 获取配置单例通过函数获取已创建的单例对象。
int	openEngineSettings(java.lang.String engineName) 打开引擎设置下载页面传入引擎名称，打开引擎设置。
java.lang.String[]	queryAvailableEngines() 查询本地组件支持的引擎列表引擎列表：local.tts，cloud.tts，local.asr
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

#字段详细资料

#DEF_ENGINE_MODE

public static final com.iflytek.cloud.msc.module.SpeechInterface.ENGINE_MODE DEF_ENGINE_MODE
默认引擎模式

#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(android.content.Context context,
                                          java.lang.String params)

创建配置单例

创建配置单例，同时，也是初始化SDK的操作。注册应用请前往讯飞开放平台。

参数：

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

返回： 配置对象

#getUtility

public static SpeechUtility getUtility()

获取配置单例

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

返回： 配置单例

另请参阅：createUtility(android.content.Context, java.lang.String), destroy()

#destroy

public boolean destroy()

销毁单例对象

通过本函数，销毁由createUtility(android.content.Context, java.lang.String)创建的单例对象，同时也是逆初始化SDK。
在调用本函数进行销毁前，应先保证所有业务的会话均已结束，否则可能引起在当前应用的生命周期内，无法再使用SDK进行业务会话的问题。
在调用本函数成功销毁对象后，createUtility(android.content.Context, java.lang.String) 创建实例前，将不能再使用。

覆盖： destroy 在类中 com.iflytek.cloud.msc.module.SpeechInterface

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

另请参阅： createUtility(android.content.Context, java.lang.String), getUtility()

#queryAvailableEngines

public java.lang.String[] queryAvailableEngines()

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

引擎列表：local.tts，cloud.tts，local.asr
如果返回为空，则表示需要提示用户下载组件，如果返回的引擎不满足需求，则通知组件下载引擎。

返回： 本地支持的引擎列表

#openEngineSettings

public int openEngineSettings(java.lang.String engineName)

打开引擎设置下载页面

传入引擎名称，打开引擎设置。

参数：

engineName - 引擎名称

返回： 错误码，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

#getEngineMode

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

获得引擎选择模式

返回： 引擎模式

另请参阅： SpeechConstant.ENGINE_MODE

#接口 InitListener

com.iflytek.cloud

public interface InitListener

#初始化回调接口简介

初始化单例对象时，通过此回调接口，获取初始化状态。

#方法概要

限定符和类型	字段和说明
void	onInit(int errorCode) 初始化结束回调初始化结束时，回调此接口通知应用层，初始的状态。

#方法详细资料

#onInit

void onInit(int errorCode)

初始化结束回调

初始化结束时，回调此接口通知应用层，初始的状态。若参数1的错误码值为ErrorCode .SUCCESS（0），则初始化成功；否则，初始化失败，不能使用单例。初始化失败时，可通过错误码，向ErrorCode 类查找错误码表示的原因，进行相应的处理。

参数：

errorCode - 错误码，0表示成功，详细错误码请看ErrorCode

#类SpeechUtility#

#SDK配置类简介#

#嵌套类概要#

#字段概要#

#方法概要#

#字段详细资料#

#DEF_ENGINE_MODE#

#TAG_RESOURCE_CONTENT#

#TAG_RESOURCE_RET#

#TAG_RESOURCE_RESULT#

#方法详细资料#

#createUtility#

#getUtility#

#destroy#

#queryAvailableEngines#

#openEngineSettings#

#getComponentUrl#

#setParameter#

#getParameter#

#getEngineMode#

#接口 InitListener#

#初始化回调接口简介#

#方法概要#

#方法详细资料#

#onInit#

#类SpeechUtility

#SDK配置类简介

#嵌套类概要

#字段概要

#方法概要

#字段详细资料

#DEF_ENGINE_MODE

#TAG_RESOURCE_CONTENT

#TAG_RESOURCE_RET

#TAG_RESOURCE_RESULT

#方法详细资料

#createUtility

#getUtility

#destroy

#queryAvailableEngines

#openEngineSettings

#getComponentUrl

#setParameter

#getParameter

#getEngineMode

#接口 InitListener

#初始化回调接口简介

#方法概要

#方法详细资料

#onInit