这里介绍的是iOS API关于基础类的相关说明,点击右侧目录可快速找到相应文件。
Inherits from | NSObject |
---|---|
Declared in | IFlyAudioSession.h |
音频环境初始化,设置AVAudioSession的Category属性。
初始化播音环境,主要用于合成播放器。
(void)initPlayingAudioSession:(BOOL)*isMPCenter
Parameters
isMPCenter | 是否初始化MPPlayerCenter:0不初始化,1初始化。此参数只在AVAudioSession的Category属性值不为AVAudioSessionCategoryPlayAndRecord时设置有效。 |
---|
Discussion
此接口主要根据原来的音频环境,重新优化设置AVAudioSession的Category属性值。
若原来的Category属性值为AVAudioSessionCategoryPlayAndRecord,则添加AVAudioSessionCategoryOptionDefaultToSpeaker|AVAudioSessionCategoryOptionAllowBluetooth选项;若为其他Category属性值且isMPCenter为NO,则设置Category属性值为AVAudioSessionCategoryPlayback,选项为AVAudioSessionCategoryOptionMixWithOthers;若为其他Category属性值且isMPCenter为YES,则保持原来的设置,不做任何更改。
Declared In
IFlyAudioSession.h
初始化录音环境,主要用于识别录音器。
(BOOL)initRecordingAudioSession
Return Value
成功返回YES,失败返回NO
Discussion
设置AVAudioSession的Category属性值为AVAudioSessionCategoryPlayAndRecord,选项为AVAudioSessionCategoryOptionDefaultToSpeaker|AVAudioSessionCategoryOptionAllowBluetooth。
Declared In
IFlyAudioSession.h
Inherits from | NSObject |
---|---|
Declared in | IFlyDebugLog.h |
调试信息
打印调试信息
(void)showLog:(NSString *)*format*, *...*
Parameters
format | -[in] 要打印的内容格式 |
---|---|
... | -[in] 要打印的内容 |
Declared In
IFlyDebugLog.h
将log写入文件中
(void)writeLog
Declared In
IFlyDebugLog.h
设置是否显示log
(void)setShowLog:(BOOL)*showLog*
Parameters
showLog | YES:显示;NO:不显示 |
---|
Declared In
IFlyDebugLog.h
Inherits from | NSObject |
---|---|
Conforms to | AVAudioSessionDelegate |
Declared in | IFlyPcmRecorder.h |
录音器控件
录音委托对象
@property (nonatomic, assign) id<IFlyPcmRecorderDelegate> delegate
Declared In
IFlyPcmRecorder.h
用于设置是否在录音结束后发送Deactive通知,默认是YES:发送
`@property (nonatomic, assign) BOOL isNeedDeActive
Declared In
IFlyPcmRecorder.h
单例模式
(instancetype)sharedInstance
Return Value
返回录音对象单例
Declared In
IFlyPcmRecorder.h
开始录音
- (BOOL)start
Return Value
开启录音成功返回YES,否则返回NO
Declared In
IFlyPcmRecorder.h
停止录音
- (void)stop
Declared In
IFlyPcmRecorder.h
设置音频采样率
- (void)setSample:(NSString *)*rate*
Parameters
rate | -[in] 采样率,8k/16k |
---|
设置录音音量回调时间间隔参数
- (void)setPowerCycle:(float)*cycle*
Declared In
IFlyPcmRecorder.h
保存录音
- (void)setSaveAudioPath:(NSString *)*savePath*
Parameters
savePath | 音频保存路径 |
---|
Declared In
IFlyPcmRecorder.h
录音器是否完成
- (BOOL)isCompleted
Return Value
录音器完全结束返回YES,否则返回NO
Declared In
IFlyPcmRecorder.h
Inherits from | NSObject |
---|---|
Declared in | IFlyResourceUtil.h |
资源工具类
获取通过MSPSetParam,启动引擎的标识
(NSString *)ENGINE_START
Return Value
通过MSPSetParam,启动引擎的标识
Declared In
IFlyResourceUtil.h
获取通过MSPSetParam,销毁引擎的标识
(NSString *)ENGINE_DESTROY
Return Value
通过MSPSetParam,销毁引擎的标识
Declared In
IFlyResourceUtil.h
获取识别引擎的资源目录标识
(NSString *)ASR_RES_PATH
Return Value
识别引擎的资源目录标识
Declared In
IFlyResourceUtil.h
得到语法构建目录
(NSString *)GRM_BUILD_PATH
Return Value
语法构建目录
Declared In
IFlyResourceUtil.h
获取合成引擎的资源目录标识,同时需要先传入voice_name方可生效
(NSString *)TTS_RES_PATH
Return Value
合成引擎的资源目录标识,同时需要先传入voice_name方可生效
Declared In
IFlyResourceUtil.h
获取唤醒资源的资源目录标识
(NSString *)IVW_RES_PATH
Return Value
唤醒资源的资源目录标识
Declared In
IFlyResourceUtil.h
语法类型
(NSString *)GRAMMARTYPE`
Return Value
语法类型
Declared In
IFlyResourceUtil.h
语记SDK专用参数,用于设置本地默认资源路径
(NSString *)PLUS_LOCAL_DEFAULT_RES_PATH
Return Value
本地默认资源路径key字符串
资源存放路径
(NSString *)generateResourcePath:(NSString *)*path*
Parameters
path | 设置的路径 |
---|
Return Value
资源目录
Declared In
IFlyResourceUtil.h
获得离线发音人对应的id
(NSString *)identifierForVoiceName:(NSString *)*voiceName
Parameters
voiceName | 发音人名称 |
---|
Return Value
有,发音人对应的id;无,返回nil
Declared In
IFlyResourceUtil.h
Inherits from | NSObject |
---|---|
Declared in | IFlySetting.h |
此接口为iflyMSC sdk 配置接口。 可以获取版本号,设置日志打印等级等
获取版本号
(NSString *)getVersion`
Return Value
版本号
Declared In
IFlySetting.h
获取日志等级
(LOG_LEVEL)logLvl
Return Value
返回日志等级
Declared In
IFlySetting.h
是否打印控制台log
在软件发布时,建议关闭此log。
(void)showLogcat:(BOOL)*showLog
Parameters
showLog | -[in] YES,打印log;NO,不打印 |
---|
Declared In
IFlySetting.h
设置日志msc.log生成路径以及日志等级
(void)setLogFile:(LOG_LEVEL)*level
Parameters
level | -[in] 日志打印等级 |
---|
Discussion
日志打印等级 | 描述 |
---|---|
LVL_ALL | 全部打印 |
LVL_DETAIL | 高,异常分析需要的级别 |
LVL_NORMAL | 中,打印基本日志信息 |
LVL_LOW | 低,只打印主要日志信息 |
LVL_NONE | 不打印 |
Declared In
IFlySetting.h
设置日志文件的路径
日志文件默认存放在Documents目录。
(void)setLogFilePath:(NSString *)*path*
Parameters
path | -[in] 日志文件的全路径 |
---|
Declared In
IFlySetting.h
Inherits from | NSObject |
---|---|
Declared in | IFlySpeechConstant.h |
公共常量类 主要定义参数的key value值
语音应用ID
通过开发者网站申请
(NSString *)APPID
Return Value
语音应用IDkey
Declared In
IFlySpeechConstant.h
语言区域。
(NSString *)ACCENT
Return Value
语言区域key。
Declared In
IFlySpeechConstant.h
语言区域。
(NSString *)ACCENT_MANDARIN
Return Value
普通话value。
Declared In
IFlySpeechConstant.h
语言区域。
(NSString *)ACCENT_HENANESE
Return Value
河南话value。
Declared In
IFlySpeechConstant.h
语言区域。
(NSString *)ACCENT_SICHUANESE
Return Value
四川话value。
Declared In
IFlySpeechConstant.h
语言区域。
(NSString *)ACCENT_CANTONESE
Return Value
粤语value。
Declared In
IFlySpeechConstant.h
语言
支持:zh_cn,zh_tw,en_us
(NSString *)LANGUAGE
Return Value
语言key
语言
(NSString *)LANGUAGE_CHINESE
Return Value
中文value
Declared In
IFlySpeechConstant.h
语言
(NSString *)LANGUAGE_CHINESE_TW
Return Value
中文台湾value
Declared In
IFlySpeechConstant.h
语言
(NSString *)LANGUAGE_ENGLISH
Return Value
英文value
Declared In
IFlySpeechConstant.h
返回结果的数据格式,可设置为json,xml,plain,默认为json。
(NSString *)RESULT_TYPE
Return Value
返回结果的数据格式key
Declared In
IFlySpeechConstant.h
应用领域。
(NSString *)IFLY_DOMAIN
Return Value
应用领域key
Declared In
IFlySpeechConstant.h
个性化数据上传类型
(NSString *)DATA_TYPE
Return Value
个性化数据上传类型key
Declared In
IFlySpeechConstant.h
设置录取音频最长时间。在听写、识别和声纹等需要录入音频的业务下。当录音超过这个时间,SDK会自动结束录音。
(NSString *)SPEECH_TIMEOUT
Return Value
语音输入超时时间key
Discussion
是否必须设置:否
单位:ms,默认30000
值范围:[0,60000]
Declared In
IFlySpeechConstant.h
网络连接超时时间
单位:ms,默认20000
(NSString *)NET_TIMEOUT
Return Value
网络连接超时时间key
Declared In
IFlySpeechConstant.h
业务类型。
(NSString *)SUBJECT
Return Value
业务类型key。
Declared In
IFlySpeechConstant.h
扩展参数。
(NSString *)PARAMS
Return Value
扩展参数key。
Declared In
IFlySpeechConstant.h
加密参数
(NSString *)PROT_TYPE
Return Value
加密参数key
Discussion
支持类型:ssl 加密 tcp 非加密 默认:tcp
建议对安全性要求较高时使用ssl。
Declared In
IFlySpeechConstant.h
ssl证书内容
(NSString *)SSL_CERT
Return Value
ssl证书内容key
Declared In
IFlySpeechConstant.h
录音音量返回时间间隔。
(NSString *)POWER_CYCLE
Return Value
间隔key。
Declared In
IFlySpeechConstant.h
合成、识别、唤醒、评测、声纹等业务采样率。
(NSString *)SAMPLE_RATE
Return Value
合成及识别采样率key。
合成、识别、声纹等业务采样率。
(NSString *)SAMPLE_RATE_8K
Return Value
合成及识别采样率8K Value。
Declared In
IFlySpeechConstant.h
合成、识别、唤醒、评测、声纹等业务采样率。
(NSString *)SAMPLE_RATE_16K
Return Value
合成及识别采样率16K Value。
Declared In
IFlySpeechConstant.h
引擎类型。
可选:local,cloud,auto
默认:auto
(NSString *)ENGINE_TYPE
Return Value
引擎类型key。
Declared In
IFlySpeechConstant.h
本地识别引擎。
(NSString *)TYPE_LOCAL
Return Value
本地识别引擎value。
Declared In
IFlySpeechConstant.h
云端识别引擎。
(NSString *)TYPE_CLOUD
Return Value
云端识别引擎value。
Declared In
IFlySpeechConstant.h
混合识别引擎。
(NSString *)TYPE_MIX
Return Value
混合识别引擎value。
Declared In
IFlySpeechConstant.h
引擎根据当前配置进行选择。
(NSString *)TYPE_AUTO
Return Value
引擎根据当前配置进行选择value。
Declared In
IFlySpeechConstant.h
输入文本编码格式。
(NSString *)TEXT_ENCODING
Return Value
编码格式key。
Declared In
IFlySpeechConstant.h
结果编码格式。
(NSString *)RESULT_ENCODING
Return Value
结果编码格式key。
Declared In
IFlySpeechConstant.h
是否初始化播放器
SDK内部播放器采用音频队列实现,有部分外部需求需要自定义音频队列,可以通过此开关控制
0:不初始化,非0或者参数为空:初始化,默认初始化
(NSString *)PLAYER_INIT
Return Value
是否初始化播放器参数key
是否播放器结束后发送deactive系统通知
SDK内部播放器结束后可通过此开关发送deactive系统通知,使其他被中断的音频应用解除中断
0:不发送,非0或者参数为空:发送,默认发送
(NSString *)PLAYER_DEACTIVE
Return Value
是否播放器结束后发送deactive系统通知参数key
Declared In
IFlySpeechConstant.h
是否初始化录音器
SDK内部录音器采用音频队列实现,有部分外部需求需要自定义音频队列,可以通过此开关控制
0:不初始化,非0或者参数为空:初始化,默认初始化
(NSString *)RECORDER_INIT
Return Value
是否初始化录音器参数key
Declared In
IFlySpeechConstant.h
是否录音器结束后发送deactive系统通知
SDK内部录音器结束后可通过此开关发送deactive系统通知,使其他被中断的音频应用解除中断
0:不发送,非0或者参数为空:发送,默认发送
(NSString *)RECORDER_DEACTIVE
Return Value
是否录音器结束后发送deactive系统通知参数key
Declared In
IFlySpeechConstant.h
语速
范围 (0~100) 默认值:50
(NSString *)SPEED
Return Value
语速key
音调
范围(0~100)默认值:50
(NSString *)PITCH
Return Value
音调key
Declared In
IFlySpeechConstant.h
合成录音保存路径
(NSString *)TTS_AUDIO_PATH
Return Value
合成录音保存路径key
Discussion
注意:只需要设置文件名则可,会自动拼接到[IFlySetting setLogFilePath]接口设置的目录后
Declared In
IFlySpeechConstant.h
启用VAD功能
(NSString *)VAD_ENABLE
Return Value
启用VAD功能key
Declared In
IFlySpeechConstant.h
VAD前端点超时
范围:0-10000(单位ms)
(NSString *)VAD_BOS
Return Value
VAD前端点超时key
Declared In
IFlySpeechConstant.h
VAD后端点超时。
可选范围:0-10000(单位ms)
(NSString *)VAD_EOS
Return Value
VAD后端点超时key
Declared In
IFlySpeechConstant.h
发音人
(NSString *)VOICE_NAME
Return Value
发音人key
Discussion
云端支持发音人请直接在控制台的在线语音合成(流式)查看
Declared In
IFlySpeechConstant.h
发音人ID key。
(NSString *)VOICE_ID
Return Value
发音人ID key
Declared In
IFlySpeechConstant.h
发音人语种 key。
(NSString *)VOICE_LANG
Return Value
发音人ID key
Discussion
参数值:0:Auto 1:中文 2英文 ,默认 0.
Declared In
IFlySpeechConstant.h
音量
范围(0~100) 默认值:50
(NSString *)VOLUME
Return Value
音量key
合成音频播放缓冲时间
即缓冲多少秒音频后开始播放,如tts_buffer_time=1000;
默认缓冲1000ms毫秒后播放。
(NSString *)TTS_BUFFER_TIME
Return Value
合成音频播放缓冲时间缓冲时间key
Declared In
IFlySpeechConstant.h
合成数据是否即时返回
(NSString *)TTS_DATA_NOTIFY
Return Value
合成数据即时返回key
Discussion
是否需要数据回调,为1时,当合成一段音频会通过onEvent回调返回,直接合成结束;
设置为1为即时返回;0为非即时返回;默认值为0;
Declared In
IFlySpeechConstant.h
预合成文本
(NSString *)NEXT_TEXT
Return Value
预合成文本参数key
Declared In
IFlySpeechConstant.h
是否需要打开MPPlayingInfocenter
是否需要初始化MPPlayerCenter的属性;0:需要初始化,1:不初始化
(NSString *)MPPLAYINGINFOCENTER
Return Value
是否需要打开MPPlayingInfocenter 参数key
Declared In
IFlySpeechConstant.h
录音源
录音时的录音方式,默认为麦克风,设置为1;
如果需要外部送入音频,设置为-1,通过WriteAudio接口送入音频。
(NSString *)AUDIO_SOURCE
Return Value
录音源key
Declared In
IFlySpeechConstant.h
识别录音保存路径
(NSString *)ASR_AUDIO_PATH
Return Value
识别录音保存路径key
Declared In
IFlySpeechConstant.h
设置是否开启语义
(NSString *)ASR_SCH
Return Value
设置是否开启语义key
Declared In
IFlySpeechConstant.h
设置是否有标点符号
(NSString *)ASR_PTT
Return Value
设置是否有标点符号key
Declared In
IFlySpeechConstant.h
ASR_PTT 参数值:设置带标点符号
(NSString *)ASR_PTT_HAVEDOT
Return Value
设置是有标点符号Value
ASR_PTT 参数值:设置不带标点符号
(NSString *)ASR_PTT_NODOT
Return Value
设置是无标点符号Value
Declared In
IFlySpeechConstant.h
本地语法名称。
本地语法名称,对应云端的有CLOUD_GRAMMAR
(NSString *)LOCAL_GRAMMAR
Return Value
本地语法名称key。
Declared In
IFlySpeechConstant.h
云端语法ID。
云端编译语法返回的表示,早期版本使用GRAMMAR_ID,仍然兼容,但建议使用新的。
(NSString *)CLOUD_GRAMMAR
Return Value
云端语法ID key。
Declared In
IFlySpeechConstant.h
语法类型
(NSString *)GRAMMAR_TYPE
Return Value
语法类型key
Declared In
IFlySpeechConstant.h
语法内容。
(NSString *)GRAMMAR_CONTENT
Return Value
语法内容key。
Declared In
IFlySpeechConstant.h
字典内容。
(NSString *)LEXICON_CONTENT
Return Value
字典内容key。
字典名字。
(NSString *)LEXICON_NAME
Return Value
字典名字key。
Declared In
IFlySpeechConstant.h
语法名称列表。
(NSString *)GRAMMAR_LIST
Return Value
语法名称列表key。
Declared In
IFlySpeechConstant.h
唤醒门限值。
(NSString *)IVW_THRESHOLD
Return Value
唤醒门限值key。
Declared In
IFlySpeechConstant.h
唤醒服务类型。
(NSString *)IVW_SST
Return Value
唤醒服务类型key。
Declared In
IFlySpeechConstant.h
唤醒+识别。
(NSString *)IVW_ONESHOT
Return Value
唤醒+识别key。
Declared In
IFlySpeechConstant.h
唤醒工作方式
1:表示唤醒成功后继续录音,0:表示唤醒成功后停止录音。
(NSString *)KEEP_ALIVE
Return Value
唤醒工作方式key
Declared In
IFlySpeechConstant.h
唤醒录音保存路径
(NSString *)IVW_AUDIO_PATH
Return Value
唤醒录音保存路径key
Declared In
IFlySpeechConstant.h
评测类型
可选值:read_syllable(英文评测不支持):单字;read_word:词语;read_sentence:句子;read_chapter(待开放):篇章。
(NSString *)ISE_CATEGORY
Return Value
评测类型 key
Declared In
IFlySpeechConstant.h
评测结果等级
可选值:complete:完整 ;plain:简单
(NSString *)ISE_RESULT_LEVEL
Return Value
评测结果等级 key
Declared In
IFlySpeechConstant.h
评测结果格式
可选值:xml;plain
(NSString *)ISE_RESULT_TYPE
Return Value
评测结果格式 key
Declared In
IFlySpeechConstant.h
评测录音保存路径
(NSString *)ISE_AUDIO_PATH
Return Value
评测录音保存路径key
Declared In
IFlySpeechConstant.h
本地所有资源
(NSString *)PLUS_LOCAL_ALL
Return Value
本地所有资源key
Declared In
IFlySpeechConstant.h
本地合成资源
(NSString *)PLUS_LOCAL_TTS
Return Value
本地合成资源key
Declared In
IFlySpeechConstant.h
本地识别资源
(NSString *)PLUS_LOCAL_ASR
Return Value
本地识别资源key
Declared In
IFlySpeechConstant.h
本地唤醒资源
(NSString *)PLUS_LOCAL_IVW
Return Value
本地唤醒资源key
auth_id
用于用户注册和登录、查询、删除等业务时标识用户身份
(NSString *)MFV_AUTH_ID
Return Value
用户标识
Declared In
IFlySpeechConstant.h
请求业务类型,可选值:mfv(默认,融合验证),ivp(声纹),ifr(人脸)
(NSString *)MFV_SUB
Return Value
请求业务类型key
Declared In
IFlySpeechConstant.h
会话类型,不同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
融合验证模式,仅在融合验证场景下使用。可选值:sin(单一生物特征数据验证),mix(混合生物特征数据验证),agi(灵活生物特征数据验证)
(NSString *)MFV_VCM
Return Value
融合验证模式key
特征场景,用来说明本次验证将涉及的业务。可选值:ivp,ifr,ivp|ifr
(NSString *)MFV_SCENES
Return Value
特征场景 key
确认周期(affirmance cycle,单位:s),用户设置的确认超时时间(生命周期),仅在灵活融合验证场景下使用
(NSString *)MFV_AFC
Return Value
确认周期key
Declared In
IFlySpeechConstant.h
数据保存路径
(NSString *)MFV_DATA_PATH
Return Value
数据保存路径key
训练次数:取值2~9.无默认值,必须明确指定。
(NSString *)MFV_RGN
Return Value
训练次数key
Declared In
IFlySpeechConstant.h
声纹确认门限值,验证得分>=tsd验证通过,否则验证失败(该参数目前不支持,作为保留参数。)却只范围:0~100.
(NSString *)MFV_TSD
Return Value
声纹确认门限值key
密码文本。从服务端下载,比如数字密码所需要的数字串。
(NSString *)MFV_PTXT
Return Value
密码文本key
Declared In
IFlySpeechConstant.h
密码类型。取值:1(文本密码),2(自由说),3(数字密码).
(NSString *)MFV_PWDT
Return Value
密码类型key
Declared In
IFlySpeechConstant.h
取消注册。取值:0(不取消,即不生效),1(取消本次注册).
(NSString *)MFV_FIN
Return Value
取消注册key
Declared In
IFlySpeechConstant.h
等待超时时间:描述客户端等待结果的超时时间
(NSString *)MFV_WTT
Return Value
等待超时时间:key
Declared In
IFlySpeechConstant.h
数据格式
声纹为音频采样率支持:16000和8000;人脸为图片格式,支持jpg和gif
(NSString *)MFV_DATA_FORMAT
Return Value
数据格式key
Declared In
IFlySpeechConstant.h
数据压缩编码
声纹为;人脸支持raw,不对图片压缩
(NSString *)MFV_DATA_ENCODING
Return Value
数据压缩编码key
sub 默认值:wfr
用于区分业务类型,web访问方式中,nginx配置不用使用,但是在结构化日志和染色日志记录中使用。
(NSString *)FACE_SUB
WFR
sub参数的默认值
(NSString *)FACE_WFR
Declared In
IFlySpeechConstant.h
sst
指定本路会话是属于何种性质
(NSString *)FACE_SST
Declared In
IFlySpeechConstant.h
REG
人脸图像注册(reg):上传图像,验证图像的有效性,然后存储起来,作为数据源。
(NSString *)FACE_REG
VERIFY
人脸图像验证(verify):通过与指定源图像比较,验证人脸相似性。
(NSString *)FACE_VERIFY
Declared In
IFlySpeechConstant.h
DETECT
人脸图像检测(detect):能够检测出不同姿态方位的人脸在图中的位置。
(NSString *)FACE_DETECT
Declared In
IFlySpeechConstant.h
ALIGN
人脸图像聚焦(align):在给定人脸框下自动标定出两眼、鼻尖、嘴角的坐标。
(NSString *)FACE_ALIGN
Declared In
IFlySpeechConstant.h
ATTR
面部属性识别(attr):对面部属性进行识别:例如秃顶、刘海、大嘴、模糊、眼镜等。
(NSString *)FACE_ATTR
AUE
图像压缩格式,现在引擎不支持图像压缩,aue只能取值raw
(NSString *)FACE_AUE
Declared In
IFlySpeechConstant.h
RAW
AUE参数的值
(NSString *)FACE_RAW
Declared In
IFlySpeechConstant.h
PSET
人脸识别验证阈值,取值可以是负数也可以是整数。
(NSString *)FACE_PSET
Declared In
IFlySpeechConstant.h
SKIP
后台图片处理是否进行过滤。true表示不过滤,false表示过滤,传入字符串@“true”或@“false”
(NSString *)FACE_SKIP
Declared In
IFlySpeechConstant.h
GID
图像模型id,如:4a6c124ed6b78436ee5aac4563f13eb5
(NSString *)FACE_GID
Declared In
IFlySpeechConstant.h
auth_id
用于用户注册和登录、查询、删除等业务时标识用户身份
(NSString *)FACE_AUTH_ID
Return Value
用户标识
Declared In
IFlySpeechConstant.h
DVC
用户设备编号,用于验证用户
(NSString *)FACE_DVC
Declared In
IFlySpeechConstant.h
FlySpeechError Class Reference
Inherits from | NSObject |
---|---|
Declared in | IFlySpeechError.h |
错误码
@property (nonatomic, assign) int errorCode
Declared In
IFlySpeechError.h
错误码类型
@property (nonatomic, assign) int errorType
Declared In
IFlySpeechError.h
错误描述
@property (nonatomic, retain) NSString *errorDesc
Declared In
IFlySpeechError.h
初始化
+ (instancetype)initWithError:(int)errorCode
Parameters
errorCode | -[in] 错误码 |
---|
Return Value
IFlySpeechError对象
Declared In
IFlySpeechError.h
获取错误码
- (int)errorCode
Return Value
错误码
Declared In
IFlySpeechError.h
获取错误描述
- (NSString *)errorDesc
Return Value
错误描述
Declared In
IFlySpeechError.h
IFlyPcmRecorderDelegate Protocol Reference
Conforms to | NSObject |
---|---|
Declared in | IFlyPcmRecorder.h |
回调音频数据
- (void)onIFlyRecorderBuffer:(const void *)buffer bufferSize:(int)size
Parameters
buffer | 音频数据 |
---|---|
size | 表示音频的长度 |
Declared In
IFlyPcmRecorder.h
回调音频的错误码
- (void)onIFlyRecorderError:(IFlyPcmRecorder *)recoder theError:(int)error
Parameters
recoder | 录音器 |
---|---|
error | 错误码 |
Declared In
IFlyPcmRecorder.h
回调录音音量
- (void)onIFlyRecorderVolumeChanged:(int)power
Parameters
power | 音量值 |
---|
Declared In
IFlyPcmRecorder.h
IFlyEngineMode Constants Reference
Declared in | IFlySpeechUtility.h |
---|
引擎模式
Definition
typedef NS_ENUM(NSUInteger, IFlyEngineMode ) {
IFlyEngineModeAuto = 0,
IFlyEngineModeMsc,
IFlyEngineModePlus,
};
Constants
IFlyEngineModeAuto
云端使用MSC,本地优先使用语记
Declared In IFlySpeechUtility.h.
IFlyEngineModeMsc
只使用MSC
Declared In IFlySpeechUtility.h.
IFlyEngineModePlus
本地只使用语记(受平台限制,云端无法使用语记)
Declared In IFlySpeechUtility.h.
Declared In
IFlySpeechUtility.h
IFlySpeechEventType Constants Reference
Declared in IFlySpeechEvent.h
事件类型
Definition
typedef NS_ENUM(NSUInteger, IFlySpeechEventType ) {
IFlySpeechEventTypeNetPref = 10001,
IFlySpeechEventTypeISTAudioFile = 10004,
IFlySpeechEventTypeISTUploadBytes = 10006,
IFlySpeechEventTypeISTCacheLeft = 10007,
IFlySpeechEventTypeISTResultTime = 10008,
IFlySpeechEventTypeISTSyncID = 10009,
IFlySpeechEventTypeSessionBegin = 10010,
IFlySpeechEventTypeSessionEnd = 10011,
IFlySpeechEventTypeVolume = 10012,
IFlySpeechEventTypeVadEOS = 10013,
IFlySpeechEventTypeSessionID = 20001,
IFlySpeechEventTypeTTSBuffer = 21001,
IFlySpeechEventTypeTTSCancel = 21002,
IFlySpeechEventTypeIVWResult = 22001,
IFlySpeechEventTypeSpeechStart = 22002,
IFlySpeechEventTypeRecordStop = 22003,
IFlySpeechEventTypeAudioUrl = 23001,
IFlySpeechEventTypeVoiceChangeResult = 24001,
};
Constants
IFlySpeechEventTypeNetPref
网络状态消息
在消息到达时,可通过onEvent的第2个参数arg1,获取当前网络连接状态值
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeISTAudioFile
转写音频文件消息
在录音模式下,成功创建音频文件时返回。可通过onEvent第4个参数data,指定Key为[IFlySpeechConstant IST_AUDIO_PATH],获取音频文件绝对路径.或通过[IFlySpeechTranscripter getParameter:[IFlySpeechConstant IST_AUDIO_PATH]],获取音频文件绝对路径.
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeISTUploadBytes
转写已上传字节消息
在消息到达时,通过onEvent的第二个参数arg1,获取已确认上传到服务器的字节数.若当前音频源为非写音频模式,还可通过onEvent 的第三个参数arg2,获取当前所有音频的字节大小.录音模式时,由于所有音频字节大小会变。当停止音频输入后(等待录音时间超时[IFlySpeechConstant SPEECH_TIMEOUT],或调用[IFlySpeechTranscripter stopTranscripting]),且服务器收到所有音频时,第四个参数data,将包含完成标记的布尔值(true),可通过data调用指定KEY为KCIFlySpeechEventKeyISTUploadComplete获取。此消息可能多次返回.
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeISTCacheLeft
转写缓存剩余
此消息仅在音频源为-1时需要关注,在调用[IFlySpeechTranscripter writeAudio]写音频时,应该关注此事件。
此事件在调用写音频接口、及音频最后被写入底库库时分别回调一次。当事件回调时,通过onEvent的第二个参数arg1,获取当前剩余的缓存大小,当缓存小于要写入的音频时,应该先暂停写音频数据,直到下次缓存大小大于要写入的音频时.最大缓存为128KByte。
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeISTResultTime
转写结果等待时间消息
在消息到达时,通过 onEvent的第二个参数arg1,获取当前结果需要的时间.
此消息可能多次返回,返回时间不定,且不一定会返回.
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeISTSyncID
转写转写音频同步ID消息
在消息到达时,通过 onEvent的第二个参数arg1,获取当前写音频同步ID.
此消息可能多次返回.
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeSessionBegin
会话开始消息
在会话开始成功后返回
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeSessionEnd
会话结束消息
在会话结束前返回
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeVolume
音量消息,在得到音量时抛出,暂时只有身份验证的声纹业务用到
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeVadEOS
VAD后端点消息,在检测到VAD后端点时抛出,暂时只有身份验证的声纹业务用到
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeSessionID
服务端会话id
在消息到达时,可通过onEvent的第4个参数data(字典类型),指定key KCIFlySpeechEventKeySessionID,获取服务端会话id.
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeTTSBuffer
TTS合成数据消息
-(void)onEvent:(int)eventType arg0:(int)arg0 arg1:(int)arg1 data:(NSData *)eventData
其中eventData中包含数据
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeTTSCancel
通知cancel方法被调用的回调
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeIVWResult
IVW onshot 听写 or 识别结果
在消息到达时,第2个参数arg1包含是否为最后一个结果:1为是,0为否;
第4个参数data中包含数据,通过指定KEY为KCIFlySpeechEventKeyIVWResult获取.
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeSpeechStart
开始处理录音数据
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeRecordStop
录音停止
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeAudioUrl
服务端音频url
在消息到达时,第4个参数data,包含数据,通过指定KEY为KCIFlySpeechEventKeyAudioUrl获取.
Declared In IFlySpeechEvent.h.
IFlySpeechEventTypeVoiceChangeResult
变声数据结果返回
设置voice_change参数获取结果.
Declared In IFlySpeechEvent.h.
Declared In
IFlySpeechEvent.h
IFlySpeechPlusServiceType Constants Reference
Declared in IFlySpeechUtility.h
服务类型
Definition
typedef NS_ENUM(NSUInteger, IFlySpeechPlusServiceType ) {
IFlySpeechPlusServiceTypeNone = 0,
IFlySpeechPlusServiceTypeTTS,
IFlySpeechPlusServiceTypeISR,
IFlySpeechPlusServiceTypeIVW,
};
Constants
IFlySpeechPlusServiceTypeNone
打开语记主界面
Declared In IFlySpeechUtility.h.
IFlySpeechPlusServiceTypeTTS
获取合成资源
Declared In IFlySpeechUtility.h.
IFlySpeechPlusServiceTypeISR
获取识别资源(未开放)
Declared In IFlySpeechUtility.h.
IFlySpeechPlusServiceTypeIVW
获取唤醒资源(未开放)
Declared In IFlySpeechUtility.h.
Declared In
IFlySpeechUtility.h
LOG_LEVEL Constants Reference
Declared in IFlySetting.h
日志打印等级
Definition
typedef NS_OPTIONS(NSInteger, LOG_LEVEL ) {
LVL_ALL = -1,
LVL_DETAIL = 31,
LVL_NORMAL = 15,
LVL_LOW = 7,
LVL_NONE = 0,
};
Constants
LVL_ALL
全部打印
Declared In IFlySetting.h.
LVL_DETAIL
高,异常分析需要的级别
Declared In IFlySetting.h.
LVL_NORMAL
中,打印基本日志信息
Declared In IFlySetting.h.
LVL_LOW
低,只打印主要日志信息
Declared In IFlySetting.h.
LVL_NONE
不打印
Declared In IFlySetting.h.
Declared In
IFlySetting.h