# Java SDK 基础类

# 类SpeechConstant

java.lang.Object
com.iflytek.cloud.speech.SpeechConstant
public class SpeechConstant
extends java.lang.Object

# 公共常量

本类定义语音SDK用到的参数名。

除了初始化SDK时，可通过SpeechUtility.createUtility(String) (opens new window)设置参数外，其他如合成，识别等会话的参数设置需要通过相关类的 setParameter 函数来设置。

SDK设置参数值均以String型的字符串传入，对于本类中说明的值范围中可能涉及的 int等类型的数值，请自行转换到对应的String字符串值后传给SDK，如 String.valueOf(int)。同样的，通过获取参数值函数返回的值，也以 String值表示，请自行转换到对应的值，如Integer.parseInt(String)。

在参数值域中，如果只有{ null, 0, 1 }的范围，则表示这是布尔(boolean)型的参数，其中，null表示空，0表示false，1表示true。

# 字段概要

限定符和类型	字段和说明
`static java.lang.String`	ACCENT方言每一种语言区域，一般还有不同的方言，通过此参数设置不同的方言参数。
`static java.lang.String`	APPID应用ID 初始化SDK时，需要传入APPID值。
`static java.lang.String`	ASR_AUDIO_PATH识别音频保存路径通过此参数，可以在识别完成后在本地保存一个音频文件（目前保存为Windows pcm）。
`static java.lang.String`	ASR_NBEST句子多侯选听写通过设置此参数，获取在发音相似时的句子多侯选结果。
`static java.lang.String`	ASR_NET_PERF网络状态反馈值通过此参数，获取网络连接状态（仅在识别和听写）。
`static java.lang.String`	ASR_PTT标点符号通过此参数，设置听写文本结果是否含标点符号。
`static java.lang.String`	ASR_SOURCE_PATH音频源路径 java平台暂不支持外部音频文件的路径，在直接听写、识别音频文件时可通过设置此参数，传入文件的路径，SDK自动读取文件进行识别，不用应用层调用WriteAudio接口。
`static java.lang.String`	ASR_WBEST词语多侯选听写通过设置此参数，获取在发音相似时的词语多侯选结果。
`static java.lang.String`	AUDIO_FORMAT合成音频文件格式 java平台暂不支持参数
`static java.lang.String`	AUDIO_SOURCE音频源设置使用SDK自带的录音机，还是应用传入音频流方式。
`static java.lang.String`	BACKGROUND_SOUND背景音乐背景音乐默认值:无，可选：1 是否必须设置：否默认值：0 值范围：{ null, 0, 1 }
`static java.lang.String`	DATA_TYPE数据类型设置个性化数据上传的数据类型。
`static java.lang.String`	DOMAIN应用领域服务器为不同的应用领域，定制了不同的听写匹配引擎，使用对应的领域能获取更高的匹配率。
`static java.lang.String`	ENG_ASR常量值：识别引擎
`static java.lang.String`	ENG_IVW常量值：唤醒引擎
`static java.lang.String`	ENG_TTS常量值：合成引擎
`static java.lang.String`	ENGINE_MODE客户端引擎选择模式 java平台暂不支持此参数。
`static java.lang.String`	ENGINE_TYPE引擎类型设置使用的引擎类型：在线、离线。
`static java.lang.String`	FILTER_AUDIO_TIME需要过滤的音频时长部分系统存在启动录音后，有短暂的音频跳变，通过设置此参数，可以过滤掉此部分音频，提高识别效果。
`static java.lang.String`	GRAMMAR_LIST语法列表名 java平台暂不支持此参数在本地语法识别时，在构建语法后，可通过`SpeechRecognizer.updateLexicon(String, String, LexiconListener)` (opens new window)更新语法中指定的词表，如本地语法“call”中的"contact"，则指定本参数值为"call"，在`SpeechRecognizer.updateLexicon(String, String, LexiconListener)` (opens new window)的参数1中指定值为"contact"。
`static java.lang.String`	GRAMMAR_NAME语法名称上传语法时的语法名字。
`static java.lang.String`	GRAMMAR_TYPE语法类型在使用识别识别时，需要设置与使用的类型一致语法类型的参数。
`static java.lang.String`	KEY_SPEECH_TIMEOUT语音输入超时时间设置录取音频的最长时间。
`static java.lang.String`	LANGUAGE语言区域听写可通过设置此参数，选择要使用的语言区域，参考 Java标准组织定义 `Locale`。
`static java.lang.String`	LIB_NAME_3232位系统下的共享库名字自定义在32位的系统下，初始化SDK时，要加载的库名字。
`static java.lang.String`	LIB_NAME_6464位系统下的共享库名字自定义在64位的系统下，初始化SDK时，要加载的库名字。
`static java.lang.String`	LOCAL_GRAMMAR本地语法ID java平台暂不支持在使用本地功能时，通过设置此参数，使用本地语法识别。
`static java.lang.String`	MODE_MSC常量值：MSC模式
`static java.lang.String`	NET_TIMEOUT网络连接超时时间设置等待结果最长的时间（毫秒）。
`static java.lang.String`	PARAMS多参数设置通过本参数可能同时设置多个参数值。
`static java.lang.String`	PITCH合成语调通过此参数，设置合成返回音频的语调。
`static java.lang.String`	RESULT_TYPE结果类型听写，识别（命令词）返回文本结果类型。
`static java.lang.String`	SAMPLE_RATE音频采样率通过此参数设置音频的采样率。
`static java.lang.String`	SPEED合成语速通过此参数，设置合成返回音频的语速。
`static java.lang.String`	STREAM_TYPE合成播放流类型 java平台暂不支持此参数。
`static java.lang.String`	TEXT_ENCODING文本编码格式合成传入文本，或构建语法、个性化词典，听写、识别结果的文本编码格式。
`static java.lang.String`	TTS_AUDIO_PATH合成音频保存路径通过此参数，可以在合成完成后在本地保存一个音频文件（目前保存为Windows pcm）。
`static java.lang.String`	TTS_BUFFER_EVENT是否启用合成音频流事件当启用合成音频流事件时，通过`SynthesizerListener.onEvent(int, int, int, int, Object, Object)` (opens new window) 返回`SpeechEvent.EVENT_TTS_BUFFER` (opens new window)事件。
`static java.lang.String`	TTS_BUFFER_TIME合成播放缓冲时间在合成使用SDK进行播放时，设置此参数使合成音频更快播放。
`static java.lang.String`	TYPE_CLOUD常量值：云端引擎
`static java.lang.String`	TYPE_LOCAL常量值：本地引擎
`static java.lang.String`	VAD_BOS前端点超时开始录入音频后，音频前面部分最长静音时长。
`static java.lang.String`	VAD_EOS后端点超时是否必须设置：否开始录入音频后，音频后面部分最长静音时长。
`static java.lang.String`	VOICE_NAME合成发音人通过此参数，在合成中使用不同的语言和方言、性别等。
`static java.lang.String`	VOLUME合成音量通过此参数，设置合成返回音频的音量。
`static java.lang.String`	WAP_PROXY网络类型设置当前应用使用的网络类型。

# 方法概要

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

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

# 字段详细资料

# APPID
```
public static final java.lang.String APPID
```
# 应用ID

初始化SDK时，需要传入APPID值。服务器将根据应用的APPID认证应用接入的权限和个性化的数据，如用户词表等。APPID需要与使用的SDK一致，否则，将报 ErrorCode.MSP_ERROR_DB_INVALID_APPID (opens new window)的错误。SDK和APPID的申请可通过讯飞开放平台 (opens new window)申请。

是否必须设置：是

默认值：无

值范围：与SDK一致的十六进制String类型字符串
- 另请参阅:
  
  SpeechUtility.createUtility(String) (opens new window) 常量字段值 (opens new window)
# LIB_NAME_32
```
public static final java.lang.String LIB_NAME_32
```
# 32位系统下的共享库名字

自定义在32位的系统下，初始化SDK时，要加载的库名字。

在java SDK使用时，与服务器交互、音频编解码等模块，都在共享库中，在SDK使用时，必需使用这些库才可以正常使用功能。关于java使用C共享库函数的知识，请自行查找JNI （Java Native Interface）的相关资料。

SDK默认的库文件名为：libmsc32.so（32位Linux系统下），msc32.dll（32位 Windows系统下），libmsc64.so（64位Linux系统下），msc64.dll（64位Windows系统下）。系统默认32位的库名为"msc32"，默认64位的库名为"msc64"。

若应用层需要自定义库名，文件名为“libmylibname.so”或“mylibname.dll”时，则设置此参数值为“mylibname”。

如果库文件参数设置不正常，或者路径配置不对，会引起使用时加载库失败的错误： java.lang.Unsatisfie.lang.UnsatisfiedLinkError no injava.library.path。关于路径配置，请参考Java 常见问题解答 (opens new window)

是否必须设置：否

默认值："msc32"

值范围：与共享库名一致的字符串
- 另请参阅: SpeechUtility.createUtility(java.lang.String) (opens new window), 常量字段值 (opens new window)
# LIB_NAME_64
```
public static final java.lang.String LIB_NAME_64
```
# 64位系统下的共享库名字

自定义在64位的系统下，初始化SDK时，要加载的库名字。其他内容解释请参考 LIB_NAME_32的说明。

是否必须设置：否

默认值："msc64"

值范围：与共享库名一致的字符串
- 另请参阅:
  
  SpeechUtility.createUtility(java.lang.String) (opens new window), 常量字段值 (opens new window)
# RESULT_TYPE
```
public static final java.lang.String RESULT_TYPE
```
# 结果类型

听写，识别（语法、命令词）返回文本结果类型。

结果类型包括：xml, json, plain。xml和json即对应的结构化文本结构，plain即自然语言的文本，多用于听写结果。关于xml和json格式的参数说明，请参考新手指南文档。xml和json格式多用于语法中，在结果中获取置信度值。

识别会话，支持所有结果类型，默认json。听写会话支持json和plain。

是否必须设置：否

默认值："json"

值范围：{ "json", "xml", "plain" }
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), RecognizerResult (opens new window), 常量字段值 (opens new window)
# LANGUAGE
```
public static final java.lang.String LANGUAGE
```
# 语言区域

在听写解时，可通过设置此参数，选择要使用的语言区域，参考 Java标准组织定义 Locale。在语法时，不支持语言区域选择，当前语法识别仅支持简体中文。关于合成的语言选择，请参考 VOICE_NAME。关于方言选择，请参考ACCENT。

当前支持：简体中文：zh_cn（默认）美式英文：en_us

是否必须设置：否

默认值："zh_cn"

值范围：{ "zh_cn", "en_us" }
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# ACCENT
```
public static final java.lang.String ACCENT
```
# 方言

每一种语言区域，一般还有不同的方言，通过此参数，在听写时设置不同的方言参数。

当前仅在LANGUAGE为简体中文时，支持方言选择，其他语言区域时，请把此参数值设为null。

当前支持的中文方言有：
普通话：mandarin(默认)
粤语：cantonese
四川话：lmz
河南话：henanese
其他方言请到控制台确认。

关于合成的方言选择，请参考VOICE_NAME。关于语言区域的选择，请参考LANGUAGE。

是否必须设置：否

默认值："mandarin"

值范围：{ null, "mandarin", "cantonese", "lmz", "henanese" }
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# DOMAIN
```
public static final java.lang.String DOMAIN
```
# 应用领域

服务器为不同的应用领域，定制了不同的听写匹配引擎，使用对应的领域能获取更高的匹配率。

应用领域用于听写服务。当前支持的应用领域有：短信和日常用语：iat (默认) 医疗：medical（需开权限）

是否必须设置：否

默认值："iat"

值范围：{ "iat", "medical"}
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# VAD_BOS
```
public static final java.lang.String VAD_BOS
```
# 前端点超时

开始录入音频后，音频前面部分最长静音时长。

VAD（Voice Activity Detection,静音抑制）是用于在音频传输时，通过控制音频的静音时长，减少在网络传输没有意义的数据，以减少网络带宽使用等。关于VAD的具体介绍，请自行查找相关的资料。

SDK为了减少网络带宽，同时又可以自动的根据用户停止说话时的静音来自动结束音频输入，使用了VAD技术。本参数正是在应用VAD时用于录入音频开始后（包括使用SDK录音机模式或应用写入音频流模式，见AUDIO_SOURCE），前面部份静音的最长时间控制，当音频的前静音时长超过设置值时，SDK就会认为音频输入已完成。此时，SDK会通过RecognizerListener.onError(SpeechError) (opens new window)结束会话，并携带错误码为ErrorCode.MSP_ERROR_NO_DATA (opens new window)的错误信息。

是否必须设置：否

默认值：听写5000，其他4000

值范围：[1000, 10000]
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# VAD_EOS
```
public static final java.lang.String VAD_EOS
```
# 后端点超时

是否必须设置：否

开始录入音频后，音频后面部分最长静音时长。其他详情，请参考VAD_BOS。

是否必须设置：否

默认值：听写1800，其他700

值范围：[0, 10000]
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# SAMPLE_RATE
```
public static final java.lang.String SAMPLE_RATE
```
# 音频采样率

通过此参数设置音频的采样率。

音频的采样率是音频属性的其中一个，一般来说，采样率越高音频的质量越好，识别的匹配率越高，但上传带宽消耗也越大。关于音频采样率的具体说明请自行查找相关的资料。

采样率设置应该与实际传入的音频一致，否则将无法识别。在使用SDK录音模式时， SDK将根据设置的采样率录取对应音频。同时，不同的业务功能支持的采样率可能不一样，本参数只列举普遍支持的值，对于具体业务不支持的采样率，请参考对应的类的 setParameter函数的说明。

是否必须设置：否

默认值：16000

值范围：{8000, 16000}
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), SpeechSynthesizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# PARAMS
```
public static final java.lang.String PARAMS
```
# 多参数设置

通过本参数可能同时设置多个参数值。特别地，如果设置本参数值为null，将清空所有设置过的参数，还原为默认值。

设置多参数时，参数名与参数值间，以"="连接，各参数间以","连接。（参数名与参数值间，各参数间无空格）如"vad_bos=1000,vad_eos=700"。为了减少字符串的手误，我们建议在没有必要时，还是使用普通的一次设置单个参数值的方式。

是否必须设置：否

默认值：无

值范围：有效的String类型参数集成
- 另请参阅:
  
  常量字段值 (opens new window)
# WAP_PROXY
```
public static final java.lang.String WAP_PROXY
```
# 网络类型

设置当前应用使用的网络类型。

SDK通过应用设置的不同网络类型，采用不同的优化，提高网络交互速度，减少带宽占用。默认的，SDK内会获取当前设备的网络类型（在Android等平台时），应用可不设置此参数。

是否必须设置：否

默认值：无

值范围： { null, "wifi", "cmwap", "ctwap", "uniwap", "cmnet", "uninet", "ctnet", "3gnet" }
- 另请参阅:
  
  SpeechUtility.createUtility(String) (opens new window), 常量字段值 (opens new window)
# NET_TIMEOUT
```
public static final java.lang.String NET_TIMEOUT
```
# 网络连接超时时间

设置等待结果最长的时间（毫秒）。当超过设置的时间还没返回结果时，SDK将主动结束会话。Msc.jar和共享库都有超时控制，默认下，Msc.jar超时时间为20000 ms，共享库超时时间为10000ms，此参数将同时设置Msc.jar和共享库的超时时间。如果Msc.jar超时将回调ErrorCode.ERROR_NETWORK_TIMEOUT (opens new window)错误码。共享库报的网络连接超时的错误码是ErrorCode.MSP_ERROR_TIME_OUT (opens new window)。因为Msc.jar使用的超时判断策略和共享库的不一样，即使SDK会把值设置一样，但两边的超时时间会有先后，当回调最先的一个错误后，另一个错误将被忽略。

是否必须设置：否

默认值：20000

值范围：[0, 30000]
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), SpeechSynthesizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# KEY_SPEECH_TIMEOUT
```
public static final java.lang.String KEY_SPEECH_TIMEOUT
```
# 语音输入超时时间

设置录取音频的最长时间。在听写、识别和声纹等需要录入音频的业务下，在录音模式时，录取音频的最长时间。当录音超过这个时间时，SDK会自动结束录音，并等待结果返回。

是否必须设置：否

默认值：60000

值范围：[0, 60000]
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# ENGINE_MODE
```
public static final java.lang.String ENGINE_MODE
```
# 客户端引擎选择模式

java平台暂不支持此参数。

设置使用的引擎模式：语音+、MSC、自动。此参数只在Android和iOS平台有用。

在Android和iOS平台，通过语音+可以免费使用本地功能。关于语音+的介绍，请参考我们的官网。与语音+中服务通信方式相比，另一种即直接通过SDK提供的接口和共享库使用语音服务，我们称之为MSC方式。在引擎选择有三种模式可选， auto：表示云端优先使用MSC，本地优先使用语音+； msc：只使用MSC； plus：只使用语音+。

是否必须设置：否

默认值："auto"

值范围：{ "msc", "plus", "auto" }
- 另请参阅:
  
  ENGINE_TYPE, SpeechRecognizer.setParameter(String, String) (opens new window), SpeechSynthesizer.setParameter(String, String) (opens new window),SpeechUtility.createUtility(String) (opens new window), 常量字段值 (opens new window)
# ENGINE_TYPE
```
public static final java.lang.String ENGINE_TYPE
```
# 引擎类型

设置使用的引擎类型：在线、离线。在申请了离线合成资源和权限，可以选择使用本地或在线的方式进行语音服务。

使用在线模式（又称云端模式）时，需要使用网络，产生一定流量，但有更好的识别或合成的效果，如更高的识别匹配度，更多的发音人等。

使用离线模式（又称本地模式）时，不需要使用网络，且识别和合成的速度更快。关于离线资源的设置，请参考ResourceUtil类说明。java平台暂不支持离线模式。

是否必须设置：否

默认值："cloud"

值范围：{ "cloud", "local"}
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), SpeechSynthesizer.setParameter(String, String) (opens new window), SpeechUtility.createUtility(String) (opens new window), 常量字段值 (opens new window)
# AUDIO_SOURCE
```
public static final java.lang.String AUDIO_SOURCE
```
# 音频源

设置使用SDK自带的录音机，还是应用传入音频流方式。

录音机的录音方式(值为1)时，SDK自动获取用户通过麦克风输入的音频；在写音频流方式(-1)下，应用层通过WriteAudio接口送入音频。

是否必须设置：否

默认值：1

值范围：{ -1, 1 }
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# ASR_SOURCE_PATH
```
public static final java.lang.String ASR_SOURCE_PATH
```
# 音频源路径

java平台暂不支持

外部音频文件的路径，在直接听写、识别音频文件时可通过设置此参数，传入文件的路径，SDK自动读取文件进行识别，不用应用层调用WriteAudio接口。目前还不支持。

是否必须设置：否

默认值：null

值范围：String类型值的文件路径（含文件名）
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# FILTER_AUDIO_TIME
```
public static final java.lang.String FILTER_AUDIO_TIME
```
# 需要过滤的音频时长

部分系统存在启动录音后，有短暂的音频跳变，通过设置此参数，可以过滤掉此部分音频，提高识别效果。

是否必须设置：否

默认值：0

值范围：[0, 60000]
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# LOCAL_GRAMMAR
```
public static final java.lang.String LOCAL_GRAMMAR
```
# 本地语法ID

java平台暂不支持

在使用本地功能时，通过设置此参数，使用本地语法识别。当此参数值为 null 时SDK 将使用本地听写。

是否必须设置：否

默认值：null

值范围：有效的String类型语法ID
- 另请参阅:
  
  SpeechRecognizer.buildGrammar(String, String, GrammarListener) (opens new window), SpeechRecognizer.setParameter(String, String) (opens new window), SpeechRecognizer.startListening(RecognizerListener) (opens new window), 常量字段值 (opens new window)
# GRAMMAR_TYPE
```
public static final java.lang.String GRAMMAR_TYPE
```
# 语法类型

在使用识别识别时，需要设置与使用的类型一致语法类型的参数。构建本地语法，仅支持"bnf"。是否必须设置：否

默认值：null

值范围：{ null, "bnf", "url-list" }
- 另请参阅:
  
  SpeechRecognizer.buildGrammar(String, String, GrammarListener) (opens new window), SpeechRecognizer.startListening(RecognizerListener) (opens new window), SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# GRAMMAR_NAME
```
public static final java.lang.String GRAMMAR_NAME
```
# 语法名称

上传语法时的语法名字。目前上传语法后，暂不能通过语法名字使用，此参数为可选参数。

是否必须设置：否

默认值：null

值范围：任意字符串值
- 另请参阅:
  
  SpeechRecognizer.buildGrammar(String, String, GrammarListener) (opens new window), SpeechRecognizer.startListening(RecognizerListener) (opens new window), SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# GRAMMAR_LIST
```
public static final java.lang.String GRAMMAR_LIST
```
# 语法列表名

java平台暂不支持此参数

在本地语法识别时，在构建语法后，可通过 SpeechRecognizer.updateLexicon(String, String, LexiconListener) (opens new window)更新语法中指定的词表，如本地语法“call”中的"contact"，则指定本参数值为"call"，在 SpeechRecognizer.updateLexicon(String, String, LexiconListener) (opens new window)的参数1中指定值为"contact"。

是否必须设置：否

默认值：null

值范围：有效的String类型语法名字
- 另请参阅:
  
  SpeechRecognizer.updateLexicon(String, String, LexiconListener) (opens new window), SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# ASR_NBEST
```
public static final java.lang.String ASR_NBEST
```
# 句子多侯选

在听写和语法、命令词识别时，通过设置此参数，获取在发音相似时的句子多侯选结果。设置多候选会影响性能，响应时间延迟200ms左右。

是否必须设置：否

默认值：听写：1，语法或命令词：在线 3，本地 1

值范围：听写：[1, 5]，语法或命令词：在线[0, 10]，本地{0, 1}
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# ASR_WBEST
```
public static final java.lang.String ASR_WBEST
```
# 词语多侯选

在听写和语法、命令词识别时，通过设置此参数，获取在发音相似时的词语多侯选结果。设置多候选会影响性能，响应时间延迟200ms左右。

是否必须设置：否

默认值：听写：1，语法或命令词：在线 3，本地 1

值范围：听写：[1, 5]，语法或命令词：在线[0, 10]，本地{0, 1}
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# ASR_PTT
```
public static final java.lang.String ASR_PTT
```
# 标点符号

通过此参数，设置听写文本结果是否含标点符号。0表示不带标点，1则表示带标点。

是否必须设置：否

默认值：1

值范围：{ null, 0，1 }
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# TYPE_LOCAL
```
public static final java.lang.String TYPE_LOCAL
```
# 常量值：本地引擎
- 另请参阅:
  
  ENGINE_TYPE, 常量字段值 (opens new window)
# TYPE_CLOUD
```
public static final java.lang.String TYPE_CLOUD
```
# 常量值：云端引擎
- 另请参阅:
  
  ENGINE_TYPE, 常量字段值 (opens new window)
# VOICE_NAME
```
public static final java.lang.String VOICE_NAME
```
# 合成发音人

通过此参数，在合成中使用不同的语言和方言、性别等。设置的发音人，语速，语调，音量，在一次合成时开始后，就会在合成的音频中生效，此时，若要中途改变这些参数，则应该从想要改变的文本处重新开始合成，因为已经返回的音频是无法再改变的。

云端支持发音人：请前往讯飞开放平台控制台确认

本地支持发音人: 请前往这里 (opens new window)确认

是否必须设置：否

默认值：xiaoyan

值范围：见上文。
- 另请参阅:
  
  SpeechSynthesizer.setParameter(String, String) (opens new window), SpeechSynthesizer.startSpeaking(String, SynthesizerListener) (opens new window), 常量字段值 (opens new window)
# AUDIO_FORMAT
```
public static final java.lang.String AUDIO_FORMAT
```
# 合成音频文件格式

java平台暂不支持参数
- 另请参阅:
  
  常量字段值 (opens new window)
# SPEED
```
public static final java.lang.String SPEED
```
# 合成语速

通过此参数，设置合成返回音频的语速。

是否必须设置：否

默认值：50

值范围：[0, 100]
- 另请参阅:
  
  SpeechSynthesizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# PITCH
```
public static final java.lang.String PITCH
```
# 合成语调

通过此参数，设置合成返回音频的语调。

是否必须设置：否

默认值：50

值范围：[0, 100]
- 另请参阅:
  
  SpeechSynthesizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# VOLUME
```
public static final java.lang.String VOLUME
```
# 合成音量

通过此参数，设置合成返回音频的音量。合成音量，影响的是合成到的音频本身的音量大小（振幅），而非播放时系统的音量。关于播放时操作系统的音量，则请自行查找操作系统相关API开发接口说明。

是否必须设置：否

默认值：50

值范围：[0, 100]
- 另请参阅:
  
  SpeechSynthesizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# BACKGROUND_SOUND
```
public static final java.lang.String BACKGROUND_SOUND
```
# 背景音乐

背景音乐默认值:无，可选：1

是否必须设置：否

默认值：0

值范围：{ null, 0, 1 }
- 另请参阅:
  
  SpeechSynthesizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# TTS_BUFFER_TIME
```
public static final java.lang.String TTS_BUFFER_TIME
```
# 合成播放缓冲时间

在合成使用SDK进行播放时，设置此参数使合成音频更快播放。

一般情况下，合成根据第一小句（出现逗号或者句号等断句）返回音频完成时，开始播放音频，这样不会出现每小句中播放到中途出现音频未返回完而中断播放的情况。然而，这样会因为等待第一小句音频完成，而可能会使播放开始时间慢几百毫秒以上。对于某些播报实时性要求很高的应用来说，这个是可能无法接受的。通过此参数，可以设置返回音频的时长多少毫秒后，就马上开始播放已有音频，而不必等待第一小句的完成(当值超过第一小句时间时，将以第一小句完成开始播放)。然而，设置此参数为大于等于0后，合成的播放回调SynthesizerListener.onSpeakProgress(int, int, int) (opens new window) 返回的当前播放的文本位置将不再准确。所以，此参数一般用于使用了本地合成，且实时性要求很高，但对播报文本位置回调没有要求的应用中，如滴滴打车等。

当值为-1时，等待第一小句结束时，开始播放；当值为大于等于0时，等待缓冲音频时长大于等于设置值时，即开始播放。

是否必须设置：否

默认值：-1

值范围：{ null, [-1, +) }
- 另请参阅:
  
  SynthesizerListener.onSpeakProgress(int, int, int) (opens new window), SpeechSynthesizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# STREAM_TYPE
```
public static final java.lang.String STREAM_TYPE
```
# 合成播放流类型

java平台暂不支持此参数。

在安卓平台中，播放器android.media.AudioTrack可以使用多种流类型播放音频，以达到音乐、铃声等类型的声音。

是否必须设置：否

默认值：android.media.AudioManager#STREAM_MUSIC

值范围：android.media.AudioManager支持的流类型值
- 另请参阅:
  
  SpeechSynthesizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# TTS_AUDIO_PATH
```
public static final java.lang.String TTS_AUDIO_PATH
```
# 合成音频保存路径

通过此参数，可以在合成完成后在本地保存一个音频文件（目前保存为Windows pcm）。在Android平台上，如保存到SDCARD，需添加 WRITE_EXTERNAL_STORAGE的权限。

是否必须设置：否

默认值：null

值范围：有效的文件相对或绝对路径（含文件名）
- 另请参阅:
  
  SpeechSynthesizer.setParameter(String, String) (opens new window), SpeechSynthesizer.synthesizeToUri(String, String, SynthesizeToUriListener) (opens new window), ASR_AUDIO_PATH, 常量字段值 (opens new window)
# TTS_BUFFER_EVENT
```
public static final java.lang.String TTS_BUFFER_EVENT
```
# 是否启用合成音频流事件

当启用合成音频流事件时，通过SynthesizerListener.onEvent(int, int, int, int, Object, Object) (opens new window) 返回SpeechEvent.EVENT_TTS_BUFFER (opens new window)事件。

是否必须设置：否

默认值：0

值范围：{0, 1}
- 另请参阅:
  
  SpeechEvent.EVENT_TTS_BUFFER (opens new window), SynthesizerListener.onEvent(int, int, int, int, java.lang.Object, java.lang.Object) (opens new window), 常量字段值 (opens new window)
# DATA_TYPE
```
public static final java.lang.String DATA_TYPE
```
# 数据类型

设置个性化数据上传的数据类型。在使用 SpeechRecognizer.updateLexicon(String, String, LexiconListener) (opens new window)及DataUploader.uploadData(SpeechListener, String, byte[\])上传用户个性化数据时，通过此参数，设置要更新的是用户词表（"userword"），还是联系人列表（"contact"）。在匹配应用定制的个性化数据时，相似的音将优先匹配联系人列表。

是否必须设置：是

默认值：null

值范围：{ "contact", "userword" }
- 另请参阅:
  
  SpeechRecognizer.updateLexicon(String, String, LexiconListener) (opens new window), 常量字段值 (opens new window)
# ASR_AUDIO_PATH
```
public static final java.lang.String ASR_AUDIO_PATH
```
# 识别音频保存路径

通过此参数，可以在识别完成后在本地保存一个音频文件（目前保存为Windows pcm）。在Android平台上，如保存到SDCARD，需添加 WRITE_EXTERNAL_STORAGE的权限。

是否必须设置：否

默认值：null

值范围：有效的文件相对或绝对路径（含文件名）
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# ASR_NET_PERF
```
public static final java.lang.String ASR_NET_PERF
```
# 网络状态反馈值

通过此参数，获取网络连接状态（仅在识别和听写）。网络状态是SDK通过测试网络连接返回的[0, 100] 范围的状态值，值越高，表示网络状态越好。设置此参数为真后，网络状态将通过 onEvent函数的SpeechEvent.EVENT_NETPREF (opens new window)事件返回给应用层。

是否必须设置：否

默认值：false

值范围：{ null, true, false }
- 另请参阅:
  
  SpeechEvent.EVENT_NETPREF (opens new window), RecognizerListener.onEvent(int, int, int, String) (opens new window), SpeechRecognizer.setParameter(String, String) (opens new window), 常量字段值 (opens new window)
# ENG_ASR
```
public static final java.lang.String ENG_ASR
```
# 常量值：识别引擎
- 另请参阅:
  
  常量字段值 (opens new window)
# ENG_TTS
```
public static final java.lang.String ENG_TTS
```
# 常量值：合成引擎
- 另请参阅:
  
  常量字段值 (opens new window)
# ENG_IVW
```
public static final java.lang.String ENG_IVW
```
# 常量值：唤醒引擎
- 另请参阅:
  
  常量字段值 (opens new window)
# MODE_MSC
```
public static final java.lang.String MODE_MSC
```
# 常量值：MSC模式
- 另请参阅:
  
  常量字段值 (opens new window)
# TEXT_ENCODING
```
public static final java.lang.String TEXT_ENCODING
```
# 文本编码格式

合成传入文本，或构建语法、个性化词典，听写、识别结果的文本编码格式。

除在使用DataUploader.uploadData(SpeechListener, String, byte[])上传外，其他函数传入的均为String类型的字符串，SDK会自动根据业务自动选择不同的编码格式，应用层如无必要，不需要设置此参数。

是否必须设置：否

默认值：视业务而异

值范围：{ null, "gb2312", "gbk", "big5", "unicode", "gb18030", "utf-8" }
- 另请参阅:
  
  SpeechRecognizer.setParameter(String, String) (opens new window), SpeechSynthesizer.setParameter(String, String) (opens new window), SpeechRecognizer.buildGrammar(String, String, GrammarListener) (opens new window), SpeechRecognizer.updateLexicon(String, String, LexiconListener) (opens new window), 常量字段值 (opens new window)

# 接口SpeechListener

public interface SpeechListener

# 通用回调类

通过回调类用于数据上传等不是特定业务的会话回调，如个性化数据上传等。周一个函数，在不同的业务中回调的数据将可能代表不一样的意义。

从以下版本开始:

version:1015

作者:

iFlytek 讯飞开放平台 (opens new window)

# 方法概要

限定符和类型	方法和说明
`void`	`onBufferReceived(byte[] buffer)`数据回调数据回调，根据业务类型不同，可能回调多次，也可能一次也不回调。
`void`	`onCompleted(SpeechError error)`结束回调回调本函数时，当前监听的会话结束。
`void`	`onEvent(int eventType, java.lang.String params)`事件回调事件回调通过应用层相关的事件消息，根据不同的业务，回调的事件类型可能不一样。

# 方法详细资料

# onEvent
```
void onEvent(int eventType,
             java.lang.String params)
```
# 事件回调

事件回调通过应用层相关的事件消息，根据不同的业务，回调的事件类型可能不一样。
- 参数:
  
  eventType - 消息类型
  
  params - 消息数据对象
- 另请参阅:
  
  SpeechEvent (opens new window)
# onBufferReceived
```
void onBufferReceived(byte[] buffer)
```
# 数据回调

数据回调，根据业务类型不同，可能回调多次，也可能一次也不回调。
- 参数:
  
  buffer - 服务端返回的数据，如在声纹获取密码时，表示密码数据。
# onCompleted
```
void onCompleted(SpeechError error)
```
# 结束回调

回调本函数时，当前监听的会话结束。当本函数的参数1非null时，表示当前会话有错误，具体错误参考SpeechError (opens new window)；当参数1为null时，表示当前会话成功。
- 参数:
  
  error - 错误信息
- 另请参阅:
  
  SpeechError (opens new window)

# 类SpeechEvent

java.lang.Object

com.iflytek.cloud.speech.SpeechEvent

public class SpeechEvent
extends java.lang.Object

# 事件类

事件类定义用于扩展事件回调中返回的事件ID。所有事件在设置生效后，通过各业务监听类的onEvent函数回调，如RecognizerListener.onEvent(int, int, int, String) (opens new window)。应用层可选择性的处理这些事件。

从以下版本开始:

version:1015
作者:

iFlytek 讯飞开放平台 (opens new window)

另请参阅:

RecognizerListener.onEvent(int, int, int, String) (opens new window),

# 字段概要

限定符和类型	字段和说明
`static int`	`EVENT_NETPREF`网络状态消息网络状态是SDK通过测试网络连接返回的[0, 100]范围的状态值，值越高，表示网络状态越好。
`static int`	`EVENT_TTS_BUFFER`合成音频流事件当通过合成音频流事件参数`SpeechConstant.TTS_BUFFER_EVENT`，启用音频流事件后，在SDK收到音频时，将返回此事件。

# 构造器概要

构造器和说明
`SpeechEvent()`

# 方法概要

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

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

# 字段详细资料

# EVENT_NETPREF
```
public static final int EVENT_NETPREF
```
# 网络状态消息

网络状态是SDK通过测试网络连接返回的[0, 100]范围的状态值，值越高，表示网络状态越好。网络状态值通过onEvent的参数2获取。
- 另请参阅:
  
  常量字段值 (opens new window)
# EVENT_TTS_BUFFER
```
public static final int EVENT_TTS_BUFFER
```
# 合成音频流事件

当通过合成音频流事件参数SpeechConstant.TTS_BUFFER_EVENT，启用音频流事件后，在SDK收到音频时，将返回此事件。

此事件到达时，将通过 arg1, arg2, arg3, obj1, obj2 分别返回已合成文本所占百分比 percent, 当前音频流对应的文本开始位置 begin pos, 文本结束位置 end pos, 以及音频流数据 ArrayList<byte[]>（应用需要把Object 转为 ArrayList<byte[]>类型），spellInfo（仅在spellInfo存在时值有效，应用需要把 Object 转换成 String 类型）。

注意：在事件回调中，对传递的音频流 ArrayList 对象，及其里面数组的任何修改，将直接影响SDK合成播放和保存的音频数据。
- 另请参阅:
  
  SynthesizerListener.onEvent(int, int, int, int, Object, Object) (opens new window), SpeechConstant.TTS_BUFFER_EVENT, 常量字段值 (opens new window)

# 构造器详细资料

# SpeechEvent
```
public SpeechEvent()
```

# 类Version

ava.lang.Object
- com.iflytek.cloud.speech.Version
```
public class Version
extends java.lang.Object
```
# 版本信息类
- 作者:
  
  iFlytek 讯飞开放平台 (opens new window)
  
  # 构造器概要
  
  构造器和说明
  
  Version()
  
  # 方法概要
  
  限定符和类型方法和说明
  
  static java.lang.String getVersion()获取控件版本号
  
  # 从类继承的方法 java.lang.Object
```
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
```
  # 构造器详细资料
  - # Version
```
public Version()
```
  # 方法详细资料
  - # getVersion
```
public static java.lang.String getVersion()
```
    # 获取控件版本号
    - 返回:
      
      版本号，如：3.5.1027(控件版本号字段).1040(底层MSC字段)

构造器和说明
`Version()`

限定符和类型	方法和说明
`static java.lang.String`	`getVersion()`获取控件版本号

# 类Setting

java.lang.Object
com.iflytek.cloud.speech.Setting

public class Setting
extends java.lang.Object

# 设置

设置是否显示控制台日志，是否保存共享库调试日志等。

SDK会打印两种日志：Msc.jar的控制台日志，及libmsc32.so,libmsc64.so,msc32.dll, msc64.dll的共享库日志。

# 嵌套类概要

嵌套类:

限定符和类型	类和说明
static class	Setting.LOG_LEVEL 共享库日志级别共享库日志按重要程度区分了级别，目前控制台日志则没有相应的日志级别。

# 字段概要

字段:

限定符和类型	字段和说明
static boolean	DEFAULT_IS_SAVE_TEST_LOG 是否保存性能日志文件默认值
static boolean	DEFAULT_IS_SHOW_LOG 是否打印日志（控制台和共享库）默认值
static java.lang.String	DEFAULT_LOG_PATH 共享库日志默认路径

# 方法概要

所有方法：

限定符和类型	方法和说明
static Setting.LOG_LEVEL	getLogLevel() 获取共享库日志级别
static java.lang.String	getLogPath() 获取共享库日志保存路径
static boolean	getSaveTestLog() 获取是否保存性能日志
static boolean	getShowLog() 获取是否显示日志信息
static void	setLogLevel(Setting.LOG_LEVEL level) 设置共享库日志级别共享库日志级别，默认值为Setting.LOG_LEVEL.none,应用层根据调试的需要，可以设置一个自己需要的级别，或使用默认的值。
static void	setLogPath(java.lang.String path) 设置共享库日志保存路径共享库日志路径，默认值为DEFAULT_LOG_PATH，即当前应用运行路径。
static void	setSaveTestLog(boolean isSaveTestLog) 设置是否保存性能日志性能日志有助于SDK开发人员了解SDK的性能情况，应用层可忽略此日志。
static void	setShowLog(boolean isShowLog) 设置是否显示日志信息设置是否显示控制台日志和共享库日志, 默认值为DEFAULT_IS_SHOW_LOG。

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

# 字段详细资料

# DEFAULT_LOG_PATH

public static final java.lang.String DEFAULT_LOG_PATH

共享库日志默认路径

另请参阅:
常量字段值

# DEFAULT_IS_SHOW_LOG

public static final boolean DEFAULT_IS_SHOW_LOG

是否打印日志（控制台和共享库）默认值

另请参阅:
常量字段值

# DEFAULT_IS_SAVE_TEST_LOG

public static final boolean DEFAULT_IS_SAVE_TEST_LOG

是否保存性能日志文件默认值

另请参阅:
常量字段值

# 方法详细资料

# setLogLevel

public static void setLogLevel(Setting.LOG_LEVEL level)

设置共享库日志级别
共享库日志级别，默认值为Setting.LOG_LEVEL.none,应用层根据调试的需要，可以设置一个自己需要的级别，或使用默认的值。在应用发布时，为了减少日志的开销，应该使用默认的日志级别。
共享库的日志级别，只有在共享库日志保存路径设置有效时，才会生效。

参数:
level - 日志级别

另请参阅:
Setting.LOG_LEVEL, getLogLevel(), setLogPath(java.lang.String)

# getLogLevel

public static Setting.LOG_LEVEL getLogLevel()

获取共享库日志级别

返回:
共享库日志级别，默认值为Setting.LOG_LEVEL.none

另请参阅:
setLogLevel(com.iflytek.cloud.speech.Setting.LOG_LEVEL)

# setLogPath

public static void setLogPath(java.lang.String path)

设置共享库日志保存路径
共享库日志路径，默认值为DEFAULT_LOG_PATH，即当前应用运行路径。在应用层设置的路径有效时，共享库日志才会保存。

参数:
path - 共享库日志路径值，含文件名。

另请参阅:
setLogLevel(com.iflytek.cloud.speech.Setting.LOG_LEVEL), getLogPath()

# getLogPath

public static java.lang.String getLogPath()

获取共享库日志保存路径

返回:
获取共享库日志保存路径

另请参阅:
setLogPath(java.lang.String)

# setShowLog

public static void setShowLog(boolean isShowLog)

设置是否显示日志信息
设置是否显示控制台日志和共享库日志, 默认值为DEFAULT_IS_SHOW_LOG。

为了帮助SDK开发人员在出问题时，尽快定位，可能会在日志中打印APPID等私密信息，为了您的应用安全，以及不影响运行的效率，请勿在应用的发布版本中显示日志。

参数:
isShowLog - false为不显示，true为显示

另请参阅:
getShowLog()

# getShowLog

public static boolean getShowLog()

获取是否显示日志信息

返回:
设置是否显示控制台日志和共享库日志。

另请参阅:
setShowLog(boolean)

# setSaveTestLog

public static void setSaveTestLog(boolean isSaveTestLog)

设置是否保存性能日志
性能日志有助于SDK开发人员了解SDK的性能情况，应用层可忽略此日志。

参数:
isSaveTestLog - 是否保存性能日志，默认值DEFAULT_IS_SAVE_TEST_LOG

另请参阅:
getSaveTestLog()

# getSaveTestLog

public static boolean getSaveTestLog()

获取是否保存性能日志

返回:
是否保存性能日志

另请参阅: setSaveTestLog(boolean)

# 枚举Setting.LOG_LEVEL

java.lang.Object
java.lang.Enum<Setting.LOG_LEVEL>
com.iflytek.cloud.speech.Setting.LOG_LEVEL

所有已实现的接口:

java.io.Serializable, java.lang.Comparable<Setting.LOG_LEVEL>

封闭类: Setting

public static enum Setting.LOG_LEVEL
extends java.lang.Enum<Setting.LOG_LEVEL>

共享库日志级别
共享库日志按重要程度区分了级别，目前控制台日志则没有相应的日志级别。

另请参阅: Setting.setLogLevel(com.iflytek.cloud.speech.Setting.LOG_LEVEL)

# 枚举常量概要

# 枚举常量

枚举常量和说明：

all
所有日志

detail
高，异常分析需要的级别

low
低，只打印主要日志信息

none
不打印

normal
中，打印基本日志信息

# 方法概要

所有方法:

限定符和类型	方法和说明
static Setting.LOG_LEVEL	valueOf(java.lang.String name) 返回带有指定名称的该类型的枚举常量。
static Setting.LOG_LEVEL[]	values() 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。

从类继承的方法 java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

# 枚举常量详细资料

# all

public static final Setting.LOG_LEVEL all

所有日志

# detail

public static final Setting.LOG_LEVEL detail

高，异常分析需要的级别

# normal

public static final Setting.LOG_LEVEL normal

中，打印基本日志信息

# low

public static final Setting.LOG_LEVEL low

低，只打印主要日志信息

# none

public static final Setting.LOG_LEVEL none

不打印

# 方法详细资料

# values

public static Setting.LOG_LEVEL[] values()

按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。该方法可用于迭代常量, 如下所示:

for (Setting.LOG_LEVEL c : Setting.LOG_LEVEL.values())
    System.out.println(c);

返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

# valueOf

public static Setting.LOG_LEVEL valueOf(java.lang.String name)

返回带有指定名称的该类型的枚举常量。字符串必须与用于声明该类型的枚举常量的标识符完全匹配。(不允许有多余的空格字符。)

参数:
name - 要返回的枚举常量的名称。

返回:
返回带有指定名称的枚举常量

抛出:
java.lang.IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量
java.lang.NullPointerException - 如果参数为空值

# 类ResourceUtil

java.lang.Object
com.iflytek.cloud.speech.ResourceUtil

public class ResourceUtil
extends java.lang.Object

资源辅助类
资源辅助类，将资源目录，转换为SDK要求的目录形式。

SDK要求的文件目录格式如下（由此类的函数生成，不关心的用户可忽略），两个文件间，以英文分号";"分隔：
fo|file_info|offset|length;
其中fo表示文件路径方式。
关于资源路径设置，请参考具体的业务类说明。

SDK加载离线资源有三种方式：
1、通过SpeechUtility.createUtility(java.lang.String) (opens new window)初始化SDK时加载，通过设置ENGINE_START参数，并根据业务不同，指定以下一个或多个的资源路径参数：
TTS_RES_PATH，
ASR_RES_PATH

2、通过SpeechUtility.setParameter(String, String) (opens new window)加载，通过设置ENGINE_START参数，并根据业务不同，指定以下一个或多个的资源路径参数：
TTS_RES_PATH，
ASR_RES_PATH

3、通过各业务开始会话的函数加载，通过各业务的setParameter函数，如 SpeechRecognizer.setParameter(String, String) (opens new window)，根据业务不同，设置以下资源路径参数中的一个：
TTS_RES_PATH，
ASR_RES_PATH

在同一业务，新的资源加载后，上一个资源将自动被释放。如合成中，如果各发音人资源文件是分开的，则在加载当前发音人资源后，上一发音人资源将自动被释放。如果要释放当前的资源，而不加载新的资源，需要同时销毁离线引擎，有以下三种方式：
1、通过SpeechUtility.setParameter(String, String) (opens new window)，设置参数 ENGINE_DESTROY即可。

2、通过各业务的destory函数销毁：
SpeechRecognizer.destroy() (opens new window)，
SpeechSynthesizer.destroy() (opens new window)

3、通过SpeechUtility.destroy() (opens new window)销毁。

另外，在应用退出后，所有应用相关的资源会被销毁。因为销毁引擎后，重新启动引擎的时间要比直接更换资源长（会使首次会话的时间变长），所以如果仅是短暂的停止使用，建议不需要销毁资源。

另请参阅:
SpeechConstant.ENGINE_TYPE (opens new window), SpeechUtility.createUtility(java.lang.String) (opens new window), SpeechUtility.setParameter(java.lang.String, java.lang.String) (opens new window), SpeechRecognizer.setParameter(String, String) (opens new window), SpeechSynthesizer.setParameter(String, String) (opens new window)

# 字段概要

字段

限定符和类型	字段和说明
static java.lang.String	ASR_RES_PATH 识别资源路径在离线识别时，首次会话，或切换识别资源时，需要设置识别资源路径。
static java.lang.String	ENGINE_DESTROY 销毁引擎通过调用SpeechUtility.setParameter(String, String)设置此参数以销毁引擎，并释放资源内存。
static java.lang.String	ENGINE_START 启动引擎通过设置此参数，启动离线引擎。
static java.lang.String	GRM_BUILD_PATH 语法构建目录在使用离线语法时，需要构建语法并保存到本地，在构建和使用语法时，都需要设置语法的构建目录。
static java.lang.String	TTS_RES_PATH合成资源路径在离线合成时，首次会话，或切换合成资源时，需要设置资源路径。

# 构造器概要

构造器

构造器和说明
ResourceUtil()

# 方法概要

# 所有方法

限定符和类型	方法和说明
static java.lang.String	generateResourcePath(java.lang.String path) 生成资源路径传入文件路吃径，生成SDK要求的路径值，用于各业务离线功能时，传入资源路径。

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

# 字段详细资料

# ENGINE_START

public static final java.lang.String ENGINE_START

启动引擎
通过设置此参数，启动离线引擎。在离线功能使用时，首次设置资源路径时，需要设置此参数启动引擎。关于设置的方式，参考类说明。

启动引擎参数值因业务类型而异：
合成：SpeechConstant.ENG_TTS (opens new window)
识别：SpeechConstant.ENG_ASR (opens new window)

是否必须设置：是（在首次使用离线功能时）

默认值：null

值范围：见上文

另请参阅:
ENGINE_DESTROY, 常量字段值

# ENGINE_DESTROY

public static final java.lang.String ENGINE_DESTROY

销毁引擎
通过调用SpeechUtility.setParameter(String, String)设置此参数以销毁引擎，并释放资源内存。(通过destory函数销毁引擎时，则不需要设置此参数，参考类说明)

是否必须设置：否

默认值：null

值范围：参考ENGINE_START说明

另请参阅:
ENGINE_START, 常量字段值

# ASR_RES_PATH

public static final java.lang.String ASR_RES_PATH

识别资源路径
在离线识别时，首次会话，或切换识别资源时，需要设置识别资源路径。资源路径值需要通过generateResourcePath(java.lang.String)生成SDK要求的格式。

是否必须设置：是（离线识别时）

默认值：null

值范围：见上文说明

另请参阅:
TTS_RES_PATH, 常量字段值

# GRM_BUILD_PATH

public static final java.lang.String GRM_BUILD_PATH

语法构建目录
在使用离线语法时，需要构建语法并保存到本地，在构建和使用语法时，都需要设置语法的构建目录。与识别资源路径值不一样的是，语法的路径值，不需要通过generateResourcePath(java.lang.String) 生成SDK要求的格式。

是否必须设置：是（离线语法识别时）

默认值：null

值范围：有效的文件夹径值（含文件名）

另请参阅:
常量字段值

# TTS_RES_PATH

public static final java.lang.String TTS_RES_PATH

合成资源路径
在离线合成时，首次会话，或切换合成资源时，需要设置资源路径。资源路径值需要通过generateResourcePath(java.lang.String)生成SDK要求的格式。同时，合成设置资源路径时，必须同时设置发音人参数 SpeechConstant.VOICE_NAME，值为资源中包含的其中一个发音人名参数。

是否必须设置：是（离线合成时）

默认值：null

值范围：见上文说明

另请参阅: ASR_RES_PATH, 常量字段值

# 构造器详细资料

# ResourceUtil

public ResourceUtil()

# 方法详细资料

# generateResourcePath

public static java.lang.String generateResourcePath(java.lang.String path)

生成资源路径
传入文件路吃径，生成SDK要求的路径值，用于各业务离线功能时，传入资源路径。

参数:
path - 原资源路径

返回:
SDK要求的资源路径值

# 异常错误SpeechError

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.iflytek.cloud.speech.SpeechError

所有已实现的接口:
java.io.Serializable

public class SpeechError
extends java.lang.Exception

# 错误信息类

当业务会话出现错误时，通过onError函数，返回类对象。

应用层可通过此类获取错误描述信息，以及具体的错误码。应用层只使用回调返回的现成对象，非必要情况下，不必在应用层实例化本类对象。

另请参阅:
ErrorCode, 序列化表格

# 字段概要

字段:

限定符和类型	字段和说明
static int	ERROR_AUDIO_RECORD 错误类型：启动录音失败
static int	ERROR_BROWSER_NOT_INSTALLED 错误类型：系统未安装浏览器，请安装后再查看
static int	ERROR_EMPTY_UTTERANCE 错误类型：无有效的文本信息
static int	ERROR_ENGINE 错误类型：引擎错误
static int	ERROR_FILE_ACCESS 错误类型：无法读写文件
static int	ERROR_IN_USE 错误类型：网络繁忙，请稍候
static int	ERROR_INSUFFICIENT_PERMISSIONS 错误类型：未设置有效权限
static int	ERROR_INTERRUPT 错误类型：打断（唤醒）
static int	ERROR_INVALID_DATA 错误类型：上传数据格式不正确
static int	ERROR_INVALID_ENCODING 错误类型：无法支持的编码格式
static int	ERROR_INVALID_GRAMMAR 错误类型：未找到有效的语法文件
static int	ERROR_INVALID_LOCAL_RESOURCE 错误类型：无法找到本地资源
static int	ERROR_INVALID_PARAM 错误类型：无效的参数
static int	ERROR_INVALID_RESULT 错误类型：无法解析的结果
static int	ERROR_LOGIN 错误类型：用户校验失败
static int	ERROR_LOGIN_INVALID_PWD 错误类型：密码错误
static int	ERROR_LOGIN_INVALID_USER 错误类型：无效的用户名
static int	ERROR_MEMORY_WRANING 错误类型：内存不足
static int	ERROR_NET_EXPECTION 错误类型：网络连接发生异常
static int	ERROR_NETWORK_TIMEOUT 错误类型：网络连接超时
static int	ERROR_NO_MATCH 错误类型：没有匹配的结果
static int	ERROR_NO_NETWORK 错误类型：没有检查到网络
static int	ERROR_PERMISSION_DENIED 错误类型：未经授权的语音应用
static int	ERROR_PLAY_MEDIA 错误类型：播放音频错误
static int	ERROR_SERVER_CONNECT 错误类型：无法连接服务,请检查网络
static int	ERROR_SPEECH_TIMEOUT 错误类型：您好像没有说话哦
static int	ERROR_TEXT_OVERFLOW 错误类型：文本过长
static int	ERROR_TTS_INTERRUPT 错误类型：合成被打断
static int	ERROR_UNKNOWN 错误类型：发生未知错误

# 构造器概要

构造器:

构造器和说明
SpeechError(int errorCode) 构造函数应用层可忽略此函数

SpeechError(java.lang.Throwable e)
构造函数应用层可忽略此函数

# 方法概要

所有方法

限定符和类型	方法和说明
int	getErrorCode() 获取错误码获取错误对应用的具体错误码，[10000, 20000)的错误码为底层共享库和服务器返回的错误码，[20000, +∞)为 jar 层返回的错误。
java.lang.String	getErrorDesc() 获取错误描述不包含错误码的描述信息。
java.lang.String	getErrorDescription(boolean containCode) 获取错误描述获取指定是否包含错误码的描述信息。
int	getErrorType() 获取错误类型获取当前错误对应的由本类定义的错误类型
java.lang.String	toString() 转为字符串把当前的信息转为字符串类，与getErrorDescription(boolean) 参数为true时的效果一致。

从类继承的方法 java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

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

# 字段详细资料

# ERROR_NO_NETWORK

public static final int ERROR_NO_NETWORK

错误类型：没有检查到网络

另请参阅:
常量字段值

# ERROR_NETWORK_TIMEOUT

public static final int ERROR_NETWORK_TIMEOUT

错误类型：网络连接超时

另请参阅:
常量字段值

# ERROR_NET_EXPECTION

public static final int ERROR_NET_EXPECTION

错误类型：网络连接发生异常

另请参阅:
常量字段值

# ERROR_INSUFFICIENT_PERMISSIONS

public static final int ERROR_INSUFFICIENT_PERMISSIONS

错误类型：未设置有效权限

另请参阅:
常量字段值

# ERROR_INVALID_RESULT

public static final int ERROR_INVALID_RESULT

错误类型：无法解析的结果

另请参阅:
常量字段值

# ERROR_SERVER_CONNECT

public static final int ERROR_SERVER_CONNECT

错误类型：无法连接服务,请检查网络

另请参阅:
常量字段值

# ERROR_INVALID_PARAM

public static final int ERROR_INVALID_PARAM

错误类型：无效的参数

另请参阅:
常量字段值

# ERROR_UNKNOWN

public static final int ERROR_UNKNOWN

错误类型：发生未知错误

另请参阅:
常量字段值

# ERROR_AUDIO_RECORD

public static final int ERROR_AUDIO_RECORD

错误类型：启动录音失败

另请参阅:
常量字段值

# ERROR_NO_MATCH

public static final int ERROR_NO_MATCH

错误类型：没有匹配的结果

另请参阅:
常量字段值

# ERROR_SPEECH_TIMEOUT

public static final int ERROR_SPEECH_TIMEOUT

错误类型：您好像没有说话哦

另请参阅:
常量字段值

# ERROR_INVALID_ENCODING

public static final int ERROR_INVALID_ENCODING

错误类型：无法支持的编码格式

另请参阅:
常量字段值

# ERROR_EMPTY_UTTERANCE

public static final int ERROR_EMPTY_UTTERANCE

错误类型：无有效的文本信息

另请参阅:
常量字段值

# ERROR_FILE_ACCESS

public static final int ERROR_FILE_ACCESS

错误类型：无法读写文件

另请参阅:
常量字段值

# ERROR_PLAY_MEDIA

public static final int ERROR_PLAY_MEDIA

错误类型：播放音频错误

另请参阅:
常量字段值

# ERROR_MEMORY_WRANING

public static final int ERROR_MEMORY_WRANING

错误类型：内存不足

另请参阅:
常量字段值

# ERROR_TEXT_OVERFLOW

public static final int ERROR_TEXT_OVERFLOW

错误类型：文本过长

另请参阅:
常量字段值

public static final int ERROR_LOGIN

错误类型：用户校验失败

另请参阅:
常量字段值

# ERROR_IN_USE

public static final int ERROR_IN_USE

错误类型：网络繁忙，请稍候

另请参阅:
常量字段值

# ERROR_INVALID_DATA

public static final int ERROR_INVALID_DATA

错误类型：上传数据格式不正确

另请参阅:
常量字段值

# ERROR_INVALID_GRAMMAR

public static final int ERROR_INVALID_GRAMMAR

错误类型：未找到有效的语法文件

另请参阅:
常量字段值

# ERROR_INVALID_LOCAL_RESOURCE

public static final int ERROR_INVALID_LOCAL_RESOURCE

错误类型：无法找到本地资源

另请参阅:
常量字段值

public static final int ERROR_LOGIN_INVALID_USER

错误类型：无效的用户名

另请参阅:
常量字段值

public static final int ERROR_LOGIN_INVALID_PWD

错误类型：密码错误

另请参阅:
常量字段值

# ERROR_PERMISSION_DENIED

public static final int ERROR_PERMISSION_DENIED

错误类型：未经授权的语音应用

另请参阅:
常量字段值

# ERROR_BROWSER_NOT_INSTALLED

public static final int ERROR_BROWSER_NOT_INSTALLED

错误类型：系统未安装浏览器，请安装后再查看

另请参阅:
常量字段值

# ERROR_TTS_INTERRUPT

public static final int ERROR_TTS_INTERRUPT

错误类型：合成被打断

另请参阅:
常量字段值

# ERROR_INTERRUPT

public static final int ERROR_INTERRUPT

错误类型：打断（唤醒）

另请参阅:
常量字段值

# ERROR_ENGINE

public static final int ERROR_ENGINE

错误类型：引擎错误

另请参阅:
常量字段值

# 构造器详细资料

# SpeechError

public SpeechError(java.lang.Throwable e)

构造函数
应用层可忽略此函数

参数:
e - 异常对象

# SpeechError

public SpeechError(int errorCode)

构造函数
应用层可忽略此函数

参数:
errorCode - 错误码

另请参阅:
ErrorCode

# 方法详细资料

# getErrorType

public int getErrorType()

获取错误类型
获取当前错误对应的由本类定义的错误类型

返回:
错误类型码，具体值参考本类定义的常量

另请参阅:
getErrorCode(), getErrorDesc()

# getErrorCode

public int getErrorCode()

获取错误码
获取错误对应用的具体错误码，[10000, 20000)的错误码为底层共享库和服务器返回的错误码，[20000, +∞)为 jar 层返回的错误。具体错误码值，请参考ErrorCode。

返回:
错误码值

另请参阅: getErrorDesc(), getErrorType(), ErrorCode

# getErrorDesc

public java.lang.String getErrorDesc()

获取错误描述
不包含错误码的描述信息。描述信息有助于开发者和用户处理引起错误的原因。

返回:
错误描述信息

另请参阅:
getErrorCode(), getErrorType(), getErrorDescription(boolean)

# toString

public java.lang.String toString()

转为字符串
把当前的信息转为字符串类，与getErrorDescription(boolean) 参数为true时的效果一致。

覆盖:
toString 在类中 java.lang.Throwable

返回:
错误描述字符串值

另请参阅:
getErrorCode(), getErrorDescription(boolean)

# getErrorDescription

public java.lang.String getErrorDescription(boolean containCode)

获取错误描述
获取指定是否包含错误码的描述信息。描述信息有助于开发者和用户处理引起错误的原因。

参数:
containCode - 是否包含错误码

返回:
错误描述信息

另请参阅:
getErrorCode(), getErrorType(), getErrorDesc()

在这篇文章中：

# Java SDK 基础类

# 类SpeechConstant

# 公共常量

# 字段概要

# 方法概要

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

# 字段详细资料

# APPID

# 应用ID

# LIB_NAME_32

# 32位系统下的共享库名字

# LIB_NAME_64

# 64位系统下的共享库名字

# RESULT_TYPE

# 结果类型

# LANGUAGE

# 语言区域

# ACCENT

# 方言

# DOMAIN

# 应用领域

# VAD_BOS

# 前端点超时

# VAD_EOS

# 后端点超时

# SAMPLE_RATE

# 音频采样率

# PARAMS

# 多参数设置

# WAP_PROXY

# 网络类型

# NET_TIMEOUT

# 网络连接超时时间

# KEY_SPEECH_TIMEOUT

# 语音输入超时时间

# ENGINE_MODE

# 客户端引擎选择模式

# ENGINE_TYPE

# 引擎类型

# AUDIO_SOURCE

# 音频源

# ASR_SOURCE_PATH

# 音频源路径

# FILTER_AUDIO_TIME

# 需要过滤的音频时长

# LOCAL_GRAMMAR

# 本地语法ID

# GRAMMAR_TYPE

# 语法类型

# GRAMMAR_NAME

# 语法名称

# GRAMMAR_LIST

# 语法列表名

# ASR_NBEST

# 句子多侯选

# ASR_WBEST

# 词语多侯选

# ASR_PTT

# 标点符号

# TYPE_LOCAL

# 常量值：本地引擎

# TYPE_CLOUD

# 常量值：云端引擎

# VOICE_NAME

# 合成发音人

# AUDIO_FORMAT

# 合成音频文件格式

# SPEED

# 合成语速

# PITCH

# 合成语调

# VOLUME

# 合成音量

# BACKGROUND_SOUND

# 背景音乐

# TTS_BUFFER_TIME

# 合成播放缓冲时间

# STREAM_TYPE

# 合成播放流类型

# TTS_AUDIO_PATH