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

index.html 16KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311 
  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. 			<div class="tsd-panel tsd-typography">

  67. 				<h5 id="-qq-471757030">有任何问题欢迎加入QQ群进行反馈  471757030</h5>

  68. 				<h2 id="for-1-x-old-version"><a href="README.old.md">for 1.x old version</a></h2>

  69. 				<h1 id="react-native-agora">react-native-agora</h1>

  70. 				<p><a href="https://www.npmjs.com/package/react-native-agora"><img src="https://img.shields.io/npm/v/react-native-agora.svg" alt="npm"></a>

  71. 					<a href="https://www.npmjs.com/package/react-native-agora"><img src="https://img.shields.io/npm/dm/react-native-agora.svg" alt="npm"></a>

  72. 					<a href="https://www.npmjs.com/package/react-native-agora"><img src="https://img.shields.io/npm/dt/react-native-agora.svg" alt="npm"></a>

  73. 					<a href="https://github.com/syanbo/react-native-agora/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/react-native-agora.svg" alt="npm"></a>

  74. 				<a href="https://gitter.im/react-native-agora/community"><img src="https://img.shields.io/badge/gitter-join%20chat-brightgreen.svg" alt="join chat"></a></p>

  75. 				<h2 id="description">Description</h2>

  76. 				<p>The react-native-agora is an open-source wrapper for react-native developers. This SDK takes advantage of React Native and Agora RTC Video SDKs on Android/iOS.</p>

  77. 				<h2 id="compatibility">Compatibility</h2>

  78. 				<ul>

  79. 					<li><blockquote>

  80. 							<p>= react native 0.55.x</p>

  81. 						</blockquote>

  82. 					</li>

  83. 					<li>iOS SDK 8.0+</li>

  84. 					<li>Android 5.0+ x86 arm64 armv7a</li>

  85. 				</ul>

  86. 				<h2 id="quick-start"><a href="https://github.com/AgoraIO-Community/Agora-RN-Quickstart">quick start</a></h2>

  87. 				<h2 id="installation">Installation</h2>

  88. 				<p>Install with npm:</p>

  89. 				<p> <code>npm install --save react-native-agora</code></p>

  90. 				<p>Or, install with yarn:</p>

  91. 				<p> <code>yarn add react-native-agora</code></p>

  92. 				<p>Either way, then link with:</p>

  93. 				<p> <code>react-native link react-native-agora</code></p>

  94. 				<h3 id="ios-installation">iOS Installation</h3>

  95. 				<p>  <a href="docs/IOS_INSTALLATION.zh.md">中文</a>

  96. 				<a href="docs/IOS_INSTALLATION.md">English</a></p>

  97. 				<h3 id="android-installation">Android Installation</h3>

  98. 				<p>  <a href="docs/ANDROID_INSTALLATION.zh.md">中文</a>

  99. 				<a href="docs/ANDROID_INSTALLATION.md">English</a></p>

  100. 				<h2 id="agora-native-api-documentation">Agora Native API Documentation</h2>

  101. 				<h3 id="android">Android</h3>

  102. 				<p>  <a href="https://docs.agora.io/cn/Video/API%20Reference/java/index.html">中文</a>

  103. 				<a href="https://docs.agora.io/en/Video/API%20Reference/java/index.html">English</a></p>

  104. 				<h2 id="ios">iOS</h2>

  105. 				<p>  <a href="https://docs.agora.io/cn/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html">中文</a>

  106. 				<a href="https://docs.agora.io/en/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html">English</a></p>

  107. 				<h2 id="api-docs"><a href="https://syanbo.github.io/react-native-agora/globals.html">API DOCS</a></h2>

  108. 				<h2 id="resources">Resources</h2>

  109. 				<ul>

  110. 					<li>Complete <a href="https://docs.agora.io/en/">API documentation</a> at the Developer Center</li>

  111. 					<li><a href="https://github.com/syanbo/react-native-agora/issues">File bugs about this sample</a></li>

  112. 					<li><a href="https://facebook.github.io/react-native/docs/getting-started.html">React Native Getting Started</a></li>

  113. 				</ul>

  114. 			</div>

  115. 		</div>

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

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

  118. 				<ul>

  119. 					<li class="globals  ">

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

  121. 					</li>

  122. 				</ul>

  123. 			</nav>

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

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

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

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

  128. 					</li>

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

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

  131. 					</li>

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

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

  134. 					</li>

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

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

  137. 					</li>

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

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

  140. 					</li>

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

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

  143. 					</li>

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

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

  146. 					</li>

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

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

  149. 					</li>

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

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

  152. 					</li>

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

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

  155. 					</li>

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

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

  158. 					</li>

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

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

  161. 					</li>

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

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

  164. 					</li>

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

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

  167. 					</li>

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

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

  170. 					</li>

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

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

  173. 					</li>

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

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

  176. 					</li>

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

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

  179. 					</li>

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

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

  182. 					</li>

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

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

  185. 					</li>

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

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

  188. 					</li>

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

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

  191. 					</li>

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

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

  194. 					</li>

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

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

  197. 					</li>

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

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

  200. 					</li>

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

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

  203. 					</li>

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

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

  206. 					</li>

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

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

  209. 					</li>

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

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

  212. 					</li>

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

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

  215. 					</li>

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

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

  218. 					</li>

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

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

  221. 					</li>

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

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

  224. 					</li>

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

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

  227. 					</li>

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

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

  230. 					</li>

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

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

  233. 					</li>

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

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

  236. 					</li>

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

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

  239. 					</li>

  240. 				</ul>

  241. 			</nav>

  242. 		</div>

  243. 	</div>

  244. </div>

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

  246. 	<div class="container">

  247. 		<h2>Legend</h2>

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

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

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

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

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

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

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

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

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

  257. 			</ul>

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

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

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

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

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

  263. 			</ul>

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

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

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

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

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

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

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

  271. 			</ul>

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

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

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

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

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

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

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

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

  280. 			</ul>

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

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

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

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

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

  286. 			</ul>

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

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

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

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

  291. 			</ul>

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

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

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

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

  296. 			</ul>

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

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

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

  300. 			</ul>

  301. 		</div>

  302. 	</div>

  303. </footer>

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

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

  306. </div>

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

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

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

  310. </body>

  311. </html>