IFlyRecognizerView.h 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. //
  2. // IFlyRecognizerView.h
  3. // MSC
  4. //
  5. // Created by admin on 13-4-16.
  6. // Copyright (c) 2013年 iflytek. All rights reserved.
  7. //
  8. #import <UIKit/UIKit.h>
  9. @protocol IFlyRecognizerViewDelegate ;
  10. /*!
  11. * 语音识别控件<br>
  12. * 录音时触摸控件结束录音,开始识别(相当于旧版的停止);触摸其他位置,取消录音,结束会话(取消)<br>
  13. * 出错时触摸控件,重新开启会话(相当于旧版的再说一次);触摸其他位置,取消录音,结束会话(取消)
  14. *
  15. */
  16. @interface IFlyRecognizerView : UIView<NSObject>
  17. /*!
  18. * 设置委托对象
  19. */
  20. @property(nonatomic,assign)id<IFlyRecognizerViewDelegate> delegate;
  21. /*!
  22. * 初始化控件
  23. *
  24. * @param origin 控件左上角的坐标
  25. *
  26. * @return IFlyRecognizerView 对象
  27. */
  28. - (id)initWithOrigin:(CGPoint)origin;
  29. /*!
  30. * 初始化控件
  31. *
  32. * @param center 控件中心的坐标
  33. *
  34. * @return IFlyRecognizerView 对象
  35. */
  36. - (id) initWithCenter:(CGPoint)center;
  37. /*!
  38. * 设置横竖屏自适应
  39. *
  40. * @param autoRotate 默认值YES,横竖屏自适应
  41. */
  42. - (void) setAutoRotate:(BOOL)autoRotate;
  43. /*
  44. * | ------------- |-----------------------------------------------------------
  45. * | 参数 | 描述
  46. * | ------------- |-----------------------------------------------------------
  47. * | domain |应用的领域: 取值为:iat、search、video、poi、music、asr;
  48. * | | iat:普通文本听写;
  49. * | | search:热词搜索;
  50. * | | video:视频音乐搜索;
  51. * | | asr:关键词识别;
  52. * | ------------- |-----------------------------------------------------------
  53. * | vad_bos |前端点检测: 静音超时时间,即用户多长时间不说话则当做超时处理; 单位:ms;
  54. * | | engine指定iat识别默认值为5000;
  55. * | | 其他情况默认值为 4000,范围 0-10000。
  56. * | ------------- |-----------------------------------------------------------
  57. * | vad_eos |后断点检测: 后端点静音检测时间,即用户停止说话多长时间内即认为不再输入,
  58. * | | 自动停止录音;单位:ms;
  59. * | | sms 识别默认值为 1800;
  60. * | | 其他默认值为 700,范围 0-10000。
  61. * | ------------- |-----------------------------------------------------------
  62. * | sample_rate |采样率:目前支持的采样率设置有 16000 和 8000。
  63. * | ------------- |-----------------------------------------------------------
  64. * | asr_ptt |标点符号设置: 默认为 1,当设置为 0 时,将返回无标点符号文本。
  65. * | ------------- |-----------------------------------------------------------
  66. * | result_type |返回结果的数据格式: 可设置为json,xml,plain,默认为json。
  67. * | ------------- |-----------------------------------------------------------
  68. * | grammarID |识别的语法id: 只针对 domain 设置为”asr”的应用。
  69. * | ------------- |-----------------------------------------------------------
  70. * | asr_audio_path|音频文件名: 设置此参数后,将会自动保存识别的录音文件。
  71. * | | 路径为Documents/(指定值)。
  72. * | | 不设置或者设置为nil,则不保存音频。
  73. * | ------------- |-----------------------------------------------------------
  74. * | params |扩展参数: 对于一些特殊的参数可在此设置,一般用于设置语义。
  75. * | ------------- |-----------------------------------------------------------
  76. *
  77. */
  78. /*!
  79. * 设置识别引擎的参数
  80. *
  81. * 识别的引擎参数(key)取值如下:<br>
  82. *
  83. * | 参数 | 描述 |
  84. * |-----------------|-------------------------------------------------------|
  85. * | domain | 应用的领域: 取值为:iat、search、video、poi、music、asr;<br>iat:普通文本听写;<br>search:热词搜索;<br>video:视频音乐搜索;<br>asr:关键词识别;|
  86. * | vad_bos | 前端点检测: 静音超时时间,即用户多长时间不说话则当做超时处理; 单位:ms;<br>engine指定iat识别默认值为5000;<br>其他情况默认值为 4000,范围 0-10000。|
  87. * | vad_eos | 后断点检测: 后端点静音检测时间,即用户停止说话多长时间内即认为不再输入,自动停止录音;单位:ms;<br>sms 识别默认值为 1800;<br>其他默认值为 700,范围 0-10000。|
  88. * | sample_rate | 采样率:目前支持的采样率设置有 16000 和 8000。|
  89. * | asr_ptt | 标点符号设置: 默认为 1,当设置为 0 时,将返回无标点符号文本。|
  90. * | result_type | 返回结果的数据格式: 可设置为json,xml,plain,默认为json。|
  91. * | grammarID | 识别的语法id: 只针对 domain 设置为”asr”的应用。|
  92. * | asr_audio_path | 音频文件名: 设置此参数后,将会自动保存识别的录音文件。<br>路径为Documents/(指定值)。<br>不设置或者设置为nil,则不保存音频。|
  93. * | params | 扩展参数: 对于一些特殊的参数可在此设置,一般用于设置语义。|
  94. *
  95. * @param value 参数对应的取值
  96. * @param key 识别引擎参数
  97. *
  98. * @return 成功返回YES;失败返回NO
  99. */
  100. -(BOOL) setParameter:(NSString *) value forKey:(NSString*)key;
  101. /*!
  102. * 获取识别引擎参数
  103. *
  104. * @param key 参数key
  105. *
  106. * @return 参数值
  107. */
  108. -(NSString*) parameterForKey:(NSString *)key;
  109. /*!
  110. * 开始识别
  111. *
  112. * @return 成功返回YES;失败返回NO
  113. */
  114. - (BOOL)start;
  115. /*!
  116. * 取消本次识别
  117. */
  118. - (void)cancel;
  119. @end