public class SpeechConstant
extends java.lang.Object
本类定义语音SDK用到的参数名。
除了初始化SDK时,可通过SpeechUtility.createUtility(Context, java.lang.String)
设置参数外,
其他如合成,识别等会话的参数设置需要通过相关类的 setParameter 函数来设置。
SDK设置参数值均以String型的字符串传入,对于本类中说明的值范围中可能涉及的
int等类型的数值,请自行转换到对应的String字符串值后传给SDK,如
String.valueOf(int)
。同样的,通过获取参数值函数返回的值,也以
String值表示,请自行转换到对应的值,如Integer.parseInt(String)
。
在参数值域中,如果只有{ null, 0, 1 }的范围,则表示这是布尔(boolean)型的参数, 其中,null表示空,0表示false,1表示true。+∞、-∞指int型或long型可表示的最大 正负整数值。设置某参数值为null时,表示不设置此参数值,SDK会删除此参数已设置的 值,存在默认值时,在会话中使用默认值。
限定符和类型 | 字段和说明 |
---|---|
static java.lang.String |
ACCENT
方言
每一种语言区域,一般还有不同的方言,通过此参数,在听写和语音语义理解时,
设置不同的方言参数。
|
static java.lang.String |
APPID
应用ID
初始化SDK时,需要传入APPID值。
|
static java.lang.String |
ASR_AUDIO_PATH
识别音频保存路径
通过此参数,可以在识别完成后在本地保存一个音频文件。
|
static java.lang.String |
ASR_DWA
动态修正 (暂不支持)
设置听写结果是否动态修正。
|
static java.lang.String |
ASR_INTERRUPT_ERROR
识别会话中断报错
设置识别会话被中断时(如当前会话未结束就开启了新会话等),是否通
过
RecognizerListener.onError(com.iflytek.cloud.SpeechError) 回调ErrorCode.ERROR_INTERRUPT 错误。 |
static java.lang.String |
ASR_NBEST
句子多侯选
在听写和语法、命令词识别时,通过设置此参数,获取在发音相似时的句子多侯选结
果。
|
static java.lang.String |
ASR_NET_PERF
网络状态反馈值
通过此参数,获取网络连接状态(仅在识别和听写)。
|
static java.lang.String |
ASR_NOMATCH_ERROR
无结果错误
通过此参数,设置在识别无结果时,是否通过
RecognizerListener.onError(com.iflytek.cloud.SpeechError)
返回ErrorCode.MSP_ERROR_NO_DATA 错误。 |
static java.lang.String |
ASR_PTT
标点符号
通过此参数,设置听写文本结果是否含标点符号。
|
static java.lang.String |
ASR_SOURCE_PATH
音频源路径
外部音频文件的路径,在直接听写、识别音频文件时可通过设置此参数,传入文件的路
径,SDK自动读取文件进行识别,不用应用层调用
SpeechRecognizer.writeAudio(byte[], int, int)
函数传入音频流。 |
static java.lang.String |
ASR_THRESHOLD
识别门限值
用在本地识别中,设置引擎只给出大于此门限值的识别结果。
|
static java.lang.String |
ASR_WBEST
词语多侯选
在听写和语法、命令词识别时,通过设置此参数,获取在发音相似时的词语多侯选结
果。
|
static java.lang.String |
AUDIO_FORMAT
音频格式
保存的音频格式(合成、听写、识别、语义、声纹、评测业务支持)。
|
static java.lang.String |
AUDIO_SOURCE
音频源
设置SDK是使用 Android自带的录音机录制音频方式,还是使用应用传入音频流方式。
|
static java.lang.String |
AUTH_ID
授权ID
授权ID,是每个应用的用户的唯一标识,声纹密码,人脸识别,以及身份认证时需要设置。
|
static java.lang.String |
BACKGROUND_SOUND
背景音乐
背景音乐 默认值:无,可选:1
是否必须设置:否
默认值:0
值范围:{ null, 0, 1 }
|
static java.lang.String |
CLOUD_GRAMMAR
云端语法ID
即原GRAMMAR_ID参数。
|
static java.lang.String |
DATA_TYPE
数据类型
已被
LEXICON_TYPE 取代。 |
static java.lang.String |
DOMAIN
应用领域
服务器为不同的应用领域,定制了不同的听写匹配引擎,使用对应的领域能获取更
高的匹配率。
|
static java.lang.String |
ENG_ASR
常量值:识别引擎
|
static java.lang.String |
ENG_EVA
常量值:评测引擎
|
static java.lang.String |
ENG_IVP
常量值:声纹引擎
|
static java.lang.String |
ENG_IVW
常量值:唤醒引擎
|
static java.lang.String |
ENG_NLU
常量值:语义引擎
|
static java.lang.String |
ENG_TTS
常量值:合成引擎
|
static java.lang.String |
ENG_WFR
常量值:人脸引擎
|
static java.lang.String |
ENGINE_MODE
客户端引擎选择模式
|
static java.lang.String |
ENGINE_TYPE
引擎类型
设置使用的引擎类型:在线、离线、混合。
|
static java.lang.String |
FILTER_AUDIO_TIME
需要过滤的音频时长
部分系统存在启动录音后,有短暂的音频跳变,通过设置此参数,可以过滤掉此部分音频,
提高识别效果。
|
static java.lang.String |
FORCE_LOGIN
是否强制login
在初始化调用
SpeechUtility.createUtility(Context, java.lang.String) 时会对进程名称进行检查,如果名称
与应用包名不一致则不进行login操作,返回null,用以规避在子进程反复进行调用的问题。 |
static java.lang.String |
GRAMMAR_CONTENT
语法内容
仅在内部使用到,应用层忽略
|
static java.lang.String |
GRAMMAR_LIST
语法列表名
在本地语法识别时,在构建语法后,可通过
SpeechRecognizer.updateLexicon(String, String, LexiconListener) 更新语法中
指定的词表,如本地语法“call”中的"contact",则指定本参数值为"call",在
SpeechRecognizer.updateLexicon(String, String, LexiconListener) 的参数1中
指定值为"contact"。 |
static java.lang.String |
GRAMMAR_NAME
语法名称
上传语法时的语法名字。
|
static java.lang.String |
GRAMMAR_TYPE
语法类型
在使用识别识别时,需要设置与使用的类型一致语法类型的参数。
|
static java.lang.String |
ISE_AUDIO_PATH
评测音频保存路径
通过此参数,可以在评测完成后在本地保存一个音频文件。
|
static java.lang.String |
ISE_AUTO_TRACKING
朗读跟踪
设置朗读跟踪,只对句子和篇章有效。
|
static java.lang.String |
ISE_CATEGORY
评测题型
指定当前评测会话的题型,包括以下值:
read_syllable:朗读单字,英文评测不支持; read_word:朗读词语; read_sentence:朗读句子; read_chapter:朗读篇章,暂不支持; speaker_adapt:自适应,暂不支持; choice_question:选择题型,暂不支持; 关于题型的详细说明,请参考《Speech Evaluation API Documents.pdf》。 |
static java.lang.String |
ISE_ENT
评测引擎类型
指定当前评测需要使用的引擎。
|
static java.lang.String |
ISE_INTERRUPT_ERROR
评测会话中断报错
设置评测会话被中断时(如当前会话未结束就开启了新会话等),是否通
过
EvaluatorListener.onError(com.iflytek.cloud.SpeechError) 回调ErrorCode.ERROR_INTERRUPT 错误。 |
static java.lang.String |
ISE_PARSED
试题是否已标注过
试卷未标注,云端会先调用标注引擎进行标注,然后把标注结果传给引擎;
试卷已标注,云端将直接传给引擎进行评测。
|
static java.lang.String |
ISE_SOURCE_PATH
评测音频源路径
外部音频文件的路径,在直接听写、识别音频文件时可通过设置此参数,传入文件的路
径,SDK自动读取文件进行识别,不用应用层调用
SpeechEvaluator.writeAudio(byte[], int, int)
接口传入音频流。 |
static java.lang.String |
ISE_TRACK_TYPE
跟踪模式
跟踪模式包括严格模式(hard)和宽松模式(easy)。
|
static java.lang.String |
ISE_USER_MODEL_ID
评测用户模型id
评测用户模型,是保存在服务器端的模型。
|
static java.lang.String |
IST_AUDIO_PATH
转写音频路径
在录音模式下,可指定文件保存的目录,或文件的绝对路径。
|
static java.lang.String |
IST_AUDIO_UPLOADED
转写已上传音频字节数
在续传时需要指定
如需下次进行续传,请在当前会话
SpeechEvent.EVENT_SESSION_END
事件中,以第4个参数,通过android.os.Bundle#getInt 指定KEY值为
本参数名获取值。 |
static java.lang.String |
IST_SESSION_ID
转写会话ID
在续传时需要指定
如需下次进行续传,请在当前会话
SpeechEvent.EVENT_SESSION_ID
获取,或在SpeechEvent.EVENT_SESSION_END 事件中,以第4个参数,通
过android.os.Bundle#getString 指定KEY值为本参数名获取。 |
static java.lang.String |
IST_SESSION_TRY
转写会话重启尝试次数
指定当会话失败时,重试的次数。
|
static java.lang.String |
IST_SYNC_ID
转写同步id
在续传时需要指定
如需下次进行续传,请在当前会话
SpeechEvent.EVENT_SESSION_END
事件中,以第4个参数,通过android.os.Bundle#getInt 指定KEY值为
本参数名获取值。 |
static java.lang.String |
ISV_AUDIO_PATH
声纹音频保存路径
通过此参数,可以在注册或验证完成后在本地保存一个音频文件(目前保存为
Windows pcm)。
|
static java.lang.String |
ISV_CMD
声纹模型操作命令
在进行声纹操作时,需要设置操作的命令:que(查询),del(删除)。
|
static java.lang.String |
ISV_INTERRUPT_ERROR
声纹会话中断报错
设置声纹会话被中断时(如当前会话未结束就开启了新会话等),是否通
过
VerifierListener.onError(SpeechError) 回调ErrorCode.ERROR_INTERRUPT 错误。 |
static java.lang.String |
ISV_PWD
声纹密码
在声纹注册和验证时,除自由说类型外,其余均需要设置对应类型的待注册或验
证的密码,且,密码需要从服务器中获取(见
SpeakerVerifier.getPasswordList(SpeechListener) )。 |
static java.lang.String |
ISV_PWDT
声纹密码类型
设置声纹密码类型。
|
static java.lang.String |
ISV_RGN
声纹模型训练次数
在注册声纹模型时,需要设置模型训练的次数。
|
static java.lang.String |
ISV_SST
声纹业务类型
设置声纹业务类型。
|
static java.lang.String |
ISV_VID
声纹id
注册成功服务端返回的此次注册的id。
|
static java.lang.String |
IVW_ENROLL_DEST_PATH
唤醒注册生成资源目标路径
设置一个文件路径,用于保存训练唤醒词生成的资源路径。
|
static java.lang.String |
IVW_ENROLL_RES_PATH
唤醒注册辅助资源路径
唤醒注册功能在注册唤醒模型时,需要辅助资源,才能进行。
|
static java.lang.String |
IVW_ENROLL_TIMES
唤醒注册总次数
唤醒注册为了建立模型,需要多次采集用户对同一唤醒词的音频,即在一次注册的会话中,
要求用户多次读出同一唤醒词。
|
static java.lang.String |
IVW_ENROLL_TMAX
唤醒注册的最长语音时间
请参考
IVW_ENROLL_TMIN 的说明。 |
static java.lang.String |
IVW_ENROLL_TMIN
唤醒注册的最短语音时间
唤醒注册时,为了保证模型的唤醒效果,过长或过短的音频都不好,需要一个合适的音频
长度,目前,在引擎定义这个时长为250~4000毫秒。
|
static java.lang.String |
IVW_RES_PATH
唤醒资源路径
唤醒需要使用本地资源,通过此参数设置本地资源所在的路径。
|
static java.lang.String |
IVW_SHOT_WORD
包含唤醒词
设置唤醒识别时,用于识别的音频是否包含唤醒词。
|
static java.lang.String |
IVW_SST
唤醒业务类型
唤醒业务类型,分为如下几种:
唤醒:wakeup;(单唤醒词,多唤醒词,或特定人唤醒) 注册:enroll;(特定人唤醒注册,又称为“训练”,用于特定人唤醒时,注册用户唤醒词) 唤醒识别:oneshot; 详情请参考 VoiceWakeuper 类的说明。 |
static java.lang.String |
IVW_THRESHOLD
门限值
格式:id:门限值;* (*代表可多个),根据资源携带的唤醒词个数按照“id:门限;id:门限”
的格式传入。
|
static java.lang.String |
IVW_VOL_CHECK
唤醒注册是否返回音量
设置在唤醒注册时,是否返回音量。
|
static java.lang.String |
IVW_WORD_PATH
合并资源目标路径
合并资源目标路径,用于在使用
VoiceWakeuper.updateWords(java.lang.String, java.lang.String) 更新唤醒词
时,设置合并资源后返回的资源文件保存的路径。 |
static java.lang.String |
KEEP_ALIVE
持续唤醒
在持续唤醒时,唤醒一次后,当前会话依然继续,录音还在继续,当有匹配的唤醒
时,会返回结果;否则,唤醒一次后,当前会话已结束,录音也结束,不会再监听。
|
static java.lang.String |
KEY_REQUEST_FOCUS
音频焦点
在需要录音(如听写)或播音(如合成)的会话中,为了避免出现把音乐播放软件
播放的声音录入,或与合成声音同时播的问题,需要让SDK获取系统的音频焦点。
|
static java.lang.String |
KEY_SPEECH_TIMEOUT
语音输入超时时间
设置录取音频的最长时间。
|
static java.lang.String |
LANGUAGE
语言区域
在听写和语音语义理解时,可通过设置此参数,选择要使用的语言区域,参考
Java标准组织定义
Locale 。 |
static java.lang.String |
LEXICON_CONTENT
词典内容
仅在内部使用到,应用层忽略
|
static java.lang.String |
LEXICON_NAME
词典名字
仅在内部使用到,应用层忽略
|
static java.lang.String |
LEXICON_TYPE
词典类型
设置个性化数据上传的数据类型。
|
static java.lang.String |
LIB_NAME
共享库名字
自定义初始化SDK时,要加载的库名字。
|
static java.lang.String |
LOCAL_GRAMMAR
本地语法ID
在使用本地功能时,通过设置此参数,使用本地语法识别。
|
static java.lang.String |
LOCAL_GRAMMAR_PACKAGE
本地语法存储的子路径
应对不同的应用包名,建立子路径,存储本地语法。
|
static java.lang.String |
LOCAL_SPEAKERS
本地TTS发音人
仅在内使用到,应用层可忽略。
|
static java.lang.String |
MFV_AFC
确认周期
用户设置的确认超时时间(生命周期,单位:s),仅在灵活融合验证场景下使用。
|
static java.lang.String |
MFV_DATA_PATH
数据保存路径
通过此参数,可以在声纹业务完成后在本地保存一个音频文件,关于音频文件的格式,
请参考
AUDIO_FORMAT 。 |
static java.lang.String |
MFV_INTERRUPT_ERROR
身份认证会话中断报错
设置身份认证会话被中断时(如当前会话未结束就开启了新会话等),是否通
过
IdentityListener.onError(SpeechError) 回调ErrorCode.ERROR_INTERRUPT 错误。 |
static java.lang.String |
MFV_SCENES
特征场景
用来说明本次会话将涉及的业务。
|
static java.lang.String |
MFV_SST
会话类型
人脸业务(ifr)
包括注册(enroll),验证(verify),删除(delete)。
|
static java.lang.String |
MFV_VCM
融合验证模式
仅在融合验证场景下使用。
|
static java.lang.String |
MIXED_THRESHOLD
混合识别门限
在混合模式,且混合策略为"realtime"时使用。
|
static java.lang.String |
MIXED_TIMEOUT
混合超时
java平台暂不支持此参数。
|
static java.lang.String |
MIXED_TYPE
混合类型
java平台暂不支持此参数。
|
static java.lang.String |
MODE_AUTO
常量值:自动模式
|
static java.lang.String |
MODE_MSC
常量值:MSC模式
|
static java.lang.String |
MODE_PLUS
|
static java.lang.String |
NET_CHECK
网络检查
是否需要检查网络状态再进行会话。
|
static java.lang.String |
NET_TIMEOUT
网络连接超时时间
设置等待结果最长的时间(毫秒)。
|
static java.lang.String |
NEXT_TEXT
预合成文本
预合成文本,用于在线合成时,利用当前合成播放时的网络空余,预合成下一段要
合成的文本。
|
static java.lang.String |
NLP_VERSION
语义版本
通过此参数,设置开放语义协议版本号。
|
static java.lang.String |
NOTIFY_RECORD_DATA
抛出录音数据
设置通过onEvent接口抛出听写、识别、语义业务的录音数据。
|
static java.lang.String |
PARAMS
多参数设置
通过本参数可以同时设置多个参数值。
|
static java.lang.String |
PITCH
合成语调
通过此参数,设置合成返回音频的语调。
|
static java.lang.String |
PLUS_LOCAL_ALL
本地所有资源
|
static java.lang.String |
PLUS_LOCAL_ASR
本地识别资源
|
static java.lang.String |
PLUS_LOCAL_IVW
本地唤醒资源
|
static java.lang.String |
PLUS_LOCAL_TTS
本地合成资源
|
static java.lang.String |
PROT_TYPE
网络协议
在使用业务时与服务端的网络交互协议。
|
static java.lang.String |
RESULT_LEVEL
结果详细等级
返回结果等级(详细程度) ,暂时只有评测用到。
|
static java.lang.String |
RESULT_TYPE
结果类型
听写,识别(语法、命令词),语义理解(语音、文本),评测返回文本结果类
型。
|
static java.lang.String |
SAMPLE_RATE
音频采样率
通过此参数设置音频的采样率。
|
static java.lang.String |
SPEED
合成语速
通过此参数,设置合成返回音频的语速。
|
static java.lang.String |
STREAM_TYPE
合成播放流类型
在安卓平台中,播放器
android.media.AudioTrack 可以使用多种流类型
播放音频,以达到音乐、铃声等类型的声音。 |
static java.lang.String |
SUBJECT
业务类型
会话中区分各业务,除身份认证等在该类的setParameter函数中说明的特
殊业务外,其他可由SDK自动设置,应用可忽略此参数。
|
static java.lang.String |
TEXT_BOM
文本字节顺序
当以byte[]类型传入的文本数据时,若是utf-8或unicode格式,则应在数据中有
字节顺序(Byte Order Mark, BOM)信息,指示数据存储方式。
|
static java.lang.String |
TEXT_ENCODING
文本编码格式
合成传入文本,或构建语法、个性化词典,听写、识别和语义结果的文本编码格式。
|
static java.lang.String |
TTS_AUDIO_PATH
合成音频保存路径
通过此参数,可以在合成完成后在本地保存一个音频文件,关于音频文件的格式,
请参考
AUDIO_FORMAT 。 |
static java.lang.String |
TTS_BUFFER_TIME
合成播放缓冲时间
在合成使用SDK进行播放时,设置此参数使合成音频更快播放。
|
static java.lang.String |
TTS_DATA_NOTIFY
抛出合成数据
设置通过
SynthesizerListener.onEvent(int, int, int, Bundle) 抛出合成的音频数据。 |
static java.lang.String |
TTS_INTERRUPT_ERROR
合成中断错误
合成被异常打断的情况下,是否通知外部错误码
ErrorCode.ERROR_INTERRUPT 。 |
static java.lang.String |
TTS_PLAY_STATE
合成播放状态
通过
SpeechSynthesizer.getParameter(java.lang.String) 获取当前的合成播放状态。 |
static java.lang.String |
TTS_SPELL_INFO
拼音标注信息
此参数暂不支持。
|
static java.lang.String |
TYPE_AUTO
常量值:自动引擎模型
|
static java.lang.String |
TYPE_CLOUD
常量值:云端引擎
|
static java.lang.String |
TYPE_LOCAL
常量值:本地引擎
|
static java.lang.String |
TYPE_MIX
常量值:混合引擎
|
static java.lang.String |
VAD_BOS
前端点超时
开始录入音频后,音频前面部分最长静音时长。
|
static java.lang.String |
VAD_ENABLE
是否允许VAD
VAD(Voice Activity Detection,静音抑制)是用于在音频传输时,通过控制音频
的静音时长,减少在网络传输没有意义的数据,以减少网络带宽使用等。
|
static java.lang.String |
VAD_EOS
后端点超时
是否必须设置:否
开始录入音频后,音频后面部分最长静音时长。
|
static java.lang.String |
VOICE_NAME
合成发音人
通过此参数,在合成中使用不同的语言和方言、性别等。
|
static java.lang.String |
VOLUME
合成音量
通过此参数,设置合成返回音频的音量。
|
static java.lang.String |
WAP_PROXY
网络类型
设置当前应用使用的网络类型。
|
static java.lang.String |
WFR_SST
人脸识别业务类型
在人脸认别会话开始前,通过设置此参数, 决定接下来的会话业务类型
,详情请参考
FaceRequest 类的说明。 |
public static final java.lang.String APPID
初始化SDK时,需要传入APPID值。服务器将根据应用的APPID认证应用接入的权
限和个性化的数据,如用户词表等。APPID需要与使用的SDK一致,否则,将报
ErrorCode.MSP_ERROR_DB_INVALID_APPID
的错误。SDK和APPID的申请
可通过开发者网站申请:
是否必须设置:是
默认值:无
值范围:与SDK一致的十六进制String类型字符串
public static final java.lang.String WAP_PROXY
设置当前应用使用的网络类型。
SDK通过应用设置的不同网络类型,采用不同的优化,提高网络交互速度,减少 带宽占用。默认的,SDK内会获取当前设备的网络类型(在Android等平台时), 应用可不设置此参数。
是否必须设置:否
默认值:无
值范围: { null, "wifi", "cmwap", "ctwap", "uniwap", "cmnet", "uninet", "ctnet", "3gnet" }
public static final java.lang.String FORCE_LOGIN
在初始化调用SpeechUtility.createUtility(Context, java.lang.String)
时会对进程名称进行检查,如果名称
与应用包名不一致则不进行login操作,返回null,用以规避在子进程反复进行调用的问题。
此参数设置是否强制login。
是否必须设置:否
默认值:false
值范围:{ null, true, false }
public static final java.lang.String LIB_NAME
自定义初始化SDK时,要加载的库名字。
在SDK使用时,与服务器交互、音频编解码等模块,都在共享库中,在SDK使用时, 必需使用这些库才可以正常使用功能。关于java使用C共享库函数的知识,请自行查找JNI (Java Native Interface)的相关资料。
SDK默认的库文件名为:libmsc.so。
若应用层需要自定义库名,文件名为“libmyname.so”时, 则设置此参数值为“myname”。
如果库文件参数设置不正常,会引起使用时加载库失败的错误: java.lang.Unsatisfie.lang.UnsatisfiedLinkError no injava.library.path。
是否必须设置:否
默认值:"msc"
值范围:与共享库名一致的字符串
public static final java.lang.String RESULT_TYPE
听写,识别(语法、命令词),语义理解(语音、文本),评测返回文本结果类
型。关于评测结果的等级,请参考RESULT_LEVEL
。
结果类型包括:xml, json, plain。xml和json即对应的结构化文本结构,plain即 自然语言的文本,多用于听写结果。关于xml和json格式的参数说明,请参考新手指 南文档。xml和json格式多用于语法和语义中,在结果中获取置信度值或语义参数值。
识别会话,支持所有结果类型,默认json。听写会话支持json和plain。
语义理解会话,支持xml和json(在设置语义版本NLP_VERSION
值为
1.0时,结果只支持xml格式)。
评测会话,仅支持xml格式。
是否必须设置:否
默认值:"json"
值范围:{ "json", "xml", "plain" }
public static final java.lang.String RESULT_LEVEL
返回结果等级(详细程度) ,暂时只有评测用到。可选:
精简:plain
完全:complete ,目前中文评测仅支持此等级。
关于评测结果的详细说明,请参考《Speech Evaluation API Documents.pdf》。
是否必须设置:否
默认值:"complete"
值范围:{ "complete", "plain" }
public static final java.lang.String LANGUAGE
在听写和语音语义理解时,可通过设置此参数,选择要使用的语言区域,参考
Java标准组织定义 Locale
。在语法和语义识别时,不支持语言区
域选择,当前语法和语义识别仅支持简体中文。关于合成的语言选择,请参考
VOICE_NAME
。关于方言选择,请参考ACCENT
。
当前支持:
简体中文:zh_cn(默认)
美式英文:en_us
是否必须设置:否
默认值:"zh_cn"
值范围:{ "zh_cn", "en_us" }
public static final java.lang.String ACCENT
每一种语言区域,一般还有不同的方言,通过此参数,在听写和语音语义理解时, 设置不同的方言参数。
当前仅在LANGUAGE
为简体中文时,支持方言选择,其他语言区域时,
请把此参数值设为null。
当前支持的中文方言有:
普通话:mandarin(默认)
粤 语:cantonese
四川话:lmz
河南话:henanese
关于合成的方言选择,请参考VOICE_NAME
。关于语言区域的选择,请
参考LANGUAGE
。
是否必须设置:否
默认值:"mandarin"
值范围:{ null, "mandarin", "cantonese", "lmz", "henanese" }
public static final java.lang.String DOMAIN
服务器为不同的应用领域,定制了不同的听写匹配引擎,使用对应的领域能获取更 高的匹配率。
应用领域用于听写和语音语义服务。当前支持的应用领域有:
短信和日常用语:iat (默认)
视频:video
地图:poi
音乐:music
是否必须设置:否
默认值:"iat"
值范围:{ "iat", "video", "poi", "music" }
public static final java.lang.String VAD_ENABLE
VAD(Voice Activity Detection,静音抑制)是用于在音频传输时,通过控制音频 的静音时长,减少在网络传输没有意义的数据,以减少网络带宽使用等。关于VAD的 具体介绍,请自行查找相关的资料。
仅在允许VAD时,VAD_BOS
, VAD_EOS
才会起作用,且各监听
的音量变化回调(如RecognizerListener.onVolumeChanged(int, byte[])
)才会有音量
检测值返回。
是否必须设置:否
默认值:1(是)
值范围:{ null, 0, 1 }
public static final java.lang.String VAD_BOS
开始录入音频后,音频前面部分最长静音时长。
VAD(Voice Activity Detection,静音抑制)是用于在音频传输时,通过控制音频 的静音时长,减少在网络传输没有意义的数据,以减少网络带宽使用等。关于VAD的 具体介绍,请自行查找相关的资料。
SDK为了减少网络带宽,同时又可以自动的根据用户停止说话时的静音来自动结束
音频输入,使用了VAD技术。本参数正是在应用VAD时用于录入音频开始后(包括使
用SDK录音机模式或应用写入音频流模式,见AUDIO_SOURCE
),前面部
份静音的最长时间控制,当音频的前静音时长超过设置值时,SDK就会认为音频输入已
完成。此时,SDK会通过RecognizerListener.onError(SpeechError)
结束会话,
并携带错误码为ErrorCode.MSP_ERROR_NO_DATA
的错误信息。
是否必须设置:否
默认值:听写5000,其他4000
值范围:[1000, 10000]
public static final java.lang.String VAD_EOS
public static final java.lang.String SAMPLE_RATE
通过此参数设置音频的采样率。
音频的采样率是音频属性的其中一个,一般来说,采样率越高音频的质量越好,识 别的匹配率越高,但上传带宽消耗也越大。关于音频采样率的具体说明请自行查找相关 的资料。
采样率设置应该与实际传入的音频一致,否则将无法识别。在使用SDK录音模式时, SDK将根据设置的采样率录取对应音频。同时,不同的业务功能支持的采样率可能不一 样,本参数只列举普遍支持的值,对于具体业务不支持的采样率,请参考对应的类的 setParameter函数的说明。
是否必须设置:否
默认值:16000
值范围:{8000, 16000}
public static final java.lang.String PARAMS
通过本参数可以同时设置多个参数值。特别地,如果设置本参数值为null,将清空 所有设置过的参数,还原为默认值。
设置多参数时,参数名与参数值间,以"="连接,各参数间以","连接。(参数名与 参数值间,各参数间无空格)如"vad_bos=1000,vad_eos=700"。为了减少字符串的 手误,我们建议在没有必要时,还是使用普通的一次设置单个参数值的方式。
是否必须设置:否
默认值:无
值范围:有效的String
类型参数集成
public static final java.lang.String NET_CHECK
是否需要检查网络状态再进行会话。(部分系统和电视平台,获取的网络状态可能不 准确)在设置为进行检查时,检查到网络断开时,直接返回20002错误。
是否必须设置:否
默认值:true
值范围:{ null, true ,false }
SpeechRecognizer.setParameter(java.lang.String, java.lang.String)
,
SpeechSynthesizer.setParameter(java.lang.String, java.lang.String)
,
SpeechUnderstander.setParameter(java.lang.String, java.lang.String)
,
SpeechEvaluator.setParameter(java.lang.String, java.lang.String)
,
SpeakerVerifier.setParameter(java.lang.String, java.lang.String)
,
常量字段值public static final java.lang.String NET_TIMEOUT
设置等待结果最长的时间(毫秒)。当超过设置的时间还没返回结果时,SDK将
主动结束会话。Msc.jar和共享库都有超时控制,默认下,Msc.jar超时时间为20000
ms,共享库超时时间为10000ms,此参数将同时设置Msc.jar和共享库的超时时间。
如果Msc.jar超时将回调ErrorCode.ERROR_NETWORK_TIMEOUT
错误码。
共享库报的网络连接超时的错误码是ErrorCode.MSP_ERROR_TIME_OUT
。
因为Msc.jar使用的超时判断策略和共享库的不一样,即使SDK会把值设置一样,但
两边的超时时间会有先后,当回调最先的一个错误后,另一个错误将被忽略。
是否必须设置:否
默认值:20000
值范围:[0, 30000]
public static final java.lang.String KEY_SPEECH_TIMEOUT
设置录取音频的最长时间。在听写、识别、语音语义和声纹等需要录入音频的业务
下,在录音模式时,录取音频的最长时间。当录音超过这个时间时,SDK会自动结束
录音,并等待结果返回。当此参数值设为-1时,表示超时时间为无限,仅在评测和转
写时生效,在其他业务中,服务器最长仅支持60秒的音频,超过的音频将被忽略。
关于转写支持的最长时长,请参考转写类SpeechTranscripter
说明。
是否必须设置:否
默认值:60000 (评测和转写时,为-1)
值范围:[-1, 60000] (在转写时,为[-1,+∞))
public static final java.lang.String ENGINE_MODE
public static final java.lang.String ENGINE_TYPE
设置使用的引擎类型:在线、离线、混合。在申请了离线合成资源和权限, 可以选择使用本地或在线的方式进行语音服务。
使用在线模式(又称云端模式)时,需要使用网络,产生一定流量,但有更好的识别 或合成的效果,如更高的识别匹配度,更多的发音人等。
使用离线模式(又称本地模式)时,不需要使用网络,且识别和合成的速度更快,但同 时要求使用对应的离线资源。
在混合模式时,可以通过混合类型
、
云端超时
、本地置信门限
使用对应的策略,提高识别准确度与成功率。详情参见前面的几个参数说明。
在离线或混合模式下,需要设置对应的资源。请参考
合成资源路径:ResourceUtil.TTS_RES_PATH
;
识别资源路径:ResourceUtil.ASR_RES_PATH
;
唤醒资源路径:IVW_RES_PATH
;
关于离线资源的其他介绍,参考ResourceUtil
类的说明。
是否必须设置:否
默认值:"cloud"
值范围:{ "cloud", "local","mixed" }
public static final java.lang.String AUDIO_SOURCE
设置SDK是使用 Android自带的录音机录制音频方式,还是使用应用传入音频流方式。
Android自带录音机具体支持方式请见 android.media.MediaRecorder.AudioSource
。当通过
麦克风录入音频时,应用需拥有以下权限:
android.Manifest.permission#RECORD_AUDIO
SDK在系统类型基础上扩充两种音频流方式:
1、在写音频流方式(-1)下,应用层通过writeAudio函数送入音频;
2、在传文件路径方式(-2)下,SDK通过应用层设置的ASR_SOURCE_PATH
值,
直接读取音频文件。目前仅在SpeechRecognizer
中支持。
是否必须设置:否
默认值:1 (MediaRecorder.AudioSource.MIC
)
值范围:SDK扩展方式{ -2, -1} 和 Android系统自带方式android.media.MediaRecorder.AudioSource
public static final java.lang.String ASR_SOURCE_PATH
外部音频文件的路径,在直接听写、识别音频文件时可通过设置此参数,传入文件的路
径,SDK自动读取文件进行识别,不用应用层调用SpeechRecognizer.writeAudio(byte[], int, int)
函数传入音频流。仅在AUDIO_SOURCE
值为-2时生效。
是否必须设置:否
默认值:null
值范围:String
类型值的文件路径(含文件名)
public static final java.lang.String FILTER_AUDIO_TIME
部分系统存在启动录音后,有短暂的音频跳变,通过设置此参数,可以过滤掉此部分音频, 提高识别效果。
是否必须设置:否
默认值:0
值范围:[0, 60000]
public static final java.lang.String LOCAL_GRAMMAR
在使用本地功能时,通过设置此参数,使用本地语法识别。当此参数值为 null 时SDK 将使用本地听写。
是否必须设置:否
默认值:null
值范围:有效的String
类型语法ID
public static final java.lang.String CLOUD_GRAMMAR
即原GRAMMAR_ID参数。
在线语法识别时,通过设置此参数,使用对应的语法文件。语法ID由应用层使用SpeechRecognizer.buildGrammar(String, String, GrammarListener)
构造语法后,通
过GrammarListener.onBuildFinish(String, SpeechError)
回调返回。在应用层不
设置此参数,或此参数值为null时,将不使用任何语法,使用的是听写功能。
关于语法文件的编写,请参考。
是否必须设置:否
默认值:null
值范围:有效的String
类型语法ID
public static final java.lang.String GRAMMAR_TYPE
在使用识别识别时,需要设置与使用的类型一致语法类型的参数。构建本地语法
仅支持"bnf",构建在线语法支持“abnf”,在线语法识别还可以直接在识别时,设置为
语法类型为"url-list",并设置CLOUD_GRAMMAR
为由服务端提供的语法链接
地址,使用服务器已经存在的语法路径(但目前此用法很少,不建议使用)。
是否必须设置:否
默认值:null
值范围:{ null, "abnf", "bnf", "url-list" }
public static final java.lang.String GRAMMAR_NAME
上传语法时的语法名字。目前上传语法后,暂不能通过语法名字使用,此参数为可选 参数。
是否必须设置:否
默认值:null
值范围:任意字符串值
public static final java.lang.String GRAMMAR_CONTENT
仅在内部使用到,应用层忽略
public static final java.lang.String LEXICON_CONTENT
仅在内部使用到,应用层忽略
public static final java.lang.String LEXICON_NAME
仅在内部使用到,应用层忽略
public static final java.lang.String GRAMMAR_LIST
在本地语法识别时,在构建语法后,可通过
SpeechRecognizer.updateLexicon(String, String, LexiconListener)
更新语法中
指定的词表,如本地语法“call”中的"contact",则指定本参数值为"call",在
SpeechRecognizer.updateLexicon(String, String, LexiconListener)
的参数1中
指定值为"contact"。
是否必须设置:否
默认值:null
值范围:有效的String
类型语法名字
public static final java.lang.String LOCAL_GRAMMAR_PACKAGE
应对不同的应用包名,建立子路径,存储本地语法。仅在内部使用到,应用层可 忽略此参数。
public static final java.lang.String NOTIFY_RECORD_DATA
设置通过onEvent接口抛出听写、识别、语义业务的录音数据。当设为抛出时,会通过
监听器的onEvent函数,如RecognizerListener.onEvent(int, int, int, Bundle)
,回调返回音频数据,
事件ID为SpeechEvent.EVENT_RECORD_DATA
。事件详情请参考该事件ID的说
明。
是否必须设置:否
默认值:0
值范围:{ null, 0,1 }
SpeechEvent.EVENT_RECORD_DATA
,
RecognizerListener.onEvent(int, int, int, Bundle)
,
RecognizerListener.onVolumeChanged(int, byte[])
,
SpeechUnderstanderListener.onEvent(int, int, int, Bundle)
,
SpeechRecognizer.setParameter(java.lang.String, java.lang.String)
,
SpeechUnderstander.setParameter(java.lang.String, java.lang.String)
,
常量字段值public static final java.lang.String MIXED_THRESHOLD
在混合模式,且混合策略为"realtime"时使用。当本地引擎给出结果大于此门限值时, 不用等待云端超时,即马上返回本地结果。
是否必须设置:否
默认值:60
值范围:[0, 100]
public static final java.lang.String MIXED_TYPE
java平台暂不支持此参数。
在混合模式下,通过设置此参数,选择对应的混合类型:
realtime:实时,同时向云端和本地发送音频,在云端超时,或本地
置信门限
大于指定值时,使用本地结果;
delay: 延时,在云端识别超时后,向本地发送音频。
是否必须设置:否
默认值:"realtime"
值范围:{ null, "realtime", "delay" }
public static final java.lang.String MIXED_TIMEOUT
java平台暂不支持此参数。
在混合模式下,通过设置此参数,选择云端超时时间。
是否必须设置:否
默认值:2000
值范围:[0, 30000]
public static final java.lang.String ASR_THRESHOLD
用在本地识别中,设置引擎只给出大于此门限值的识别结果。
是否必须设置:否
默认值:0
值范围:[0, 100]
public static final java.lang.String LEXICON_TYPE
设置个性化数据上传的数据类型。在使用
SpeechRecognizer.updateLexicon(String, String, LexiconListener)
上
传用户个性化数据时,通过此参数,设置要更新的是用户词表("userword"),
还是联系人列表("contact")。在匹配应用定制的个性化数据时,相似的音将优
先匹配联系人列表。
是否必须设置:是
默认值:null
值范围:{ "contact", "userword" }
public static final java.lang.String ASR_NBEST
在听写和语法、命令词识别时,通过设置此参数,获取在发音相似时的句子多侯选结 果。设置多候选会影响性能,响应时间延迟200ms左右。
是否必须设置:否
默认值:听写:1,语法或命令词:在线 3,本地 1
值范围:听写:[1, 5],语法或命令词:在线[0, 10], 本地{0, 1}
public static final java.lang.String ASR_WBEST
在听写和语法、命令词识别时,通过设置此参数,获取在发音相似时的词语多侯选结 果。设置多候选会影响性能,响应时间延迟200ms左右。
是否必须设置:否
默认值:听写:1,语法或命令词:在线 3,本地 1
值范围:听写:[1, 5],语法或命令词:在线[0, 10], 本地{0, 1}
public static final java.lang.String ASR_PTT
通过此参数,设置听写文本结果是否含标点符号。0表示不带标点,1则表示带标点。
是否必须设置:否
默认值:1
值范围:{ null, 0, 1 }
public static final java.lang.String ASR_DWA
设置听写结果是否动态修正。为“1”则在听写过程中动态递增地返回结果,否则只 在听写结束之后返回最终结果。
是否必须设置:否
默认值:0
值范围:{ null, 0, 1 }
public static final java.lang.String NLP_VERSION
通过此参数,设置开放语义协议版本号。不参的版本号,返回的结果格式将不一样。 在1.0版本时,返回结果只支持xml格式,在2.0版本时,返回结果同时支持xml和json。 。
是否必须设置:否
默认值:"1.0"
值范围:{ null, "1.0", "2.0" }
public static final java.lang.String TYPE_LOCAL
ENGINE_TYPE
,
常量字段值public static final java.lang.String TYPE_CLOUD
ENGINE_TYPE
,
常量字段值public static final java.lang.String TYPE_MIX
ENGINE_TYPE
,
常量字段值public static final java.lang.String TYPE_AUTO
ENGINE_MODE
,
常量字段值public static final java.lang.String ISV_SST
设置声纹业务类型。声纹业务,包括:train(训练),verify(验证),identify(
鉴别),详情请参考SpeakerVerifier
类的说明。
是否必须设置:是
默认值:null
值范围:{ null, "train", "verify", "identify" }
public static final java.lang.String ISV_PWDT
设置声纹密码类型。声纹密码类型,包括:1(文本密码),2(自由说),
3(数字密码)。详情请参考SpeakerVerifier
类的说明。
(当前只支持数字密码,文本密码及自由说正在研发中)
是否必须设置:是
默认值:null
值范围:{ null, 1, 2, 3 }
public static final java.lang.String ISV_VID
注册成功服务端返回的此次注册的id。目前此参数值在声纹交互中尚未曾使用到, 应用层可忽略此参数。
是否必须设置:否
默认值:null
值范围:有效的声纹ID值
public static final java.lang.String ISV_RGN
在注册声纹模型时,需要设置模型训练的次数。引擎通过用户上传的音频,获取 用户的声纹特征,训练次数越多,识别越精准,越难被模仿。当前支持的训练次数是 2~9次。
是否必须设置:是
默认值:null
值范围:[2, 9]
public static final java.lang.String ISV_PWD
在声纹注册和验证时,除自由说类型外,其余均需要设置对应类型的待注册或验
证的密码,且,密码需要从服务器中获取(见
SpeakerVerifier.getPasswordList(SpeechListener)
)。随机数字密码
验证时,通过SpeakerVerifier.generatePassword(int)
获取密码。
是否必须设置:是
默认值:null
值范围:有效的密码字符串
public static final java.lang.String ISV_AUDIO_PATH
通过此参数,可以在注册或验证完成后在本地保存一个音频文件(目前保存为 Windows pcm)。在Android平台上,如保存到SDCARD,需添加 WRITE_EXTERNAL_STORAGE的权限。
是否必须设置:否
默认值:null
值范围:有效的文件相对或绝对路径(含文件名)
public static final java.lang.String ISV_CMD
在进行声纹操作时,需要设置操作的命令:que(查询),del(删除)。
是否必须设置:是
默认值:null
值范围:{ "que", "del" }
public static final java.lang.String ISV_INTERRUPT_ERROR
设置声纹会话被中断时(如当前会话未结束就开启了新会话等),是否通
过VerifierListener.onError(SpeechError)
回调ErrorCode.ERROR_INTERRUPT
错误。
是否必须设置:否
默认值:false
值范围:{ null, true, false }
public static final java.lang.String WFR_SST
在人脸认别会话开始前,通过设置此参数, 决定接下来的会话业务类型
,详情请参考FaceRequest
类的说明。业务类型包括:
注册:reg,
验证:verify,
检测:detect,
聚焦:align
是否必须设置:是
默认值:null
值范围:{ "reg", "verify", "detect", "align" }
public static final java.lang.String ISE_USER_MODEL_ID
评测用户模型,是保存在服务器端的模型。由于目前暂不支持应用创建用户模型, 可忽略此参数。
是否必须设置:否
默认值:null
值范围:有效的用户模型ID
public static final java.lang.String ISE_CATEGORY
指定当前评测会话的题型,包括以下值:
read_syllable:朗读单字,英文评测不支持;
read_word:朗读词语;
read_sentence:朗读句子;
read_chapter:朗读篇章,暂不支持;
speaker_adapt:自适应,暂不支持;
choice_question:选择题型,暂不支持;
关于题型的详细说明,请参考《Speech Evaluation API Documents.pdf》。
是否必须设置:是
默认值:null
值范围:{ null ,"read_syllable", "read_word", "read_sentence", "read_chapter" , "speaker_adapt", "choice_question" }
public static final java.lang.String ISE_ENT
指定当前评测需要使用的引擎。指定的引擎应该与实际评测的内容所需要的一致。
目前支持的引擎如下:
英文:en_us
中文:zh_cn
是否必须设置:是
默认值:null
值范围:{ null, "en_us", "zh_cn" }
public static final java.lang.String ISE_PARSED
试卷未标注,云端会先调用标注引擎进行标注,然后把标注结果传给引擎;
试卷已标注,云端将直接传给引擎进行评测。标注指试题是否包含拼音标注。
关于试题的说明,请参考ISE_CATEGORY
。
是否必须设置:否
默认值:0
值范围:{ null, 0, 1 }
public static final java.lang.String ISE_AUTO_TRACKING
设置朗读跟踪,只对句子和篇章有效。关于跟踪模式设置,请参考
ISE_TRACK_TYPE
。在开启朗读跟踪时,每次的朗读都会实时的
通过EvaluatorListener.onResult(EvaluatorResult, boolean)
返回
跟踪信息,指示当前朗读的文本信息。值得注意的是,跟踪信息并不是评测
结果,跟踪信息的数据首个 xml 标签为"Data",而评测结果则为"xml_result"。
关于跟踪信息和评测结果的说明,请参考EvaluatorResult
。
是否必须设置:否
默认值:"disable"
值范围:{ null, "enable", "disable" }
public static final java.lang.String ISE_TRACK_TYPE
跟踪模式包括严格模式(hard)和宽松模式(easy)。在宽松模式下,读音与 试题大概一致便会返回当前的跟踪位置;相反,在严格模式下,则要求读音更准确 才会返回当前跟踪的位置。
此参数仅在朗读跟踪
开启时生效。
是否必须设置:否
默认值:null
值范围:{ null, "easy", "hard" }
public static final java.lang.String ISE_INTERRUPT_ERROR
设置评测会话被中断时(如当前会话未结束就开启了新会话等),是否通
过EvaluatorListener.onError(com.iflytek.cloud.SpeechError)
回调ErrorCode.ERROR_INTERRUPT
错误。
是否必须设置:否
默认值:false
值范围:{ null, true, false }
public static final java.lang.String ISE_AUDIO_PATH
通过此参数,可以在评测完成后在本地保存一个音频文件。关于音频文件的格式,
请参考AUDIO_FORMAT
。在Android平台上,如保存到SDCARD,需添加
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
的权限。
是否必须设置:否
默认值:null
值范围:有效的文件相对或绝对路径(含文件名)
public static final java.lang.String ISE_SOURCE_PATH
外部音频文件的路径,在直接听写、识别音频文件时可通过设置此参数,传入文件的路
径,SDK自动读取文件进行识别,不用应用层调用SpeechEvaluator.writeAudio(byte[], int, int)
接口传入音频流。仅在AUDIO_SOURCE
值为-2时生效。
是否必须设置:否
默认值:null
值范围:String
类型值的文件路径(含文件名)
public static final java.lang.String IVW_SST
唤醒业务类型,分为如下几种:
唤醒:wakeup;(单唤醒词,多唤醒词,或特定人唤醒)
注册:enroll;(特定人唤醒注册,又称为“训练”,用于特定人唤醒时,注册用户唤醒词)
唤醒识别:oneshot;
详情请参考VoiceWakeuper
类的说明。
特定人唤醒暂不支持。
是否必须设置:是
默认值:null
值范围:{ null, "wakeup", "enroll", "oneshot" }
public static final java.lang.String IVW_WORD_PATH
合并资源目标路径,用于在使用 VoiceWakeuper.updateWords(java.lang.String, java.lang.String)
更新唤醒词
时,设置合并资源后返回的资源文件保存的路径。需要注意的是,此参数并不通过VoiceWakeuper.setParameter(String, String)
设置,而是设置在
VoiceWakeuper.updateWords(java.lang.String, java.lang.String)
的参数2中。且由于是用来保存的路径,不必通过
ResourceUtil.generateResourcePath(Context, com.iflytek.cloud.util.ResourceUtil.RESOURCE_TYPE, java.lang.String)
生成路径值,而是
直接设置即可,如"/sdcard/dest.jet"。
是否必须设置:是(在合并资源时,必须设置,其他不必)
默认值:null
值范围:有效的String
类型路径
public static final java.lang.String IVW_THRESHOLD
格式:id:门限值;* (*代表可多个),根据资源携带的唤醒词个数按照“id:门限;id:门限” 的格式传入。门限值越高,则要求匹配度越高,才能唤醒。
是否必须设置:否
默认值:0
值范围:[-150, 150]
public static final java.lang.String KEEP_ALIVE
在持续唤醒时,唤醒一次后,当前会话依然继续,录音还在继续,当有匹配的唤醒 时,会返回结果;否则,唤醒一次后,当前会话已结束,录音也结束,不会再监听。
此参数对唤醒识别不起作用,见IVW_SST
。
是否必须设置:否
默认值:0
值范围:{null, 0, 1}
public static final java.lang.String IVW_SHOT_WORD
设置唤醒识别时,用于识别的音频是否包含唤醒词。
当包含时,唤醒词作为识别语法的一部分,在语法中必须包含唤醒词,否则将没有 匹配结果。相反的,在不包含时,唤醒词不参与识别,在说完唤醒词后,需要完整的说出 语法中的句子。
是否必须设置:否
默认值:1
值范围:{null, 0, 1}
public static final java.lang.String IVW_ENROLL_RES_PATH
唤醒注册功能在注册唤醒模型时,需要辅助资源,才能进行。通过此参数,设置
辅助资源路径值。资源路径值为由
ResourceUtil.generateResourcePath(Context, com.iflytek.cloud.util.ResourceUtil.RESOURCE_TYPE, java.lang.String)
生成标准的路
径值,请参考该函数的说明。
是否必须设置:是(仅在注册模型时)
默认值:null
值范围:有效的资源路径
public static final java.lang.String IVW_ENROLL_DEST_PATH
设置一个文件路径,用于保存训练唤醒词生成的资源路径。与
IVW_ENROLL_RES_PATH
设置使用资源路径不同的是,这里设置保存
资源的路径不需要通过ResourceUtil.generateResourcePath(Context, com.iflytek.cloud.util.ResourceUtil.RESOURCE_TYPE, java.lang.String)
生成,直接设置即可,如"/sdcard/msc/ivw_test.jet"。
是否必须设置:是(仅在注册模型时)
默认值:null
值范围:有效的文件路径
public static final java.lang.String IVW_ENROLL_TMIN
唤醒注册时,为了保证模型的唤醒效果,过长或过短的音频都不好,需要一个合适的音频 长度,目前,在引擎定义这个时长为250~4000毫秒。此音频时长不包括首尾的静音部分,指 录音打开后,用户开始说话时(由VAD检测到音量非0时),开始算起。
是否必须设置:否
默认值:510
值范围:[250, 4000]
public static final java.lang.String IVW_ENROLL_TMAX
public static final java.lang.String IVW_VOL_CHECK
设置在唤醒注册时,是否返回音量。设置为是时,将通过
WakeuperListener.onVolumeChanged(int)
实时返回音量值;否则不会返回。
是否必须设置:否
默认值:0
值范围:{ null, 0, 1 }
public static final java.lang.String IVW_ENROLL_TIMES
唤醒注册为了建立模型,需要多次采集用户对同一唤醒词的音频,即在一次注册的会话中,
要求用户多次读出同一唤醒词。在此过程中,用户一次唤醒词音频送入SDK后,SDK通过
WakeuperListener.onResult(WakeuperResult)
告知应用,当次注册的是否成功,应用
则根据这个结果,提示用户进行下一轮读唤醒词,或是重新开始。
目前仅支持三次。
是否必须设置:否
默认值:3
值范围:{ null, 3 }
public static final java.lang.String IVW_RES_PATH
唤醒需要使用本地资源,通过此参数设置本地资源所在的路径。多个资源间,以英文分号";"分隔。
与IVW_ENROLL_RES_PATH
一样,用于使用的资源,需要通过
ResourceUtil.generateResourcePath(Context, com.iflytek.cloud.util.ResourceUtil.RESOURCE_TYPE, java.lang.String)
生成标准的资源路径值。
请参考 ResourceUtil.generateResourcePath(Context, com.iflytek.cloud.util.ResourceUtil.RESOURCE_TYPE, java.lang.String)
。
是否必须设置:是(在非注册时)
默认值:null
值范围:有效的资源文件路径
public static final java.lang.String VOICE_NAME
通过此参数,在合成中使用不同的语言和方言、性别等。设
置的发音人
,语速
, 语调
,
音量
,在一次合成时开始后,就会在合成的音频中生效,此时,若
要中途改变这些参数,则应该从想要改变的文本处重新开始合成,因为已经返回的音频
是无法再改变的。
云端支持发音人:小燕(xiaoyan)、小宇(xiaoyu)、凯瑟琳(Catherine)、 亨利(henry)、玛丽(vimary)、小研(vixy)、小琪(vixq)、 小峰(vixf)、小梅(vixm)、小莉(vixl)、小蓉(vixr)、 小芸(vixyun)、小坤(vixk)、小强(vixqa)、小莹(vixying)、 小新(vixx)、 楠楠(vinn)、老孙(vils)。
本地支持发音人: 小燕(xiaoyan)。( java 平台暂不支持本地功能)
更多内容请参考官方网站:。
是否必须设置:否
默认值:xiaoyan
值范围:见上文。
public static final java.lang.String NEXT_TEXT
预合成文本,用于在线合成时,利用当前合成播放时的网络空余,预合成下一段要
合成的文本。使用了预合成后,可大幅度提高合成播放的流畅度。预合成的文本要与
下一次SpeechSynthesizer.startSpeaking(java.lang.String, com.iflytek.cloud.SynthesizerListener)
的文本一致,才会使预合成生效。
此参数仅在设置后的那次SpeechSynthesizer.startSpeaking(java.lang.String, com.iflytek.cloud.SynthesizerListener)
的会话中生效,
下次SpeechSynthesizer.startSpeaking(java.lang.String, com.iflytek.cloud.SynthesizerListener)
前没有设置此参数,则此参数值
为null。
是否必须设置:否
默认值:null
值范围:null,或下一次会话要进行合成的文本
public static final java.lang.String LOCAL_SPEAKERS
仅在内使用到,应用层可忽略。
public static final java.lang.String SPEED
通过此参数,设置合成返回音频的语速。
是否必须设置:否
默认值:50
值范围:[0, 100]
public static final java.lang.String PITCH
通过此参数,设置合成返回音频的语调。
是否必须设置:否
默认值:50
值范围:[0, 100]
public static final java.lang.String VOLUME
通过此参数,设置合成返回音频的音量。合成音量,影响的是合成到的音频本身的 音量大小(振幅),而非播放时系统的音量。关于播放时操作系统的音量,则请自行 查找操作系统相关API开发接口说明。
是否必须设置:否
默认值:50
值范围:[0, 100]
public static final java.lang.String BACKGROUND_SOUND
背景音乐 默认值:无,可选:1
是否必须设置:否
默认值:0
值范围:{ null, 0, 1 }
public static final java.lang.String TTS_BUFFER_TIME
在合成使用SDK进行播放时,设置此参数使合成音频更快播放。
一般情况下,合成根据第一小句(出现逗号或者句号等断句)返回音频完成时,开
始播放音频,这样不会出现每小句中播放到中途出现音频未返回完而中断播放的情况。
然而,这样会因为等待第一小句音频完成,而可能会使播放开始时间慢几百毫秒以上。
对于某些播报实时性要求很高的应用来说,这个可能是无法接受的。通过此参数,可以
设置返回音频的时长达到多少毫秒后,就马上开始播放已有音频,而不必等待第一小句的完
成(当值超过第一小句时间时,将以第一小句完成开始播放)。然而,设置此参数后为大于
等于0后,合成的播放回调SynthesizerListener.onSpeakProgress(int, int, int)
返回的当前播放的文本位置将不再准确。所以,此参数一般用于使用了本地合成,且实
时性要求很高,但对播报文本位置回调没有要求的应用中,如滴滴打车等。
当值为-1时,等待第一小句缓冲完成,开始播放;当值为大于等于0时,等待缓冲音 频时长大于等于设置值时,即开始播放。
是否必须设置:否
默认值:-1
值范围:{ null, [-1, +) }
public static final java.lang.String TTS_PLAY_STATE
通过SpeechSynthesizer.getParameter(java.lang.String)
获取当前的合成播放状态。
此参数值仅用于获取,不用来设置。
取值:0(初始化),1(缓冲中),2(播放中),3(暂停中),4(停止)
public static final java.lang.String TTS_DATA_NOTIFY
设置通过SynthesizerListener.onEvent(int, int, int, Bundle)
抛出合成的音频数据。当设为抛出时,
会通过回调返回音频数据,事件ID为SpeechEvent.EVENT_TTS_BUFFER
。事件
详情请参考该事件ID的说明。仅在合成到
文件
时生效。
是否必须设置:否
默认值:0
值范围:{ null, 0,1 }
public static final java.lang.String TTS_INTERRUPT_ERROR
合成被异常打断的情况下,是否通知外部错误码
ErrorCode.ERROR_INTERRUPT
。如应用层在当前合成未结束,就调用
SpeechSynthesizer.startSpeaking(java.lang.String, com.iflytek.cloud.SynthesizerListener)
开始新的会话。默认为不通知(false)。
是否必须设置:否
默认值:false
值范围:{ null, true,false }
public static final java.lang.String TTS_SPELL_INFO
此参数暂不支持。
如外部需要返回拼音标注,则需要设置此值为true。
是否必须设置:否
默认值:false
值范围:{ null, true,false }
public static final java.lang.String AUDIO_FORMAT
保存的音频格式(合成、听写、识别、语义、声纹、评测业务支持)。仅在
audio_path(ASR_AUDIO_PATH
, TTS_AUDIO_PATH
,
ISV_AUDIO_PATH
, ISE_AUDIO_PATH
)非空时生效。
支持保存为以下格式:
1,带音频文件头的 Windows Pcm Wav("wav");
2,不带音频文件头的 Windows Pcm Raw Data ("pcm")(默认);
是否必须设置:否
默认值:"pcm"
值范围:{ null, "wav","pcm" }
SpeechSynthesizer.setParameter(java.lang.String, java.lang.String)
,
SpeechRecognizer.setParameter(java.lang.String, java.lang.String)
,
SpeakerVerifier.setParameter(java.lang.String, java.lang.String)
,
SpeechUnderstander.setParameter(java.lang.String, java.lang.String)
,
SpeechEvaluator.setParameter(java.lang.String, java.lang.String)
,
TTS_AUDIO_PATH
,
ASR_AUDIO_PATH
,
ISV_AUDIO_PATH
,
ISE_AUDIO_PATH
,
常量字段值public static final java.lang.String STREAM_TYPE
在安卓平台中,播放器android.media.AudioTrack
可以使用多种流类型
播放音频,以达到音乐、铃声等类型的声音。
是否必须设置:否
默认值:android.media.AudioManager#STREAM_MUSIC
值范围:android.media.AudioManager
支持的流类型值
public static final java.lang.String KEY_REQUEST_FOCUS
在需要录音(如听写)或播音(如合成)的会话中,为了避免出现把音乐播放软件
播放的声音录入,或与合成声音同时播的问题,需要让SDK获取系统的音频焦点。通过
此参数,设置是否会话过程中由SDK获取音频焦点。当SDK获取或释放音频焦点时,系
统通过android.media.AudioManager.OnAudioFocusChangeListener#onAudioFocusChange
回调通知所有监听,音频焦点的变化。应用层也可以设置不由SDK获取音频焦点,并自
己实现音频焦点获取、丢失时,暂停合成播放等处理。
是否必须设置:否
默认值:true
值范围:{ null, true,false }
SpeechSynthesizer.setParameter(java.lang.String, java.lang.String)
,
SpeechRecognizer.setParameter(java.lang.String, java.lang.String)
,
SpeakerVerifier.setParameter(java.lang.String, java.lang.String)
,
SpeechUnderstander.setParameter(java.lang.String, java.lang.String)
,
SpeechEvaluator.setParameter(java.lang.String, java.lang.String)
,
常量字段值public static final java.lang.String TTS_AUDIO_PATH
通过此参数,可以在合成完成后在本地保存一个音频文件,关于音频文件的格式,
请参考AUDIO_FORMAT
。在Android平台上,如保存到SDCARD,需添加
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
的权限。
是否必须设置:否
默认值:null
值范围:有效的文件相对或绝对路径(含文件名)
public static final java.lang.String DATA_TYPE
已被LEXICON_TYPE
取代。
设置个性化数据上传的数据类型。在使用
SpeechRecognizer.updateLexicon(String, String, LexiconListener)
及
DataUploader.uploadData(SpeechListener, String, byte[])
上传用户个
性化数据时,通过此参数,设置要更新的是用户词表("userword"),还是联系
人列表("contact")。在匹配应用定制的个性化数据时,相似的音将优先匹配联
系人列表。
是否必须设置:是
默认值:null
值范围:{ "contact", "userword" }
SpeechRecognizer.updateLexicon(String, String, LexiconListener)
,
DataUploader.uploadData(SpeechListener, String, byte[])
,
常量字段值public static final java.lang.String SUBJECT
会话中区分各业务,除身份认证等在该类的setParameter函数中说明的特
殊业务外,其他可由SDK自动设置,应用可忽略此参数。业务类型包括:
听写
:iat
识别
:asr
合成
:tts
声纹
:ivp
评测
:ise
多重认证
:mfv
身份认证之声纹
:ivp
身份认证之人脸
:ifr
上传
:uup
转写
:ist
部分业务可能未开放,或已不再支持,请参考各类的说明。
是否必须设置:视不同类而异
默认值:视不同类而异
值范围:见上文
public static final java.lang.String ASR_AUDIO_PATH
通过此参数,可以在识别完成后在本地保存一个音频文件。关于音频文件的格式,
请参考AUDIO_FORMAT
。在Android平台上,如保存到SDCARD,需添加
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
的权限。
是否必须设置:否
默认值:null
值范围:有效的文件相对或绝对路径(含文件名)
public static final java.lang.String ASR_INTERRUPT_ERROR
设置识别会话被中断时(如当前会话未结束就开启了新会话等),是否通
过RecognizerListener.onError(com.iflytek.cloud.SpeechError)
回调ErrorCode.ERROR_INTERRUPT
错误。
是否必须设置:否
默认值:false
值范围:{ null, true, false }
public static final java.lang.String ASR_NOMATCH_ERROR
通过此参数,设置在识别无结果时,是否通过RecognizerListener.onError(com.iflytek.cloud.SpeechError)
返回ErrorCode.MSP_ERROR_NO_DATA
错误。
是否必须设置:否
默认值:true
值范围:{ null, true, false }
public static final java.lang.String ASR_NET_PERF
通过此参数,获取网络连接状态(仅在识别和听写)。网络状态是SDK通过测试
网络连接返回的[0, 100]范围的状态值,值越高,表示网络状态越好。设置此参数为
真后,网络状态将通过onEvent函数的SpeechEvent.EVENT_NETPREF
事件返回给应用层。
是否必须设置:否
默认值:false
值范围:{ null, true, false }
public static final java.lang.String ENG_ASR
public static final java.lang.String ENG_TTS
public static final java.lang.String ENG_NLU
public static final java.lang.String ENG_IVW
public static final java.lang.String ENG_IVP
public static final java.lang.String ENG_WFR
public static final java.lang.String ENG_EVA
public static final java.lang.String MODE_MSC
public static final java.lang.String MODE_PLUS
public static final java.lang.String MODE_AUTO
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)
,
SpeechSynthesizer.setParameter(String, String)
,
SpeechRecognizer.buildGrammar(String, String, GrammarListener)
,
SpeechRecognizer.updateLexicon(String, String, LexiconListener)
,
DataUploader.uploadData(SpeechListener, String, byte[])
,
常量字段值public static final java.lang.String TEXT_BOM
当以byte[]类型传入的文本数据时,若是utf-8或unicode格式,则应在数据中有 字节顺序(Byte Order Mark, BOM)信息,指示数据存储方式。当没有字节顺序 信息时,unicode编码时,默认数据为“UnicodeLittleUnmarked”格式。
是否必须设置:否
默认值:1
值范围:{ null, 0, 1 }
public static final java.lang.String AUTH_ID
授权ID,是每个应用的用户的唯一标识,声纹密码,人脸识别,以及身份认证时需要设置。
在获取密码,注册和验证声纹,查询和删除声纹模型时,必须设置的用于区分操作
的用户模型的标识。授权ID由应用层自定义,应保证每个用户的ID不一样,否则,
可能在注册时,报ErrorCode.MSP_ERROR_ALREADY_EXIST
的错误。若
注册时需要覆盖一个已存在的授权ID,可以在注册时,设置参数名“property”的
值为"del"。
是否必须设置:是
默认值:null
值范围:6-18位,以英文字母开头,由英文字母、阿拉伯数字和下划线组成,区分 字母大小字的字符串。
SpeakerVerifier.sendRequest(String, String, SpeechListener)
,
SpeakerVerifier.setParameter(String, String)
,
IdentityVerifier.setParameter(String, String)
,
常量字段值public static final java.lang.String MFV_SST
人脸业务(ifr)
包括注册(enroll),验证(verify),删除(delete)。
暂不支持:重新注册(reenroll)查询(query)。
声纹业务(ivp)
包括注册(enroll,或train),验证(verify),查询(query),删除(delete),下载(download)
暂不支持:重新注册(reenroll)
请参考IdentityVerifier
类的说明。
是否必须设置:是
默认值:null
值范围:
人脸业务时:{ "enroll", "verify", "reenroll", "query", "delete" }
声纹业务时:{ "enroll", "verify", "reenroll", "query", "delete", "download" }
IdentityVerifier.setParameter(String, String)
,
IdentityVerifier
,
常量字段值public static final java.lang.String MFV_VCM
仅在融合验证场景下使用。可选值:单一生物特征数据验证(sin),混合生物特征数据验证(mix), 灵活生物特征数据验证(agi)。
是否必须设置:是(仅在融合验证场景下)
默认值:null
值范围:{ "sin", "mix", "agi" }
IdentityVerifier.setParameter(String, String)
,
IdentityVerifier
,
常量字段值public static final java.lang.String MFV_SCENES
用来说明本次会话将涉及的业务。包括:声纹(ivp),人脸(ifr),人脸声纹融合(ivp|ifr)。
是否必须设置:是
默认值:null
值范围:{ null, "ivp", "ifr", "ivp|ifr" }
IdentityVerifier.setParameter(String, String)
,
IdentityVerifier
,
常量字段值public static final java.lang.String MFV_AFC
用户设置的确认超时时间(生命周期,单位:s),仅在灵活融合验证场景下使用。
是否必须设置:否
默认值:30
值范围:[3, 45]
IdentityVerifier.setParameter(String, String)
,
常量字段值public static final java.lang.String MFV_DATA_PATH
通过此参数,可以在声纹业务完成后在本地保存一个音频文件,关于音频文件的格式,
请参考AUDIO_FORMAT
。在Android平台上,如保存到SDCARD,需添加
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
的权限。
是否必须设置:否
默认值:null
值范围:有效的文件相对或绝对路径(含文件名)
IdentityVerifier.setParameter(String, String)
,
常量字段值public static final java.lang.String MFV_INTERRUPT_ERROR
设置身份认证会话被中断时(如当前会话未结束就开启了新会话等),是否通
过IdentityListener.onError(SpeechError)
回调ErrorCode.ERROR_INTERRUPT
错误。
是否必须设置:否
默认值:false
值范围:{ null, true, false }
IdentityVerifier.setParameter(String, String)
,
常量字段值public static final java.lang.String PROT_TYPE
在使用业务时与服务端的网络交互协议。当默认的协议在网络环境不支持时,可以设置其他 支持的协议,以正常使用服务。
是否必须设置:否
默认值:"tcp"
值范围:{ null, "ssl", "tcp" }
IdentityVerifier.setParameter(String, String)
,
常量字段值public static final java.lang.String PLUS_LOCAL_TTS
public static final java.lang.String PLUS_LOCAL_ASR
public static final java.lang.String PLUS_LOCAL_IVW
public static final java.lang.String PLUS_LOCAL_ALL
public static final java.lang.String IST_SESSION_ID
在续传时需要指定
如需下次进行续传,请在当前会话 SpeechEvent.EVENT_SESSION_ID
获取,或在SpeechEvent.EVENT_SESSION_END
事件中,以第4个参数,通
过android.os.Bundle#getString
指定KEY值为本参数名获取。
若获取的值为空,表明本次会话已发生错,未生成会话ID。
转写功能暂未开放,相关参数设计预留
是否必须设置:否
默认值:null
值范围:有效的String
会话ID值
SpeechTranscripter.setParameter(java.lang.String, java.lang.String)
,
SpeechTranscripter.getParameter(java.lang.String)
,
SpeechTranscripter.startTranscripting(com.iflytek.cloud.TranscripterListener)
,
TranscripterListener.onEvent(int, int, int, Bundle)
,
常量字段值public static final java.lang.String IST_SYNC_ID
在续传时需要指定
如需下次进行续传,请在当前会话
SpeechEvent.EVENT_SESSION_END
事件中,以第4个参数,通过android.os.Bundle#getInt
指定KEY值为
本参数名获取值。
因为续传时必须指定为上次会话最新的值,所以务必在该事件中获取最新的值
转写功能暂未开放,相关参数设计预留
是否必须设置:否
默认值:null
值范围:有效的同步ID值
SpeechTranscripter.setParameter(java.lang.String, java.lang.String)
,
SpeechTranscripter.getParameter(java.lang.String)
,
SpeechTranscripter.startTranscripting(com.iflytek.cloud.TranscripterListener)
,
TranscripterListener.onEvent(int, int, int, Bundle)
,
SpeechEvent.EVENT_SESSION_END
,
常量字段值public static final java.lang.String IST_AUDIO_UPLOADED
在续传时需要指定
如需下次进行续传,请在当前会话
SpeechEvent.EVENT_SESSION_END
事件中,以第4个参数,通过android.os.Bundle#getInt
指定KEY值为
本参数名获取值。
因为续传时必须指定为上次会话最新的值,所以务必在该事件中获取最新的值
转写功能暂未开放,相关参数设计预留
是否必须设置:否
默认值:null
值范围:与上次会话事件中获取一致的值
SpeechTranscripter.setParameter(java.lang.String, java.lang.String)
,
SpeechTranscripter.getParameter(java.lang.String)
,
SpeechTranscripter.startTranscripting(com.iflytek.cloud.TranscripterListener)
,
TranscripterListener.onEvent(int, int, int, Bundle)
,
SpeechEvent.EVENT_SESSION_END
,
常量字段值public static final java.lang.String IST_AUDIO_PATH
在录音模式下,可指定文件保存的目录,或文件的绝对路径。
当文件或目录不存在时,SDK自动尝试创建,当创建失败时,回调
ErrorCode.ERROR_FILE_ACCESS
错误;
当创建成功时,可通过
TranscripterListener.onEvent(int, int, int, Bundle)
的
SpeechEvent.EVENT_IST_AUDIO_FILE
事件中获取值。
或在
SpeechEvent.EVENT_SESSION_END
事件中,以第4个参数,通过android.os.Bundle#getString
指定KEY值为
本参数名获取值。
在转写指定文件模式(AUDIO_SOURCE
值为-2时)下,当指定的文件不存在时,回调
ErrorCode.ERROR_FILE_ACCESS
错误;
转写功能暂未开放,相关参数设计预留
是否必须设置:否
默认值:null
值范围:有效的文件路径值
SpeechTranscripter.setParameter(java.lang.String, java.lang.String)
,
SpeechTranscripter.getParameter(java.lang.String)
,
SpeechTranscripter.startTranscripting(com.iflytek.cloud.TranscripterListener)
,
TranscripterListener.onEvent(int, int, int, Bundle)
,
SpeechEvent.EVENT_SESSION_END
,
SpeechEvent.EVENT_IST_AUDIO_FILE
,
常量字段值public static final java.lang.String IST_SESSION_TRY
指定当会话失败时,重试的次数。在转写音频源AUDIO_SOURCE
为负数时为全过程的重试次数,
当音频源AUDIO_SOURCE
为麦克风时,为停止录音后的重试次数。
默认值为1,如需指定为无限次,则设置值为-1。
转写功能暂未开放,相关参数设计预留
是否必须设置:否
默认值:1
值范围:[-1, +∞)
SpeechTranscripter.setParameter(java.lang.String, java.lang.String)
,
SpeechTranscripter.startTranscripting(com.iflytek.cloud.TranscripterListener)
,
AUDIO_SOURCE
,
常量字段值