IFlySpeechConstant Class Reference

Inherits from NSObject
Declared in IFlySpeechConstant.h

Overview

公共常量类
主要定义参数的key value值

+ APPID

语音应用ID
通过开发者网站申请

+ (NSString *)APPID

Return Value

语音应用IDkey

Declared In

IFlySpeechConstant.h

+ ACCENT

语言区域。

+ (NSString *)ACCENT

Return Value

语言区域key。

Declared In

IFlySpeechConstant.h

+ ACCENT_MANDARIN

语言区域。

+ (NSString *)ACCENT_MANDARIN

Return Value

普通话value。

Declared In

IFlySpeechConstant.h

+ ACCENT_HENANESE

语言区域。

+ (NSString *)ACCENT_HENANESE

Return Value

河南话value。

Declared In

IFlySpeechConstant.h

+ ACCENT_SICHUANESE

语言区域。

+ (NSString *)ACCENT_SICHUANESE

Return Value

四川话value。

Declared In

IFlySpeechConstant.h

+ ACCENT_CANTONESE

语言区域。

+ (NSString *)ACCENT_CANTONESE

Return Value

粤语value。

Declared In

IFlySpeechConstant.h

+ LANGUAGE

语言
支持:zh_cn,zh_tw,en_us

+ (NSString *)LANGUAGE

Return Value

语言key

Declared In

IFlySpeechConstant.h

+ LANGUAGE_CHINESE

语言

+ (NSString *)LANGUAGE_CHINESE

Return Value

中文value

Declared In

IFlySpeechConstant.h

+ LANGUAGE_CHINESE_TW

语言

+ (NSString *)LANGUAGE_CHINESE_TW

Return Value

中文台湾value

Declared In

IFlySpeechConstant.h

+ LANGUAGE_ENGLISH

语言

+ (NSString *)LANGUAGE_ENGLISH

Return Value

英文value

Declared In

IFlySpeechConstant.h

+ RESULT_TYPE

返回结果的数据格式,可设置为json,xml,plain,默认为json。

+ (NSString *)RESULT_TYPE

Return Value

返回结果的数据格式key

Declared In

IFlySpeechConstant.h

+ IFLY_DOMAIN

应用领域。

+ (NSString *)IFLY_DOMAIN

Return Value

应用领域key

Declared In

IFlySpeechConstant.h

+ DATA_TYPE

个性化数据上传类型

+ (NSString *)DATA_TYPE

Return Value

个性化数据上传类型key

Declared In

IFlySpeechConstant.h

+ SPEECH_TIMEOUT

语音输入超时时间
单位:ms,默认30000

+ (NSString *)SPEECH_TIMEOUT

Return Value

语音输入超时时间key

Declared In

IFlySpeechConstant.h

+ NET_TIMEOUT

网络连接超时时间
单位:ms,默认20000

+ (NSString *)NET_TIMEOUT

Return Value

网络连接超时时间key

Declared In

IFlySpeechConstant.h

+ SUBJECT

业务类型。

+ (NSString *)SUBJECT

Return Value

业务类型key。

Declared In

IFlySpeechConstant.h

+ PARAMS

扩展参数。

+ (NSString *)PARAMS

Return Value

扩展参数key。

Declared In

IFlySpeechConstant.h

+ PROT_TYPE

加密参数

+ (NSString *)PROT_TYPE

Return Value

加密参数key

Discussion

支持类型:ssl 加密 tcp 非加密 默认:tcp
建议对安全性要求较高时使用ssl。

Declared In

IFlySpeechConstant.h

+ SSL_CERT

ssl证书内容

+ (NSString *)SSL_CERT

Return Value

ssl证书内容key

Declared In

IFlySpeechConstant.h

+ POWER_CYCLE

录音音量返回时间间隔。

+ (NSString *)POWER_CYCLE

Return Value

间隔key。

Declared In

IFlySpeechConstant.h

+ SAMPLE_RATE

合成、识别、唤醒、评测、声纹等业务采样率。

+ (NSString *)SAMPLE_RATE

Return Value

合成及识别采样率key。

Declared In

IFlySpeechConstant.h

+ SAMPLE_RATE_8K

合成、识别、唤醒、声纹等业务采样率。

+ (NSString *)SAMPLE_RATE_8K

Return Value

合成及识别采样率8K Value。

Declared In

IFlySpeechConstant.h

+ SAMPLE_RATE_16K

合成、识别、唤醒、评测、声纹等业务采样率。

+ (NSString *)SAMPLE_RATE_16K

Return Value

合成及识别采样率16K Value。

Declared In

IFlySpeechConstant.h

+ ENGINE_TYPE

引擎类型。
可选:local,cloud,auto
默认:auto

+ (NSString *)ENGINE_TYPE

Return Value

引擎类型key。

Declared In

IFlySpeechConstant.h

+ TYPE_LOCAL

本地识别引擎。

+ (NSString *)TYPE_LOCAL

Return Value

本地识别引擎value。

Declared In

IFlySpeechConstant.h

+ TYPE_CLOUD

云端识别引擎。

+ (NSString *)TYPE_CLOUD

Return Value

云端识别引擎value。

Declared In

IFlySpeechConstant.h

+ TYPE_MIX

混合识别引擎。

+ (NSString *)TYPE_MIX

Return Value

混合识别引擎value。

Declared In

IFlySpeechConstant.h

+ TYPE_AUTO

引擎根据当前配置进行选择。

+ (NSString *)TYPE_AUTO

Return Value

引擎根据当前配置进行选择value。

Declared In

IFlySpeechConstant.h

+ TEXT_ENCODING

输入文本编码格式。

+ (NSString *)TEXT_ENCODING

Return Value

编码格式key。

Declared In

IFlySpeechConstant.h

+ RESULT_ENCODING

结果编码格式。

+ (NSString *)RESULT_ENCODING

Return Value

结果编码格式key。

Declared In

IFlySpeechConstant.h

+ PLAYER_INIT

是否初始化播放器
SDK内部播放器采用音频队列实现,有部分外部需求需要自定义音频队列,可以通过此开关控制
0:不初始化,非0或者参数为空:初始化,默认初始化

+ (NSString *)PLAYER_INIT

Return Value

是否初始化播放器参数key

Declared In

IFlySpeechConstant.h

+ PLAYER_DEACTIVE

是否播放器结束后发送deactive系统通知
SDK内部播放器结束后可通过此开关发送deactive系统通知,使其他被中断的音频应用解除中断
0:不发送,非0或者参数为空:发送,默认发送

+ (NSString *)PLAYER_DEACTIVE

Return Value

是否播放器结束后发送deactive系统通知参数key

Declared In

IFlySpeechConstant.h

+ RECORDER_INIT

是否初始化录音器
SDK内部录音器采用音频队列实现,有部分外部需求需要自定义音频队列,可以通过此开关控制
0:不初始化,非0或者参数为空:初始化,默认初始化

+ (NSString *)RECORDER_INIT

Return Value

是否初始化录音器参数key

Declared In

IFlySpeechConstant.h

+ RECORDER_DEACTIVE

是否录音器结束后发送deactive系统通知
SDK内部录音器结束后可通过此开关发送deactive系统通知,使其他被中断的音频应用解除中断
0:不发送,非0或者参数为空:发送,默认发送

+ (NSString *)RECORDER_DEACTIVE

Return Value

是否录音器结束后发送deactive系统通知参数key

Declared In

IFlySpeechConstant.h

+ SPEED

语速
范围 (0~100) 默认值:50

+ (NSString *)SPEED

Return Value

语速key

Declared In

IFlySpeechConstant.h

+ PITCH

音调
范围(0~100)默认值:50

+ (NSString *)PITCH

Return Value

音调key

Declared In

IFlySpeechConstant.h

+ TTS_AUDIO_PATH

合成录音保存路径

+ (NSString *)TTS_AUDIO_PATH

Return Value

合成录音保存路径key

Discussion

注意:只需要设置文件名则可,会自动拼接到[IFlySetting setLogFilePath]接口设置的目录后

Declared In

IFlySpeechConstant.h

+ VAD_ENABLE

启用VAD功能

+ (NSString *)VAD_ENABLE

Return Value

启用VAD功能key

Declared In

IFlySpeechConstant.h

+ VAD_BOS

VAD前端点超时
范围:0-10000(单位ms)

+ (NSString *)VAD_BOS

Return Value

VAD前端点超时key

Declared In

IFlySpeechConstant.h

+ VAD_EOS

VAD后端点超时。
可选范围:0-10000(单位ms)

+ (NSString *)VAD_EOS

Return Value

VAD后端点超时key

Declared In

IFlySpeechConstant.h

+ VOICE_NAME

发音人

+ (NSString *)VOICE_NAME

Return Value

发音人key

Discussion

云端支持如下发音人:
对于网络TTS的发音人角色,不同引擎类型支持的发音人不同,使用中请注意选择。

发音人 参数
小燕 xiaoyan
小宇 xiaoyu
凯瑟琳 catherine
亨利 henry
玛丽 vimary
小研 vixy
小琪 vixq
小峰 vixf
小梅 vixl
小莉 vixq
小蓉 vixr
小芸 vixyun
小坤 vixk
小强 vixqa
小莹 vixyin
小新 vixx
楠楠 vinn
老孙 vils

Declared In

IFlySpeechConstant.h

+ VOICE_ID

发音人ID key。

+ (NSString *)VOICE_ID

Return Value

发音人ID key

Declared In

IFlySpeechConstant.h

+ VOICE_LANG

发音人语种 key。

+ (NSString *)VOICE_LANG

Return Value

发音人ID key

Discussion

参数值:0:Auto 1:中文 2英文 ,默认 0.

Declared In

IFlySpeechConstant.h

+ VOLUME

音量
范围(0~100) 默认值:50

+ (NSString *)VOLUME

Return Value

音量key

Declared In

IFlySpeechConstant.h

+ TTS_BUFFER_TIME

合成音频播放缓冲时间
即缓冲多少秒音频后开始播放,如tts_buffer_time=1000;
默认缓冲1000ms毫秒后播放。

+ (NSString *)TTS_BUFFER_TIME

Return Value

合成音频播放缓冲时间缓冲时间key

Declared In

IFlySpeechConstant.h

+ TTS_DATA_NOTIFY

合成数据是否即时返回

+ (NSString *)TTS_DATA_NOTIFY

Return Value

合成数据即时返回key

Discussion

是否需要数据回调,为1时,当合成一段音频会通过onEvent回调返回,直接合成结束;
设置为1为即时返回;0为非即时返回;默认值为0;

Declared In

IFlySpeechConstant.h

+ NEXT_TEXT

预合成文本

+ (NSString *)NEXT_TEXT

Return Value

预合成文本参数key

Declared In

IFlySpeechConstant.h

+ MPPLAYINGINFOCENTER

是否需要打开MPPlayingInfocenter
是否需要初始化MPPlayerCenter的属性;0:需要初始化,1:不初始化

+ (NSString *)MPPLAYINGINFOCENTER

Return Value

是否需要打开MPPlayingInfocenter 参数key

Declared In

IFlySpeechConstant.h

+ AUDIO_SOURCE

录音源
录音时的录音方式,默认为麦克风,设置为1;
如果需要外部送入音频,设置为-1,通过WriteAudio接口送入音频。

+ (NSString *)AUDIO_SOURCE

Return Value

录音源key

Declared In

IFlySpeechConstant.h

+ ASR_AUDIO_PATH

识别录音保存路径

+ (NSString *)ASR_AUDIO_PATH

Return Value

识别录音保存路径key

Declared In

IFlySpeechConstant.h

+ ASR_SCH

设置是否开启语义

+ (NSString *)ASR_SCH

Return Value

设置是否开启语义key

Declared In

IFlySpeechConstant.h

+ ASR_PTT

设置是否有标点符号

+ (NSString *)ASR_PTT

Return Value

设置是否有标点符号key

Declared In

IFlySpeechConstant.h

+ ASR_PTT_HAVEDOT

ASR_PTT 参数值:设置带标点符号

+ (NSString *)ASR_PTT_HAVEDOT

Return Value

设置是有标点符号Value

Declared In

IFlySpeechConstant.h

+ ASR_PTT_NODOT

ASR_PTT 参数值:设置不带标点符号

+ (NSString *)ASR_PTT_NODOT

Return Value

设置是无标点符号Value

Declared In

IFlySpeechConstant.h

+ LOCAL_GRAMMAR

本地语法名称。
本地语法名称,对应云端的有CLOUD_GRAMMAR

+ (NSString *)LOCAL_GRAMMAR

Return Value

本地语法名称key。

Declared In

IFlySpeechConstant.h

+ CLOUD_GRAMMAR

云端语法ID。
云端编译语法返回的表示,早期版本使用GRAMMAR_ID,仍然兼容,但建议使用新的。

+ (NSString *)CLOUD_GRAMMAR

Return Value

云端语法ID key。

Declared In

IFlySpeechConstant.h

+ GRAMMAR_TYPE

语法类型

+ (NSString *)GRAMMAR_TYPE

Return Value

语法类型key

Declared In

IFlySpeechConstant.h

+ GRAMMAR_CONTENT

语法内容。

+ (NSString *)GRAMMAR_CONTENT

Return Value

语法内容key。

Declared In

IFlySpeechConstant.h

+ LEXICON_CONTENT

字典内容。

+ (NSString *)LEXICON_CONTENT

Return Value

字典内容key。

Declared In

IFlySpeechConstant.h

+ LEXICON_NAME

字典名字。

+ (NSString *)LEXICON_NAME

Return Value

字典名字key。

Declared In

IFlySpeechConstant.h

+ GRAMMAR_LIST

语法名称列表。

+ (NSString *)GRAMMAR_LIST

Return Value

语法名称列表key。

Declared In

IFlySpeechConstant.h

+ NLP_VERSION

开放语义协议版本号。
如需使用请在http://osp.voicecloud.cn/上进行业务配置

+ (NSString *)NLP_VERSION

Return Value

开放语义协议版本号key。

Declared In

IFlySpeechConstant.h

+ IVW_THRESHOLD

唤醒门限值。

+ (NSString *)IVW_THRESHOLD

Return Value

唤醒门限值key。

Declared In

IFlySpeechConstant.h

+ IVW_SST

唤醒服务类型。

+ (NSString *)IVW_SST

Return Value

唤醒服务类型key。

Declared In

IFlySpeechConstant.h

+ IVW_ONESHOT

唤醒+识别。

+ (NSString *)IVW_ONESHOT

Return Value

唤醒+识别key。

Declared In

IFlySpeechConstant.h

+ KEEP_ALIVE

唤醒工作方式
1:表示唤醒成功后继续录音,0:表示唤醒成功后停止录音。

+ (NSString *)KEEP_ALIVE

Return Value

唤醒工作方式key

Declared In

IFlySpeechConstant.h

+ IVW_AUDIO_PATH

唤醒录音保存路径

+ (NSString *)IVW_AUDIO_PATH

Return Value

唤醒录音保存路径key

Declared In

IFlySpeechConstant.h

+ ISE_CATEGORY

评测类型
可选值:read_syllable(英文评测不支持):单字;read_word:词语;read_sentence:句子;read_chapter(待开放):篇章。

+ (NSString *)ISE_CATEGORY

Return Value

评测类型 key

Declared In

IFlySpeechConstant.h

+ ISE_RESULT_LEVEL

评测结果等级
可选值:complete:完整 ;plain:简单

+ (NSString *)ISE_RESULT_LEVEL

Return Value

评测结果等级 key

Declared In

IFlySpeechConstant.h

+ ISE_RESULT_TYPE

评测结果格式
可选值:xml;plain

+ (NSString *)ISE_RESULT_TYPE

Return Value

评测结果格式 key

Declared In

IFlySpeechConstant.h

+ ISE_AUDIO_PATH

评测录音保存路径

+ (NSString *)ISE_AUDIO_PATH

Return Value

评测录音保存路径key

Declared In

IFlySpeechConstant.h

+ ISE_AUTO_TRACKING

朗读跟踪,只对句子和篇章有效
可选值:enable:开启;disable:关闭。

+ (NSString *)ISE_AUTO_TRACKING

Return Value

朗读跟踪 key

Declared In

IFlySpeechConstant.h

+ ISE_TRACK_TYPE

跟踪模式
可选值:easy:简单;hard:复杂。

+ (NSString *)ISE_TRACK_TYPE

Return Value

跟踪模式 key

Declared In

IFlySpeechConstant.h

+ PLUS_LOCAL_ALL

本地所有资源

+ (NSString *)PLUS_LOCAL_ALL

Return Value

本地所有资源key

Declared In

IFlySpeechConstant.h

+ PLUS_LOCAL_TTS

本地合成资源

+ (NSString *)PLUS_LOCAL_TTS

Return Value

本地合成资源key

Declared In

IFlySpeechConstant.h

+ PLUS_LOCAL_ASR

本地识别资源

+ (NSString *)PLUS_LOCAL_ASR

Return Value

本地识别资源key

Declared In

IFlySpeechConstant.h

+ PLUS_LOCAL_IVW

本地唤醒资源

+ (NSString *)PLUS_LOCAL_IVW

Return Value

本地唤醒资源key

Declared In

IFlySpeechConstant.h

+ MFV_AUTH_ID

auth_id
用于用户注册和登录、查询、删除等业务时标识用户身份

+ (NSString *)MFV_AUTH_ID

Return Value

用户标识

Declared In

IFlySpeechConstant.h

+ MFV_SUB

请求业务类型,可选值:mfv(默认,融合验证),ivp(声纹),ifr(人脸)

+ (NSString *)MFV_SUB

Return Value

请求业务类型key

Declared In

IFlySpeechConstant.h

+ MFV_SST

会话类型,不同sub有不同的sst取值。
ifr:enroll,verify,identify,reenroll,query,delete
ivp:enroll(train),verify,reenroll,query,delete,download

+ (NSString *)MFV_SST

Return Value

会话类型key

Declared In

IFlySpeechConstant.h

+ MFV_VCM

融合验证模式,仅在融合验证场景下使用。可选值:sin(单一生物特征数据验证),mix(混合生物特征数据验证),agi(灵活生物特征数据验证)

+ (NSString *)MFV_VCM

Return Value

融合验证模式key

Declared In

IFlySpeechConstant.h

+ MFV_SCENES

特征场景,用来说明本次验证将涉及的业务。可选值:ivp,ifr,ivp|ifr

+ (NSString *)MFV_SCENES

Return Value

特征场景 key

Declared In

IFlySpeechConstant.h

+ MFV_AFC

确认周期(affirmance cycle,单位:s),用户设置的确认超时时间(生命周期),仅在灵活融合验证场景下使用

+ (NSString *)MFV_AFC

Return Value

确认周期key

Declared In

IFlySpeechConstant.h

+ MFV_DATA_PATH

数据保存路径

+ (NSString *)MFV_DATA_PATH

Return Value

数据保存路径key

Declared In

IFlySpeechConstant.h

+ MFV_RGN

训练次数:取值2~9.无默认值,必须明确指定。

+ (NSString *)MFV_RGN

Return Value

训练次数key

Declared In

IFlySpeechConstant.h

+ MFV_TSD

声纹确认门限值,验证得分>=tsd验证通过,否则验证失败(该参数目前不支持,作为保留参数。)却只范围:0~100.

+ (NSString *)MFV_TSD

Return Value

声纹确认门限值key

Declared In

IFlySpeechConstant.h

+ MFV_PTXT

密码文本。从服务端下载,比如数字密码所需要的数字串。

+ (NSString *)MFV_PTXT

Return Value

密码文本key

Declared In

IFlySpeechConstant.h

+ MFV_PWDT

密码类型。取值:1(文本密码),2(自由说),3(数字密码).

+ (NSString *)MFV_PWDT

Return Value

密码类型key

Declared In

IFlySpeechConstant.h

+ MFV_FIN

取消注册。取值:0(不取消,即不生效),1(取消本次注册).

+ (NSString *)MFV_FIN

Return Value

取消注册key

Declared In

IFlySpeechConstant.h

+ MFV_WTT

等待超时时间:描述客户端等待结果的超时时间

+ (NSString *)MFV_WTT

Return Value

等待超时时间:key

Declared In

IFlySpeechConstant.h

+ MFV_DATA_FORMAT

数据格式
声纹为音频采样率支持:16000和8000;人脸为图片格式,支持jpg和gif

+ (NSString *)MFV_DATA_FORMAT

Return Value

数据格式key

Declared In

IFlySpeechConstant.h

+ MFV_DATA_ENCODING

数据压缩编码
声纹为;人脸支持raw,不对图片压缩

+ (NSString *)MFV_DATA_ENCODING

Return Value

数据压缩编码key

Declared In

IFlySpeechConstant.h

+ FACE_SUB

sub 默认值:wfr
用于区分业务类型,web访问方式中,nginx配置不用使用,但是在结构化日志和染色日志记录中使用。

+ (NSString *)FACE_SUB

Declared In

IFlySpeechConstant.h

+ FACE_WFR

WFR
sub参数的默认值

+ (NSString *)FACE_WFR

Declared In

IFlySpeechConstant.h

+ FACE_SST

sst
指定本路会话是属于何种性质

+ (NSString *)FACE_SST

Declared In

IFlySpeechConstant.h

+ FACE_REG

REG
人脸图像注册(reg):上传图像,验证图像的有效性,然后存储起来,作为数据源。

+ (NSString *)FACE_REG

Declared In

IFlySpeechConstant.h

+ FACE_VERIFY

VERIFY
人脸图像验证(verify):通过与指定源图像比较,验证人脸相似性。

+ (NSString *)FACE_VERIFY

Declared In

IFlySpeechConstant.h

+ FACE_DETECT

DETECT
人脸图像检测(detect):能够检测出不同姿态方位的人脸在图中的位置。

+ (NSString *)FACE_DETECT

Declared In

IFlySpeechConstant.h

+ FACE_ALIGN

ALIGN
人脸图像聚焦(align):在给定人脸框下自动标定出两眼、鼻尖、嘴角的坐标。

+ (NSString *)FACE_ALIGN

Declared In

IFlySpeechConstant.h

+ FACE_ATTR

ATTR
面部属性识别(attr):对面部属性进行识别:例如秃顶、刘海、大嘴、模糊、眼镜等。

+ (NSString *)FACE_ATTR

Declared In

IFlySpeechConstant.h

+ FACE_AUE

AUE
图像压缩格式,现在引擎不支持图像压缩,aue只能取值raw

+ (NSString *)FACE_AUE

Declared In

IFlySpeechConstant.h

+ FACE_RAW

RAW
AUE参数的值

+ (NSString *)FACE_RAW

Declared In

IFlySpeechConstant.h

+ FACE_PSET

PSET
人脸识别验证阈值,取值可以是负数也可以是整数。

+ (NSString *)FACE_PSET

Declared In

IFlySpeechConstant.h

+ FACE_SKIP

SKIP
后台图片处理是否进行过滤。true表示不过滤,false表示过滤,传入字符串@“true”或@“false”

+ (NSString *)FACE_SKIP

Declared In

IFlySpeechConstant.h

+ FACE_GID

GID
图像模型id,如:4a6c124ed6b78436ee5aac4563f13eb5

+ (NSString *)FACE_GID

Declared In

IFlySpeechConstant.h

+ FACE_AUTH_ID

auth_id
用于用户注册和登录、查询、删除等业务时标识用户身份

+ (NSString *)FACE_AUTH_ID

Return Value

用户标识

Declared In

IFlySpeechConstant.h

+ FACE_DVC

DVC
用户设备编号,用于验证用户

+ (NSString *)FACE_DVC

Declared In

IFlySpeechConstant.h