No Description

playeffectoption.html 19KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392
  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>PlayEffectOption | 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="playeffectoption.html">PlayEffectOption</a>
  60. </li>
  61. </ul>
  62. <h1>Interface PlayEffectOption</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-hierarchy">
  70. <h3>Hierarchy</h3>
  71. <ul class="tsd-hierarchy">
  72. <li>
  73. <span class="target">PlayEffectOption</span>
  74. </li>
  75. </ul>
  76. </section>
  77. <section class="tsd-panel-group tsd-index-group">
  78. <h2>Index</h2>
  79. <section class="tsd-panel tsd-index-panel">
  80. <div class="tsd-index-content">
  81. <section class="tsd-index-section ">
  82. <h3>Properties</h3>
  83. <ul class="tsd-index-list">
  84. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="playeffectoption.html#filepath" class="tsd-kind-icon">filepath</a></li>
  85. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="playeffectoption.html#gain" class="tsd-kind-icon">gain</a></li>
  86. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="playeffectoption.html#loopcount" class="tsd-kind-icon">loopcount</a></li>
  87. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="playeffectoption.html#pan" class="tsd-kind-icon">pan</a></li>
  88. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="playeffectoption.html#pitch" class="tsd-kind-icon">pitch</a></li>
  89. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="playeffectoption.html#publish" class="tsd-kind-icon">publish</a></li>
  90. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="playeffectoption.html#soundid" class="tsd-kind-icon">sound<wbr>Id</a></li>
  91. </ul>
  92. </section>
  93. </div>
  94. </section>
  95. </section>
  96. <section class="tsd-panel-group tsd-member-group ">
  97. <h2>Properties</h2>
  98. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  99. <a name="filepath" class="tsd-anchor"></a>
  100. <h3>filepath</h3>
  101. <div class="tsd-signature tsd-kind-icon">filepath<span class="tsd-signature-symbol">:</span> <a href="../globals.html#string" class="tsd-signature-type">String</a></div>
  102. <aside class="tsd-sources">
  103. <ul>
  104. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L164">types.ts:164</a></li>
  105. </ul>
  106. </aside>
  107. </section>
  108. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  109. <a name="gain" class="tsd-anchor"></a>
  110. <h3>gain</h3>
  111. <div class="tsd-signature tsd-kind-icon">gain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
  112. <aside class="tsd-sources">
  113. <ul>
  114. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L168">types.ts:168</a></li>
  115. </ul>
  116. </aside>
  117. </section>
  118. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  119. <a name="loopcount" class="tsd-anchor"></a>
  120. <h3>loopcount</h3>
  121. <div class="tsd-signature tsd-kind-icon">loopcount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
  122. <aside class="tsd-sources">
  123. <ul>
  124. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L165">types.ts:165</a></li>
  125. </ul>
  126. </aside>
  127. </section>
  128. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  129. <a name="pan" class="tsd-anchor"></a>
  130. <h3>pan</h3>
  131. <div class="tsd-signature tsd-kind-icon">pan<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
  132. <aside class="tsd-sources">
  133. <ul>
  134. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L167">types.ts:167</a></li>
  135. </ul>
  136. </aside>
  137. </section>
  138. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  139. <a name="pitch" class="tsd-anchor"></a>
  140. <h3>pitch</h3>
  141. <div class="tsd-signature tsd-kind-icon">pitch<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
  142. <aside class="tsd-sources">
  143. <ul>
  144. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L166">types.ts:166</a></li>
  145. </ul>
  146. </aside>
  147. </section>
  148. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  149. <a name="publish" class="tsd-anchor"></a>
  150. <h3>publish</h3>
  151. <div class="tsd-signature tsd-kind-icon">publish<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
  152. <aside class="tsd-sources">
  153. <ul>
  154. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L169">types.ts:169</a></li>
  155. </ul>
  156. </aside>
  157. </section>
  158. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  159. <a name="soundid" class="tsd-anchor"></a>
  160. <h3>sound<wbr>Id</h3>
  161. <div class="tsd-signature tsd-kind-icon">sound<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
  162. <aside class="tsd-sources">
  163. <ul>
  164. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L163">types.ts:163</a></li>
  165. </ul>
  166. </aside>
  167. </section>
  168. </section>
  169. </div>
  170. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  171. <nav class="tsd-navigation primary">
  172. <ul>
  173. <li class="globals ">
  174. <a href="../globals.html"><em>Globals</em></a>
  175. </li>
  176. </ul>
  177. </nav>
  178. <nav class="tsd-navigation secondary menu-sticky">
  179. <ul class="before-current">
  180. <li class=" tsd-kind-class tsd-has-type-parameter">
  181. <a href="../classes/agoraview.html" class="tsd-kind-icon">Agora<wbr>View</a>
  182. </li>
  183. <li class=" tsd-kind-class">
  184. <a href="../classes/rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
  185. </li>
  186. <li class=" tsd-kind-interface">
  187. <a href="agoraviewprops.html" class="tsd-kind-icon">Agora<wbr>View<wbr>Props</a>
  188. </li>
  189. <li class=" tsd-kind-interface">
  190. <a href="audioframeoption.html" class="tsd-kind-icon">Audio<wbr>Frame<wbr>Option</a>
  191. </li>
  192. <li class=" tsd-kind-interface">
  193. <a href="audiomixingoption.html" class="tsd-kind-icon">Audio<wbr>Mixing<wbr>Option</a>
  194. </li>
  195. <li class=" tsd-kind-interface">
  196. <a href="audiorecordingoption.html" class="tsd-kind-icon">Audio<wbr>Recording<wbr>Option</a>
  197. </li>
  198. <li class=" tsd-kind-interface">
  199. <a href="backgroundimage.html" class="tsd-kind-icon">Background<wbr>Image</a>
  200. </li>
  201. <li class=" tsd-kind-interface">
  202. <a href="beautyoption.html" class="tsd-kind-icon">Beauty<wbr>Option</a>
  203. </li>
  204. <li class=" tsd-kind-interface">
  205. <a href="cameracapturerconfiguration.html" class="tsd-kind-icon">Camera<wbr>Capturer<wbr>Configuration</a>
  206. </li>
  207. <li class=" tsd-kind-interface">
  208. <a href="color.html" class="tsd-kind-icon">Color</a>
  209. </li>
  210. <li class=" tsd-kind-interface">
  211. <a href="datastreamoption.html" class="tsd-kind-icon">Data<wbr>Stream<wbr>Option</a>
  212. </li>
  213. <li class=" tsd-kind-interface">
  214. <a href="defaultvideostreamoption.html" class="tsd-kind-icon">Default<wbr>Video<wbr>Stream<wbr>Option</a>
  215. </li>
  216. <li class=" tsd-kind-interface">
  217. <a href="imageoption.html" class="tsd-kind-icon">Image<wbr>Option</a>
  218. </li>
  219. <li class=" tsd-kind-interface">
  220. <a href="injectstreamoption.html" class="tsd-kind-icon">Inject<wbr>Stream<wbr>Option</a>
  221. </li>
  222. <li class=" tsd-kind-interface">
  223. <a href="lastmileprobeconfig.html" class="tsd-kind-icon">Lastmile<wbr>Probe<wbr>Config</a>
  224. </li>
  225. <li class=" tsd-kind-interface">
  226. <a href="livetranscodingoption.html" class="tsd-kind-icon">Live<wbr>Transcoding<wbr>Option</a>
  227. </li>
  228. <li class=" tsd-kind-interface">
  229. <a href="mixedaudioframeoption.html" class="tsd-kind-icon">Mixed<wbr>Audio<wbr>Frame<wbr>Option</a>
  230. </li>
  231. <li class=" tsd-kind-interface">
  232. <a href="option.html" class="tsd-kind-icon">Option</a>
  233. </li>
  234. </ul>
  235. <ul class="current">
  236. <li class="current tsd-kind-interface">
  237. <a href="playeffectoption.html" class="tsd-kind-icon">Play<wbr>Effect<wbr>Option</a>
  238. <ul>
  239. <li class=" tsd-kind-property tsd-parent-kind-interface">
  240. <a href="playeffectoption.html#filepath" class="tsd-kind-icon">filepath</a>
  241. </li>
  242. <li class=" tsd-kind-property tsd-parent-kind-interface">
  243. <a href="playeffectoption.html#gain" class="tsd-kind-icon">gain</a>
  244. </li>
  245. <li class=" tsd-kind-property tsd-parent-kind-interface">
  246. <a href="playeffectoption.html#loopcount" class="tsd-kind-icon">loopcount</a>
  247. </li>
  248. <li class=" tsd-kind-property tsd-parent-kind-interface">
  249. <a href="playeffectoption.html#pan" class="tsd-kind-icon">pan</a>
  250. </li>
  251. <li class=" tsd-kind-property tsd-parent-kind-interface">
  252. <a href="playeffectoption.html#pitch" class="tsd-kind-icon">pitch</a>
  253. </li>
  254. <li class=" tsd-kind-property tsd-parent-kind-interface">
  255. <a href="playeffectoption.html#publish" class="tsd-kind-icon">publish</a>
  256. </li>
  257. <li class=" tsd-kind-property tsd-parent-kind-interface">
  258. <a href="playeffectoption.html#soundid" class="tsd-kind-icon">sound<wbr>Id</a>
  259. </li>
  260. </ul>
  261. </li>
  262. </ul>
  263. <ul class="after-current">
  264. <li class=" tsd-kind-interface">
  265. <a href="positionoption.html" class="tsd-kind-icon">Position<wbr>Option</a>
  266. </li>
  267. <li class=" tsd-kind-interface">
  268. <a href="publishstreamoption.html" class="tsd-kind-icon">Publish<wbr>Stream<wbr>Option</a>
  269. </li>
  270. <li class=" tsd-kind-interface">
  271. <a href="publisherconfig.html" class="tsd-kind-icon">Publisher<wbr>Config</a>
  272. </li>
  273. <li class=" tsd-kind-interface">
  274. <a href="rect.html" class="tsd-kind-icon">Rect</a>
  275. </li>
  276. <li class=" tsd-kind-interface">
  277. <a href="removeinjectstreamoption.html" class="tsd-kind-icon">Remove<wbr>Inject<wbr>Stream<wbr>Option</a>
  278. </li>
  279. <li class=" tsd-kind-interface">
  280. <a href="removepublishstreamoption.html" class="tsd-kind-icon">Remove<wbr>Publish<wbr>Stream<wbr>Option</a>
  281. </li>
  282. <li class=" tsd-kind-interface">
  283. <a href="size.html" class="tsd-kind-icon">Size</a>
  284. </li>
  285. <li class=" tsd-kind-interface">
  286. <a href="transcodinguser.html" class="tsd-kind-icon">Transcoding<wbr>User</a>
  287. </li>
  288. <li class=" tsd-kind-interface">
  289. <a href="videoencoderconfig.html" class="tsd-kind-icon">Video<wbr>Encoder<wbr>Config</a>
  290. </li>
  291. <li class=" tsd-kind-interface">
  292. <a href="videooption.html" class="tsd-kind-icon">Video<wbr>Option</a>
  293. </li>
  294. <li class=" tsd-kind-interface">
  295. <a href="videostreamoption.html" class="tsd-kind-icon">Video<wbr>Stream<wbr>Option</a>
  296. </li>
  297. <li class=" tsd-kind-interface">
  298. <a href="voicedecorator.html" class="tsd-kind-icon">Voice<wbr>Decorator</a>
  299. </li>
  300. <li class=" tsd-kind-type-alias tsd-has-type-parameter">
  301. <a href="../globals.html#callback" class="tsd-kind-icon">Callback</a>
  302. </li>
  303. <li class=" tsd-kind-type-alias tsd-has-type-parameter">
  304. <a href="../globals.html#nullable" class="tsd-kind-icon">Nullable</a>
  305. </li>
  306. <li class=" tsd-kind-type-alias">
  307. <a href="../globals.html#number" class="tsd-kind-icon">Number</a>
  308. </li>
  309. <li class=" tsd-kind-type-alias">
  310. <a href="../globals.html#string" class="tsd-kind-icon">String</a>
  311. </li>
  312. <li class=" tsd-kind-variable tsd-is-not-exported">
  313. <a href="../globals.html#agora" class="tsd-kind-icon">Agora</a>
  314. </li>
  315. <li class=" tsd-kind-variable tsd-is-not-exported">
  316. <a href="../globals.html#agoraeventemitter" class="tsd-kind-icon">Agora<wbr>Event<wbr>Emitter</a>
  317. </li>
  318. <li class=" tsd-kind-variable tsd-is-not-exported">
  319. <a href="../globals.html#rctagoraview" class="tsd-kind-icon">RCTAgora<wbr>View</a>
  320. </li>
  321. </ul>
  322. </nav>
  323. </div>
  324. </div>
  325. </div>
  326. <footer class="with-border-bottom">
  327. <div class="container">
  328. <h2>Legend</h2>
  329. <div class="tsd-legend-group">
  330. <ul class="tsd-legend">
  331. <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
  332. <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
  333. <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
  334. <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
  335. <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
  336. <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
  337. <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
  338. </ul>
  339. <ul class="tsd-legend">
  340. <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
  341. <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
  342. <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
  343. <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
  344. </ul>
  345. <ul class="tsd-legend">
  346. <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
  347. <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
  348. <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
  349. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  350. <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
  351. <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
  352. </ul>
  353. <ul class="tsd-legend">
  354. <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
  355. <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
  356. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  357. <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
  358. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  359. <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
  360. <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
  361. </ul>
  362. <ul class="tsd-legend">
  363. <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
  364. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  365. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  366. <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
  367. </ul>
  368. <ul class="tsd-legend">
  369. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
  370. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
  371. <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
  372. </ul>
  373. <ul class="tsd-legend">
  374. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
  375. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
  376. <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
  377. </ul>
  378. <ul class="tsd-legend">
  379. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
  380. <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
  381. </ul>
  382. </div>
  383. </div>
  384. </footer>
  385. <div class="container tsd-generator">
  386. <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
  387. </div>
  388. <div class="overlay"></div>
  389. <script src="../assets/js/main.js"></script>
  390. <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
  391. </body>
  392. </html>