No Description

defaultvideostreamoption.html 14KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  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>DefaultVideoStreamOption | 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="defaultvideostreamoption.html">DefaultVideoStreamOption</a>
  60. </li>
  61. </ul>
  62. <h1>Interface DefaultVideoStreamOption</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">DefaultVideoStreamOption</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="defaultvideostreamoption.html#streamtype" class="tsd-kind-icon">stream<wbr>Type</a></li>
  85. </ul>
  86. </section>
  87. </div>
  88. </section>
  89. </section>
  90. <section class="tsd-panel-group tsd-member-group ">
  91. <h2>Properties</h2>
  92. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  93. <a name="streamtype" class="tsd-anchor"></a>
  94. <h3>stream<wbr>Type</h3>
  95. <div class="tsd-signature tsd-kind-icon">stream<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
  96. <aside class="tsd-sources">
  97. <ul>
  98. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L198">types.ts:198</a></li>
  99. </ul>
  100. </aside>
  101. </section>
  102. </section>
  103. </div>
  104. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  105. <nav class="tsd-navigation primary">
  106. <ul>
  107. <li class="globals ">
  108. <a href="../globals.html"><em>Globals</em></a>
  109. </li>
  110. </ul>
  111. </nav>
  112. <nav class="tsd-navigation secondary menu-sticky">
  113. <ul class="before-current">
  114. <li class=" tsd-kind-class tsd-has-type-parameter">
  115. <a href="../classes/agoraview.html" class="tsd-kind-icon">Agora<wbr>View</a>
  116. </li>
  117. <li class=" tsd-kind-class">
  118. <a href="../classes/rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
  119. </li>
  120. <li class=" tsd-kind-interface">
  121. <a href="agoraviewprops.html" class="tsd-kind-icon">Agora<wbr>View<wbr>Props</a>
  122. </li>
  123. <li class=" tsd-kind-interface">
  124. <a href="audioframeoption.html" class="tsd-kind-icon">Audio<wbr>Frame<wbr>Option</a>
  125. </li>
  126. <li class=" tsd-kind-interface">
  127. <a href="audiomixingoption.html" class="tsd-kind-icon">Audio<wbr>Mixing<wbr>Option</a>
  128. </li>
  129. <li class=" tsd-kind-interface">
  130. <a href="audiorecordingoption.html" class="tsd-kind-icon">Audio<wbr>Recording<wbr>Option</a>
  131. </li>
  132. <li class=" tsd-kind-interface">
  133. <a href="backgroundimage.html" class="tsd-kind-icon">Background<wbr>Image</a>
  134. </li>
  135. <li class=" tsd-kind-interface">
  136. <a href="beautyoption.html" class="tsd-kind-icon">Beauty<wbr>Option</a>
  137. </li>
  138. <li class=" tsd-kind-interface">
  139. <a href="cameracapturerconfiguration.html" class="tsd-kind-icon">Camera<wbr>Capturer<wbr>Configuration</a>
  140. </li>
  141. <li class=" tsd-kind-interface">
  142. <a href="color.html" class="tsd-kind-icon">Color</a>
  143. </li>
  144. <li class=" tsd-kind-interface">
  145. <a href="datastreamoption.html" class="tsd-kind-icon">Data<wbr>Stream<wbr>Option</a>
  146. </li>
  147. </ul>
  148. <ul class="current">
  149. <li class="current tsd-kind-interface">
  150. <a href="defaultvideostreamoption.html" class="tsd-kind-icon">Default<wbr>Video<wbr>Stream<wbr>Option</a>
  151. <ul>
  152. <li class=" tsd-kind-property tsd-parent-kind-interface">
  153. <a href="defaultvideostreamoption.html#streamtype" class="tsd-kind-icon">stream<wbr>Type</a>
  154. </li>
  155. </ul>
  156. </li>
  157. </ul>
  158. <ul class="after-current">
  159. <li class=" tsd-kind-interface">
  160. <a href="imageoption.html" class="tsd-kind-icon">Image<wbr>Option</a>
  161. </li>
  162. <li class=" tsd-kind-interface">
  163. <a href="injectstreamoption.html" class="tsd-kind-icon">Inject<wbr>Stream<wbr>Option</a>
  164. </li>
  165. <li class=" tsd-kind-interface">
  166. <a href="lastmileprobeconfig.html" class="tsd-kind-icon">Lastmile<wbr>Probe<wbr>Config</a>
  167. </li>
  168. <li class=" tsd-kind-interface">
  169. <a href="livetranscodingoption.html" class="tsd-kind-icon">Live<wbr>Transcoding<wbr>Option</a>
  170. </li>
  171. <li class=" tsd-kind-interface">
  172. <a href="mixedaudioframeoption.html" class="tsd-kind-icon">Mixed<wbr>Audio<wbr>Frame<wbr>Option</a>
  173. </li>
  174. <li class=" tsd-kind-interface">
  175. <a href="option.html" class="tsd-kind-icon">Option</a>
  176. </li>
  177. <li class=" tsd-kind-interface">
  178. <a href="playeffectoption.html" class="tsd-kind-icon">Play<wbr>Effect<wbr>Option</a>
  179. </li>
  180. <li class=" tsd-kind-interface">
  181. <a href="positionoption.html" class="tsd-kind-icon">Position<wbr>Option</a>
  182. </li>
  183. <li class=" tsd-kind-interface">
  184. <a href="publishstreamoption.html" class="tsd-kind-icon">Publish<wbr>Stream<wbr>Option</a>
  185. </li>
  186. <li class=" tsd-kind-interface">
  187. <a href="publisherconfig.html" class="tsd-kind-icon">Publisher<wbr>Config</a>
  188. </li>
  189. <li class=" tsd-kind-interface">
  190. <a href="rect.html" class="tsd-kind-icon">Rect</a>
  191. </li>
  192. <li class=" tsd-kind-interface">
  193. <a href="removeinjectstreamoption.html" class="tsd-kind-icon">Remove<wbr>Inject<wbr>Stream<wbr>Option</a>
  194. </li>
  195. <li class=" tsd-kind-interface">
  196. <a href="removepublishstreamoption.html" class="tsd-kind-icon">Remove<wbr>Publish<wbr>Stream<wbr>Option</a>
  197. </li>
  198. <li class=" tsd-kind-interface">
  199. <a href="size.html" class="tsd-kind-icon">Size</a>
  200. </li>
  201. <li class=" tsd-kind-interface">
  202. <a href="transcodinguser.html" class="tsd-kind-icon">Transcoding<wbr>User</a>
  203. </li>
  204. <li class=" tsd-kind-interface">
  205. <a href="videoencoderconfig.html" class="tsd-kind-icon">Video<wbr>Encoder<wbr>Config</a>
  206. </li>
  207. <li class=" tsd-kind-interface">
  208. <a href="videooption.html" class="tsd-kind-icon">Video<wbr>Option</a>
  209. </li>
  210. <li class=" tsd-kind-interface">
  211. <a href="videostreamoption.html" class="tsd-kind-icon">Video<wbr>Stream<wbr>Option</a>
  212. </li>
  213. <li class=" tsd-kind-interface">
  214. <a href="voicedecorator.html" class="tsd-kind-icon">Voice<wbr>Decorator</a>
  215. </li>
  216. <li class=" tsd-kind-type-alias tsd-has-type-parameter">
  217. <a href="../globals.html#callback" class="tsd-kind-icon">Callback</a>
  218. </li>
  219. <li class=" tsd-kind-type-alias tsd-has-type-parameter">
  220. <a href="../globals.html#nullable" class="tsd-kind-icon">Nullable</a>
  221. </li>
  222. <li class=" tsd-kind-type-alias">
  223. <a href="../globals.html#number" class="tsd-kind-icon">Number</a>
  224. </li>
  225. <li class=" tsd-kind-type-alias">
  226. <a href="../globals.html#string" class="tsd-kind-icon">String</a>
  227. </li>
  228. <li class=" tsd-kind-variable tsd-is-not-exported">
  229. <a href="../globals.html#agora" class="tsd-kind-icon">Agora</a>
  230. </li>
  231. <li class=" tsd-kind-variable tsd-is-not-exported">
  232. <a href="../globals.html#agoraeventemitter" class="tsd-kind-icon">Agora<wbr>Event<wbr>Emitter</a>
  233. </li>
  234. <li class=" tsd-kind-variable tsd-is-not-exported">
  235. <a href="../globals.html#rctagoraview" class="tsd-kind-icon">RCTAgora<wbr>View</a>
  236. </li>
  237. </ul>
  238. </nav>
  239. </div>
  240. </div>
  241. </div>
  242. <footer class="with-border-bottom">
  243. <div class="container">
  244. <h2>Legend</h2>
  245. <div class="tsd-legend-group">
  246. <ul class="tsd-legend">
  247. <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
  248. <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
  249. <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
  250. <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
  251. <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
  252. <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
  253. <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
  254. </ul>
  255. <ul class="tsd-legend">
  256. <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
  257. <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
  258. <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
  259. <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
  260. </ul>
  261. <ul class="tsd-legend">
  262. <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
  263. <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
  264. <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
  265. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  266. <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
  267. <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
  268. </ul>
  269. <ul class="tsd-legend">
  270. <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
  271. <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
  272. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  273. <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
  274. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  275. <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
  276. <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
  277. </ul>
  278. <ul class="tsd-legend">
  279. <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
  280. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  281. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  282. <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
  283. </ul>
  284. <ul class="tsd-legend">
  285. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
  286. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
  287. <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
  288. </ul>
  289. <ul class="tsd-legend">
  290. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
  291. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
  292. <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
  293. </ul>
  294. <ul class="tsd-legend">
  295. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
  296. <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
  297. </ul>
  298. </div>
  299. </div>
  300. </footer>
  301. <div class="container tsd-generator">
  302. <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
  303. </div>
  304. <div class="overlay"></div>
  305. <script src="../assets/js/main.js"></script>
  306. <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
  307. </body>
  308. </html>