npm
/
react-native-agora
Watch 11
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
No Description
232 Commits
1 Branch
Tree: 5fa4036b0e
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '5fa4036b0e'
${ noResults }
react-native-agora/docs/api/globals.html

globals.html 11KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224 
  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>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. 			</ul>

  59. 			<h1> react-native-agora</h1>

  60. 		</div>

  61. 	</div>

  62. </header>

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

  64. 	<div class="row">

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

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

  67. 				<h2>Index</h2>

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

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

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

  71. 							<h3>Classes</h3>

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

  73. 								<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/agoraview.html" class="tsd-kind-icon">Agora<wbr>View</a></li>

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

  75. 							</ul>

  76. 						</section>

  77. 						<section class="tsd-index-section tsd-is-not-exported">

  78. 							<h3>Variables</h3>

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

  80. 								<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#agora" class="tsd-kind-icon">Agora</a></li>

  81. 								<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#agoraeventemitter" class="tsd-kind-icon">Agora<wbr>Event<wbr>Emitter</a></li>

  82. 								<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#rctagoraview" class="tsd-kind-icon">RCTAgora<wbr>View</a></li>

  83. 							</ul>

  84. 						</section>

  85. 					</div>

  86. 				</section>

  87. 			</section>

  88. 			<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">

  89. 				<h2>Variables</h2>

  90. 				<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">

  91. 					<a name="agora" class="tsd-anchor"></a>

  92. 					<h3>Agora</h3>

  93. 					<div class="tsd-signature tsd-kind-icon">Agora<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>

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

  95. 						<ul>

  96. 							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L31">RtcEngine.native.ts:31</a></li>

  97. 						</ul>

  98. 					</aside>

  99. 				</section>

  100. 				<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">

  101. 					<a name="agoraeventemitter" class="tsd-anchor"></a>

  102. 					<h3><span class="tsd-flag ts-flagConst">Const</span> Agora<wbr>Event<wbr>Emitter</h3>

  103. 					<div class="tsd-signature tsd-kind-icon">Agora<wbr>Event<wbr>Emitter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"> =&nbsp;new NativeEventEmitter(Agora)</span></div>

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

  105. 						<ul>

  106. 							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L32">RtcEngine.native.ts:32</a></li>

  107. 						</ul>

  108. 					</aside>

  109. 				</section>

  110. 				<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">

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

  112. 					<h3><span class="tsd-flag ts-flagConst">Const</span> RCTAgora<wbr>View</h3>

  113. 					<div class="tsd-signature tsd-kind-icon">RCTAgora<wbr>View<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> =&nbsp;requireNativeComponent(&quot;RCTAgoraView&quot;)</span></div>

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

  115. 						<ul>

  116. 							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/AgoraView.native.tsx#L16">AgoraView.native.tsx:16</a></li>

  117. 						</ul>

  118. 					</aside>

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

  120. 						<div class="lead">

  121. 							<p>Import RCTAgoraView from native binding.</p>

  122. 						</div>

  123. 						<p>This @object is used to bridge native layer between react layer.</p>

  124. 					</div>

  125. 				</section>

  126. 			</section>

  127. 		</div>

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

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

  130. 				<ul>

  131. 					<li class="globals current ">

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

  133. 					</li>

  134. 				</ul>

  135. 			</nav>

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

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

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

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

  140. 					</li>

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

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

  143. 					</li>

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

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

  146. 					</li>

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

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

  149. 					</li>

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

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

  152. 					</li>

  153. 				</ul>

  154. 			</nav>

  155. 		</div>

  156. 	</div>

  157. </div>

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

  159. 	<div class="container">

  160. 		<h2>Legend</h2>

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

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

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

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

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

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

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

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

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

  170. 			</ul>

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

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

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

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

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

  176. 			</ul>

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

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

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

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

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

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

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

  184. 			</ul>

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

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

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

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

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

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

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

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

  193. 			</ul>

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

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

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

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

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

  199. 			</ul>

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

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

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

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

  204. 			</ul>

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

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

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

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

  209. 			</ul>

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

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

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

  213. 			</ul>

  214. 		</div>

  215. 	</div>

  216. </footer>

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

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

  219. </div>

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

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

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

  223. </body>

  224. </html>