npm
/
react-native-agora
关注 11
点赞 0
派生 0
代码 工单 0 合并请求 0 版本发布 0 百科 动态
暂无描述
261 提交
1 分支
目录树: 6182ea47c4
分支列表 标签列表
${ item.name }
创建分支 ${ searchTerm }
从 '6182ea47c4'
${ noResults }
react-native-agora/docs/api/interfaces/voicedecorator.html

voicedecorator.html 16KB
文件历史 原始文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339 
  1. <!doctype html>

  2. <html class="default no-js">

  3. <head>

  4. 	<meta charset="utf-8">

  5. 	<meta http-equiv="X-UA-Compatible" content="IE=edge">

  6. 	<title>VoiceDecorator | react-native-agora</title>

  7. 	<meta name="description" content="">

  8. 	<meta name="viewport" content="width=device-width, initial-scale=1">

  9. 	<link rel="stylesheet" href="../assets/css/main.css">

  10. </head>

  11. <body>

  12. <header>

  13. 	<div class="tsd-page-toolbar">

  14. 		<div class="container">

  15. 			<div class="table-wrap">

  16. 				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">

  17. 					<div class="field">

  18. 						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>

  19. 						<input id="tsd-search-field" type="text" />

  20. 					</div>

  21. 					<ul class="results">

  22. 						<li class="state loading">Preparing search index...</li>

  23. 						<li class="state failure">The search index is not available</li>

  24. 					</ul>

  25. 					<a href="../index.html" class="title">react-native-agora</a>

  26. 				</div>

  27. 				<div class="table-cell" id="tsd-widgets">

  28. 					<div id="tsd-filter">

  29. 						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>

  30. 						<div class="tsd-filter-group">

  31. 							<div class="tsd-select" id="tsd-filter-visibility">

  32. 								<span class="tsd-select-label">All</span>

  33. 								<ul class="tsd-select-list">

  34. 									<li data-value="public">Public</li>

  35. 									<li data-value="protected">Public/Protected</li>

  36. 									<li data-value="private" class="selected">All</li>

  37. 								</ul>

  38. 							</div>

  39. 							<input type="checkbox" id="tsd-filter-inherited" checked />

  40. 							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>

  41. 							<input type="checkbox" id="tsd-filter-externals" checked />

  42. 							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>

  43. 							<input type="checkbox" id="tsd-filter-only-exported" />

  44. 							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>

  45. 						</div>

  46. 					</div>

  47. 					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>

  48. 				</div>

  49. 			</div>

  50. 		</div>

  51. 	</div>

  52. 	<div class="tsd-page-title">

  53. 		<div class="container">

  54. 			<ul class="tsd-breadcrumb">

  55. 				<li>

  56. 					<a href="../globals.html">Globals</a>

  57. 				</li>

  58. 				<li>

  59. 					<a href="voicedecorator.html">VoiceDecorator</a>

  60. 				</li>

  61. 			</ul>

  62. 			<h1>Interface VoiceDecorator</h1>

  63. 		</div>

  64. 	</div>

  65. </header>

  66. <div class="container container-main">

  67. 	<div class="row">

  68. 		<div class="col-8 col-content">

  69. 			<section class="tsd-panel tsd-comment">

  70. 				<div class="tsd-comment tsd-typography">

  71. 					<div class="lead">

  72. 						<p>VoiceDecorator is decorate local audio voice</p>

  73. 					</div>

  74. 					<dl class="tsd-comment-tags">

  75. 						<dt>property</dt>

  76. 						<dd><p>type: string | the range values [&#39;changer&#39; | &#39;reverbPreset&#39;] This property is the identifier for audio voice decorator</p>

  77. 						</dd>

  78. 						<dt>property</dt>

  79. 						<dd><p>value: number | the value for voice parameter option.

  80. 								type &#39;reverbPreset&#39; range values: [0 is &quot;off&quot;, 1 is &quot;popular&quot;, 2 is &quot;rnb&quot;, 3 is &quot;rock&quot;, 4 is &quot;hiphop&quot;, 5 is &quot;vocal concert&quot;, 6 is &quot;KTV&quot;, 7 is &quot;studio&quot;]

  81. 							type &#39;changer&#39; range values: [0 is &quot;off&quot;, 1 is &quot;old man&quot;, 2 is &quot;baby boy&quot;, 3 is &quot;baby girl&quot;, 4 is &quot;zhubajie&quot;, 5 is &quot;ethereal&quot;, 6 is &quot;hulk&quot;]</p>

  82. 						</dd>

  83. 					</dl>

  84. 				</div>

  85. 			</section>

  86. 			<section class="tsd-panel tsd-hierarchy">

  87. 				<h3>Hierarchy</h3>

  88. 				<ul class="tsd-hierarchy">

  89. 					<li>

  90. 						<span class="target">VoiceDecorator</span>

  91. 					</li>

  92. 				</ul>

  93. 			</section>

  94. 			<section class="tsd-panel-group tsd-index-group">

  95. 				<h2>Index</h2>

  96. 				<section class="tsd-panel tsd-index-panel">

  97. 					<div class="tsd-index-content">

  98. 						<section class="tsd-index-section ">

  99. 							<h3>Properties</h3>

  100. 							<ul class="tsd-index-list">

  101. 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="voicedecorator.html#type" class="tsd-kind-icon">type</a></li>

  102. 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="voicedecorator.html#value" class="tsd-kind-icon">value</a></li>

  103. 							</ul>

  104. 						</section>

  105. 					</div>

  106. 				</section>

  107. 			</section>

  108. 			<section class="tsd-panel-group tsd-member-group ">

  109. 				<h2>Properties</h2>

  110. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">

  111. 					<a name="type" class="tsd-anchor"></a>

  112. 					<h3>type</h3>

  113. 					<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>

  114. 					<aside class="tsd-sources">

  115. 						<ul>

  116. 							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L54">types.ts:54</a></li>

  117. 						</ul>

  118. 					</aside>

  119. 				</section>

  120. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">

  121. 					<a name="value" class="tsd-anchor"></a>

  122. 					<h3>value</h3>

  123. 					<div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>

  124. 					<aside class="tsd-sources">

  125. 						<ul>

  126. 							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L55">types.ts:55</a></li>

  127. 						</ul>

  128. 					</aside>

  129. 				</section>

  130. 			</section>

  131. 		</div>

  132. 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">

  133. 			<nav class="tsd-navigation primary">

  134. 				<ul>

  135. 					<li class="globals  ">

  136. 						<a href="../globals.html"><em>Globals</em></a>

  137. 					</li>

  138. 				</ul>

  139. 			</nav>

  140. 			<nav class="tsd-navigation secondary menu-sticky">

  141. 				<ul class="before-current">

  142. 					<li class=" tsd-kind-class tsd-has-type-parameter">

  143. 						<a href="../classes/agoraview.html" class="tsd-kind-icon">Agora<wbr>View</a>

  144. 					</li>

  145. 					<li class=" tsd-kind-class">

  146. 						<a href="../classes/rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>

  147. 					</li>

  148. 					<li class=" tsd-kind-interface">

  149. 						<a href="agoraviewprops.html" class="tsd-kind-icon">Agora<wbr>View<wbr>Props</a>

  150. 					</li>

  151. 					<li class=" tsd-kind-interface">

  152. 						<a href="audioframeoption.html" class="tsd-kind-icon">Audio<wbr>Frame<wbr>Option</a>

  153. 					</li>

  154. 					<li class=" tsd-kind-interface">

  155. 						<a href="audiomixingoption.html" class="tsd-kind-icon">Audio<wbr>Mixing<wbr>Option</a>

  156. 					</li>

  157. 					<li class=" tsd-kind-interface">

  158. 						<a href="audiorecordingoption.html" class="tsd-kind-icon">Audio<wbr>Recording<wbr>Option</a>

  159. 					</li>

  160. 					<li class=" tsd-kind-interface">

  161. 						<a href="backgroundimage.html" class="tsd-kind-icon">Background<wbr>Image</a>

  162. 					</li>

  163. 					<li class=" tsd-kind-interface">

  164. 						<a href="beautyoption.html" class="tsd-kind-icon">Beauty<wbr>Option</a>

  165. 					</li>

  166. 					<li class=" tsd-kind-interface">

  167. 						<a href="cameracapturerconfiguration.html" class="tsd-kind-icon">Camera<wbr>Capturer<wbr>Configuration</a>

  168. 					</li>

  169. 					<li class=" tsd-kind-interface">

  170. 						<a href="color.html" class="tsd-kind-icon">Color</a>

  171. 					</li>

  172. 					<li class=" tsd-kind-interface">

  173. 						<a href="datastreamoption.html" class="tsd-kind-icon">Data<wbr>Stream<wbr>Option</a>

  174. 					</li>

  175. 					<li class=" tsd-kind-interface">

  176. 						<a href="defaultvideostreamoption.html" class="tsd-kind-icon">Default<wbr>Video<wbr>Stream<wbr>Option</a>

  177. 					</li>

  178. 					<li class=" tsd-kind-interface">

  179. 						<a href="imageoption.html" class="tsd-kind-icon">Image<wbr>Option</a>

  180. 					</li>

  181. 					<li class=" tsd-kind-interface">

  182. 						<a href="injectstreamoption.html" class="tsd-kind-icon">Inject<wbr>Stream<wbr>Option</a>

  183. 					</li>

  184. 					<li class=" tsd-kind-interface">

  185. 						<a href="lastmileprobeconfig.html" class="tsd-kind-icon">Lastmile<wbr>Probe<wbr>Config</a>

  186. 					</li>

  187. 					<li class=" tsd-kind-interface">

  188. 						<a href="livetranscodingoption.html" class="tsd-kind-icon">Live<wbr>Transcoding<wbr>Option</a>

  189. 					</li>

  190. 					<li class=" tsd-kind-interface">

  191. 						<a href="mixedaudioframeoption.html" class="tsd-kind-icon">Mixed<wbr>Audio<wbr>Frame<wbr>Option</a>

  192. 					</li>

  193. 					<li class=" tsd-kind-interface">

  194. 						<a href="option.html" class="tsd-kind-icon">Option</a>

  195. 					</li>

  196. 					<li class=" tsd-kind-interface">

  197. 						<a href="playeffectoption.html" class="tsd-kind-icon">Play<wbr>Effect<wbr>Option</a>

  198. 					</li>

  199. 					<li class=" tsd-kind-interface">

  200. 						<a href="positionoption.html" class="tsd-kind-icon">Position<wbr>Option</a>

  201. 					</li>

  202. 					<li class=" tsd-kind-interface">

  203. 						<a href="publishstreamoption.html" class="tsd-kind-icon">Publish<wbr>Stream<wbr>Option</a>

  204. 					</li>

  205. 					<li class=" tsd-kind-interface">

  206. 						<a href="publisherconfig.html" class="tsd-kind-icon">Publisher<wbr>Config</a>

  207. 					</li>

  208. 					<li class=" tsd-kind-interface">

  209. 						<a href="rect.html" class="tsd-kind-icon">Rect</a>

  210. 					</li>

  211. 					<li class=" tsd-kind-interface">

  212. 						<a href="removeinjectstreamoption.html" class="tsd-kind-icon">Remove<wbr>Inject<wbr>Stream<wbr>Option</a>

  213. 					</li>

  214. 					<li class=" tsd-kind-interface">

  215. 						<a href="removepublishstreamoption.html" class="tsd-kind-icon">Remove<wbr>Publish<wbr>Stream<wbr>Option</a>

  216. 					</li>

  217. 					<li class=" tsd-kind-interface">

  218. 						<a href="size.html" class="tsd-kind-icon">Size</a>

  219. 					</li>

  220. 					<li class=" tsd-kind-interface">

  221. 						<a href="transcodinguser.html" class="tsd-kind-icon">Transcoding<wbr>User</a>

  222. 					</li>

  223. 					<li class=" tsd-kind-interface">

  224. 						<a href="videoencoderconfig.html" class="tsd-kind-icon">Video<wbr>Encoder<wbr>Config</a>

  225. 					</li>

  226. 					<li class=" tsd-kind-interface">

  227. 						<a href="videooption.html" class="tsd-kind-icon">Video<wbr>Option</a>

  228. 					</li>

  229. 					<li class=" tsd-kind-interface">

  230. 						<a href="videostreamoption.html" class="tsd-kind-icon">Video<wbr>Stream<wbr>Option</a>

  231. 					</li>

  232. 				</ul>

  233. 				<ul class="current">

  234. 					<li class="current tsd-kind-interface">

  235. 						<a href="voicedecorator.html" class="tsd-kind-icon">Voice<wbr>Decorator</a>

  236. 						<ul>

  237. 							<li class=" tsd-kind-property tsd-parent-kind-interface">

  238. 								<a href="voicedecorator.html#type" class="tsd-kind-icon">type</a>

  239. 							</li>

  240. 							<li class=" tsd-kind-property tsd-parent-kind-interface">

  241. 								<a href="voicedecorator.html#value" class="tsd-kind-icon">value</a>

  242. 							</li>

  243. 						</ul>

  244. 					</li>

  245. 				</ul>

  246. 				<ul class="after-current">

  247. 					<li class=" tsd-kind-type-alias tsd-has-type-parameter">

  248. 						<a href="../globals.html#callback" class="tsd-kind-icon">Callback</a>

  249. 					</li>

  250. 					<li class=" tsd-kind-type-alias tsd-has-type-parameter">

  251. 						<a href="../globals.html#nullable" class="tsd-kind-icon">Nullable</a>

  252. 					</li>

  253. 					<li class=" tsd-kind-type-alias">

  254. 						<a href="../globals.html#number" class="tsd-kind-icon">Number</a>

  255. 					</li>

  256. 					<li class=" tsd-kind-type-alias">

  257. 						<a href="../globals.html#string" class="tsd-kind-icon">String</a>

  258. 					</li>

  259. 					<li class=" tsd-kind-variable tsd-is-not-exported">

  260. 						<a href="../globals.html#agora" class="tsd-kind-icon">Agora</a>

  261. 					</li>

  262. 					<li class=" tsd-kind-variable tsd-is-not-exported">

  263. 						<a href="../globals.html#agoraeventemitter" class="tsd-kind-icon">Agora<wbr>Event<wbr>Emitter</a>

  264. 					</li>

  265. 					<li class=" tsd-kind-variable tsd-is-not-exported">

  266. 						<a href="../globals.html#rctagoraview" class="tsd-kind-icon">RCTAgora<wbr>View</a>

  267. 					</li>

  268. 				</ul>

  269. 			</nav>

  270. 		</div>

  271. 	</div>

  272. </div>

  273. <footer class="with-border-bottom">

  274. 	<div class="container">

  275. 		<h2>Legend</h2>

  276. 		<div class="tsd-legend-group">

  277. 			<ul class="tsd-legend">

  278. 				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>

  279. 				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>

  280. 				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>

  281. 				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>

  282. 				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>

  283. 				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>

  284. 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>

  285. 			</ul>

  286. 			<ul class="tsd-legend">

  287. 				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>

  288. 				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>

  289. 				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>

  290. 				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>

  291. 			</ul>

  292. 			<ul class="tsd-legend">

  293. 				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>

  294. 				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>

  295. 				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>

  296. 				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>

  297. 				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>

  298. 				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>

  299. 			</ul>

  300. 			<ul class="tsd-legend">

  301. 				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>

  302. 				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>

  303. 				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>

  304. 				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>

  305. 				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>

  306. 				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>

  307. 				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>

  308. 			</ul>

  309. 			<ul class="tsd-legend">

  310. 				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>

  311. 				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>

  312. 				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>

  313. 				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>

  314. 			</ul>

  315. 			<ul class="tsd-legend">

  316. 				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>

  317. 				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>

  318. 				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>

  319. 			</ul>

  320. 			<ul class="tsd-legend">

  321. 				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>

  322. 				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>

  323. 				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>

  324. 			</ul>

  325. 			<ul class="tsd-legend">

  326. 				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>

  327. 				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>

  328. 			</ul>

  329. 		</div>

  330. 	</div>

  331. </footer>

  332. <div class="container tsd-generator">

  333. 	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>

  334. </div>

  335. <div class="overlay"></div>

  336. <script src="../assets/js/main.js"></script>

  337. <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>

  338. </body>

  339. </html>