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/classes/agoraview.html

agoraview.html 70KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174 
  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>AgoraView | 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="agoraview.html">AgoraView</a>

  60. 				</li>

  61. 			</ul>

  62. 			<h1>Class AgoraView&lt;S, SS, S&gt;</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>AgoraView is the render layer for rendering video stream</p>

  73. 					</div>

  74. 					<p>This class is used to rendering native sdk stream</p>

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

  76. 						<dt>props</dt>

  77. 						<dd><p><a href="../interfaces/agoraviewprops.html">AgoraViewProps</a></p>

  78. 						</dd>

  79. 						<dt>descrption</dt>

  80. 						<dd><p>AgoraViewProps has four properties.</p>

  81. 						</dd>

  82. 						<dt>property</dt>

  83. 						<dd><p>number: mode, this property will setup video render mode. there is two avaliable mode {hidden: 1, fit: 2}, you could see more details <a href="#here">https://docs.agora.io/en/Interactive%20Broadcast/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_rtc_engine.html#ac08882c4d0ec47b329900df169493673</a></p>

  84. 						</dd>

  85. 						<dt>property</dt>

  86. 						<dd><p>boolean: showLocalVideo, this property will render local video, NOTICE: IF YOU SET showLocalVideo YOU CANNOT SET remoteUid</p>

  87. 						</dd>

  88. 						<dt>property</dt>

  89. 						<dd><p>number: remoteUid, this property will render video with remote uid, NOTICE: IF YOU SET remoteUid YOU CANNOT SET showLocalVideo</p>

  90. 						</dd>

  91. 						<dt>property</dt>

  92. 						<dd><p>boolean: zOrderMediaOverlay, this property will working for android side and it likes zIndex behaviour on web side.</p>

  93. 						</dd>

  94. 					</dl>

  95. 				</div>

  96. 			</section>

  97. 			<section class="tsd-panel tsd-type-parameters">

  98. 				<h3>Type parameters</h3>

  99. 				<ul class="tsd-type-parameters">

  100. 					<li>

  101. 						<h4>S</h4>

  102. 					</li>

  103. 					<li>

  104. 						<h4>SS</h4>

  105. 					</li>

  106. 					<li>

  107. 						<h4>S</h4>

  108. 					</li>

  109. 				</ul>

  110. 			</section>

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

  112. 				<h3>Hierarchy</h3>

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

  114. 					<li>

  115. 						<span class="tsd-signature-type">Component</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span>

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

  117. 							<li>

  118. 								<span class="target">AgoraView</span>

  119. 							</li>

  120. 						</ul>

  121. 					</li>

  122. 				</ul>

  123. 			</section>

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

  125. 				<h2>Index</h2>

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

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

  128. 						<section class="tsd-index-section tsd-is-inherited">

  129. 							<h3>Constructors</h3>

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

  131. 								<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#constructor" class="tsd-kind-icon">constructor</a></li>

  132. 							</ul>

  133. 						</section>

  134. 						<section class="tsd-index-section tsd-is-inherited">

  135. 							<h3>Properties</h3>

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

  137. 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#context" class="tsd-kind-icon">context</a></li>

  138. 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#props" class="tsd-kind-icon">props</a></li>

  139. 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#refs" class="tsd-kind-icon">refs</a></li>

  140. 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#state" class="tsd-kind-icon">state</a></li>

  141. 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="agoraview.html#contexttype" class="tsd-kind-icon">context<wbr>Type</a></li>

  142. 							</ul>

  143. 						</section>

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

  145. 							<h3>Methods</h3>

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

  147. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#unsafe_componentwillmount" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Mount</a></li>

  148. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#unsafe_componentwillreceiveprops" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Receive<wbr>Props</a></li>

  149. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#unsafe_componentwillupdate" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Update</a></li>

  150. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentdidcatch" class="tsd-kind-icon">component<wbr>Did<wbr>Catch</a></li>

  151. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentdidmount" class="tsd-kind-icon">component<wbr>Did<wbr>Mount</a></li>

  152. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentdidupdate" class="tsd-kind-icon">component<wbr>Did<wbr>Update</a></li>

  153. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentwillmount" class="tsd-kind-icon">component<wbr>Will<wbr>Mount</a></li>

  154. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentwillreceiveprops" class="tsd-kind-icon">component<wbr>Will<wbr>Receive<wbr>Props</a></li>

  155. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentwillunmount" class="tsd-kind-icon">component<wbr>Will<wbr>Unmount</a></li>

  156. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#componentwillupdate" class="tsd-kind-icon">component<wbr>Will<wbr>Update</a></li>

  157. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#forceupdate" class="tsd-kind-icon">force<wbr>Update</a></li>

  158. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="agoraview.html#gethtmlprops" class="tsd-kind-icon">getHTMLProps</a></li>

  159. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#getsnapshotbeforeupdate" class="tsd-kind-icon">get<wbr>Snapshot<wbr>Before<wbr>Update</a></li>

  160. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="agoraview.html#render" class="tsd-kind-icon">render</a></li>

  161. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="agoraview.html#setstate" class="tsd-kind-icon">set<wbr>State</a></li>

  162. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agoraview.html#shouldcomponentupdate" class="tsd-kind-icon">should<wbr>Component<wbr>Update</a></li>

  163. 							</ul>

  164. 						</section>

  165. 					</div>

  166. 				</section>

  167. 			</section>

  168. 			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">

  169. 				<h2>Constructors</h2>

  170. 				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">

  171. 					<a name="constructor" class="tsd-anchor"></a>

  172. 					<h3>constructor</h3>

  173. 					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">

  174. 						<li class="tsd-signature tsd-kind-icon">new <wbr>Agora<wbr>View<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="agoraview.html" class="tsd-signature-type">AgoraView</a></li>

  175. 						<li class="tsd-signature tsd-kind-icon">new <wbr>Agora<wbr>View<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a>, context<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="agoraview.html" class="tsd-signature-type">AgoraView</a></li>

  176. 					</ul>

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

  178. 						<li class="tsd-description">

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

  180. 								<p>Inherited from Component.__constructor</p>

  181. 								<ul>

  182. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:434</li>

  183. 								</ul>

  184. 							</aside>

  185. 							<h4 class="tsd-parameters-title">Parameters</h4>

  186. 							<ul class="tsd-parameters">

  187. 								<li>

  188. 									<h5>props: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span></h5>

  189. 								</li>

  190. 							</ul>

  191. 							<h4 class="tsd-returns-title">Returns <a href="agoraview.html" class="tsd-signature-type">AgoraView</a></h4>

  192. 						</li>

  193. 						<li class="tsd-description">

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

  195. 								<p>Inherited from Component.__constructor</p>

  196. 								<ul>

  197. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:436</li>

  198. 								</ul>

  199. 							</aside>

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

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

  202. 									<dt>deprecated</dt>

  203. 									<dd></dd>

  204. 									<dt>see</dt>

  205. 									<dd><p><a href="https://reactjs.org/docs/legacy-context.html">https://reactjs.org/docs/legacy-context.html</a></p>

  206. 									</dd>

  207. 								</dl>

  208. 							</div>

  209. 							<h4 class="tsd-parameters-title">Parameters</h4>

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

  211. 								<li>

  212. 									<h5>props: <a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a></h5>

  213. 								</li>

  214. 								<li>

  215. 									<h5><span class="tsd-flag ts-flagOptional">Optional</span> context: <span class="tsd-signature-type">any</span></h5>

  216. 								</li>

  217. 							</ul>

  218. 							<h4 class="tsd-returns-title">Returns <a href="agoraview.html" class="tsd-signature-type">AgoraView</a></h4>

  219. 						</li>

  220. 					</ul>

  221. 				</section>

  222. 			</section>

  223. 			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">

  224. 				<h2>Properties</h2>

  225. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">

  226. 					<a name="context" class="tsd-anchor"></a>

  227. 					<h3>context</h3>

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

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

  230. 						<p>Inherited from Component.context</p>

  231. 						<ul>

  232. 							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:434</li>

  233. 						</ul>

  234. 					</aside>

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

  236. 						<div class="lead">

  237. 							<p>If using the new style context, re-declare this in your class to be the

  238. 							<code>React.ContextType</code> of your <code>static contextType</code>.</p>

  239. 						</div>

  240. 						<pre><code class="language-ts"><span class="hljs-keyword">static</span> contextType = MyContext

  241. context!: React.ContextType&lt;<span class="hljs-keyword">typeof</span> MyContext&gt;</code></pre>

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

  243. 							<dt>deprecated</dt>

  244. 							<dd><p>if used without a type annotation, or without static contextType</p>

  245. 							</dd>

  246. 							<dt>see</dt>

  247. 							<dd><p><a href="https://reactjs.org/docs/legacy-context.html">https://reactjs.org/docs/legacy-context.html</a></p>

  248. 							</dd>

  249. 						</dl>

  250. 					</div>

  251. 				</section>

  252. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">

  253. 					<a name="props" class="tsd-anchor"></a>

  254. 					<h3>props</h3>

  255. 					<div class="tsd-signature tsd-kind-icon">props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></div>

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

  257. 						<p>Inherited from Component.props</p>

  258. 						<ul>

  259. 							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:459</li>

  260. 						</ul>

  261. 					</aside>

  262. 				</section>

  263. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">

  264. 					<a name="refs" class="tsd-anchor"></a>

  265. 					<h3>refs</h3>

  266. 					<div class="tsd-signature tsd-kind-icon">refs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>

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

  268. 						<p>Inherited from Component.refs</p>

  269. 						<ul>

  270. 							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:465</li>

  271. 						</ul>

  272. 					</aside>

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

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

  275. 							<dt>deprecated</dt>

  276. 							<dd><p><a href="https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs">https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</a></p>

  277. 							</dd>

  278. 						</dl>

  279. 					</div>

  280. 					<div class="tsd-type-declaration">

  281. 						<h4>Type declaration</h4>

  282. 						<ul class="tsd-parameters">

  283. 							<li class="tsd-parameter-index-signature">

  284. 								<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">ReactInstance</span></h5>

  285. 							</li>

  286. 						</ul>

  287. 					</div>

  288. 				</section>

  289. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">

  290. 					<a name="state" class="tsd-anchor"></a>

  291. 					<h3>state</h3>

  292. 					<div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span></div>

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

  294. 						<p>Inherited from Component.state</p>

  295. 						<ul>

  296. 							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:460</li>

  297. 						</ul>

  298. 					</aside>

  299. 				</section>

  300. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static">

  301. 					<a name="contexttype" class="tsd-anchor"></a>

  302. 					<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> context<wbr>Type</h3>

  303. 					<div class="tsd-signature tsd-kind-icon">context<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Context</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div>

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

  305. 						<p>Inherited from Component.contextType</p>

  306. 						<ul>

  307. 							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:419</li>

  308. 						</ul>

  309. 					</aside>

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

  311. 						<div class="lead">

  312. 							<p>If set, <code>this.context</code> will be set at runtime to the current value of the given Context.</p>

  313. 						</div>

  314. 						<p>Usage:</p>

  315. 						<pre><code class="language-ts">type MyContext = number

  316. const Ctx = React.createContext&lt;MyContext&gt;(0)

  317. 

  318. class Foo extends React.Component {

  319.   static contextType = Ctx

  320.   context!: React.ContextType&lt;typeof Ctx&gt;

  321.   render () {

  322.     return &lt;&gt;My context's value: {this.context}&lt;/&gt;;

  323.   }

  324. }</code></pre>

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

  326. 							<dt>see</dt>

  327. 							<dd><p><a href="https://reactjs.org/docs/context.html#classcontexttype">https://reactjs.org/docs/context.html#classcontexttype</a></p>

  328. 							</dd>

  329. 						</dl>

  330. 					</div>

  331. 				</section>

  332. 			</section>

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

  334. 				<h2>Methods</h2>

  335. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  336. 					<a name="unsafe_componentwillmount" class="tsd-anchor"></a>

  337. 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component<wbr>Will<wbr>Mount</h3>

  338. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  339. 						<li class="tsd-signature tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Mount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>

  340. 					</ul>

  341. 					<ul class="tsd-descriptions">

  342. 						<li class="tsd-description">

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

  344. 								<p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount</p>

  345. 								<ul>

  346. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:647</li>

  347. 								</ul>

  348. 							</aside>

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

  350. 								<div class="lead">

  351. 									<p>Called immediately before mounting occurs, and before <code>Component#render</code>.

  352. 									Avoid introducing any side-effects or subscriptions in this method.</p>

  353. 								</div>

  354. 								<p>This method will not stop working in React 17.</p>

  355. 								<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps

  356. 								prevents this from being invoked.</p>

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

  358. 									<dt>deprecated</dt>

  359. 									<dd><p>16.3, use componentDidMount or the constructor instead</p>

  360. 									</dd>

  361. 									<dt>see</dt>

  362. 									<dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</a></p>

  363. 									</dd>

  364. 									<dt>see</dt>

  365. 									<dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p>

  366. 									</dd>

  367. 								</dl>

  368. 							</div>

  369. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>

  370. 						</li>

  371. 					</ul>

  372. 				</section>

  373. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  374. 					<a name="unsafe_componentwillreceiveprops" class="tsd-anchor"></a>

  375. 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component<wbr>Will<wbr>Receive<wbr>Props</h3>

  376. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  377. 						<li class="tsd-signature tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Receive<wbr>Props<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>

  378. 					</ul>

  379. 					<ul class="tsd-descriptions">

  380. 						<li class="tsd-description">

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

  382. 								<p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps</p>

  383. 								<ul>

  384. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:679</li>

  385. 								</ul>

  386. 							</aside>

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

  388. 								<div class="lead">

  389. 									<p>Called when the component may be receiving new props.

  390. 										React may call this even if props have not changed, so be sure to compare new and existing

  391. 									props if you only want to handle changes.</p>

  392. 								</div>

  393. 								<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>

  394. 								<p>This method will not stop working in React 17.</p>

  395. 								<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps

  396. 								prevents this from being invoked.</p>

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

  398. 									<dt>deprecated</dt>

  399. 									<dd><p>16.3, use static getDerivedStateFromProps instead</p>

  400. 									</dd>

  401. 									<dt>see</dt>

  402. 									<dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</a></p>

  403. 									</dd>

  404. 									<dt>see</dt>

  405. 									<dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p>

  406. 									</dd>

  407. 								</dl>

  408. 							</div>

  409. 							<h4 class="tsd-parameters-title">Parameters</h4>

  410. 							<ul class="tsd-parameters">

  411. 								<li>

  412. 									<h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span></h5>

  413. 								</li>

  414. 								<li>

  415. 									<h5>nextContext: <span class="tsd-signature-type">any</span></h5>

  416. 								</li>

  417. 							</ul>

  418. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>

  419. 						</li>

  420. 					</ul>

  421. 				</section>

  422. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  423. 					<a name="unsafe_componentwillupdate" class="tsd-anchor"></a>

  424. 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component<wbr>Will<wbr>Update</h3>

  425. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  426. 						<li class="tsd-signature tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Update<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span>, nextState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>

  427. 					</ul>

  428. 					<ul class="tsd-descriptions">

  429. 						<li class="tsd-description">

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

  431. 								<p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate</p>

  432. 								<ul>

  433. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:707</li>

  434. 								</ul>

  435. 							</aside>

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

  437. 								<div class="lead">

  438. 									<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>

  439. 								</div>

  440. 								<p>Note: You cannot call <code>Component#setState</code> here.</p>

  441. 								<p>This method will not stop working in React 17.</p>

  442. 								<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps

  443. 								prevents this from being invoked.</p>

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

  445. 									<dt>deprecated</dt>

  446. 									<dd><p>16.3, use getSnapshotBeforeUpdate instead</p>

  447. 									</dd>

  448. 									<dt>see</dt>

  449. 									<dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</a></p>

  450. 									</dd>

  451. 									<dt>see</dt>

  452. 									<dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p>

  453. 									</dd>

  454. 								</dl>

  455. 							</div>

  456. 							<h4 class="tsd-parameters-title">Parameters</h4>

  457. 							<ul class="tsd-parameters">

  458. 								<li>

  459. 									<h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span></h5>

  460. 								</li>

  461. 								<li>

  462. 									<h5>nextState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span></h5>

  463. 								</li>

  464. 								<li>

  465. 									<h5>nextContext: <span class="tsd-signature-type">any</span></h5>

  466. 								</li>

  467. 							</ul>

  468. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>

  469. 						</li>

  470. 					</ul>

  471. 				</section>

  472. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  473. 					<a name="componentdidcatch" class="tsd-anchor"></a>

  474. 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Did<wbr>Catch</h3>

  475. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  476. 						<li class="tsd-signature tsd-kind-icon">component<wbr>Did<wbr>Catch<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, errorInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ErrorInfo</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>

  477. 					</ul>

  478. 					<ul class="tsd-descriptions">

  479. 						<li class="tsd-description">

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

  481. 								<p>Inherited from ComponentLifecycle.componentDidCatch</p>

  482. 								<ul>

  483. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:576</li>

  484. 								</ul>

  485. 							</aside>

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

  487. 								<div class="lead">

  488. 									<p>Catches exceptions generated in descendant components. Unhandled exceptions will cause

  489. 									the entire component tree to unmount.</p>

  490. 								</div>

  491. 							</div>

  492. 							<h4 class="tsd-parameters-title">Parameters</h4>

  493. 							<ul class="tsd-parameters">

  494. 								<li>

  495. 									<h5>error: <span class="tsd-signature-type">Error</span></h5>

  496. 								</li>

  497. 								<li>

  498. 									<h5>errorInfo: <span class="tsd-signature-type">ErrorInfo</span></h5>

  499. 								</li>

  500. 							</ul>

  501. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>

  502. 						</li>

  503. 					</ul>

  504. 				</section>

  505. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  506. 					<a name="componentdidmount" class="tsd-anchor"></a>

  507. 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Did<wbr>Mount</h3>

  508. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  509. 						<li class="tsd-signature tsd-kind-icon">component<wbr>Did<wbr>Mount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>

  510. 					</ul>

  511. 					<ul class="tsd-descriptions">

  512. 						<li class="tsd-description">

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

  514. 								<p>Inherited from ComponentLifecycle.componentDidMount</p>

  515. 								<ul>

  516. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:555</li>

  517. 								</ul>

  518. 							</aside>

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

  520. 								<div class="lead">

  521. 									<p>Called immediately after a component is mounted. Setting state here will trigger re-rendering.</p>

  522. 								</div>

  523. 							</div>

  524. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>

  525. 						</li>

  526. 					</ul>

  527. 				</section>

  528. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  529. 					<a name="componentdidupdate" class="tsd-anchor"></a>

  530. 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Did<wbr>Update</h3>

  531. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  532. 						<li class="tsd-signature tsd-kind-icon">component<wbr>Did<wbr>Update<span class="tsd-signature-symbol">(</span>prevProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span>, prevState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span>, snapshot<span class="tsd-signature-symbol">?: </span><a href="" class="tsd-signature-type">SS</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>

  533. 					</ul>

  534. 					<ul class="tsd-descriptions">

  535. 						<li class="tsd-description">

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

  537. 								<p>Inherited from NewLifecycle.componentDidUpdate</p>

  538. 								<ul>

  539. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:618</li>

  540. 								</ul>

  541. 							</aside>

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

  543. 								<div class="lead">

  544. 									<p>Called immediately after updating occurs. Not called for the initial render.</p>

  545. 								</div>

  546. 								<p>The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.</p>

  547. 							</div>

  548. 							<h4 class="tsd-parameters-title">Parameters</h4>

  549. 							<ul class="tsd-parameters">

  550. 								<li>

  551. 									<h5>prevProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span></h5>

  552. 								</li>

  553. 								<li>

  554. 									<h5>prevState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span></h5>

  555. 								</li>

  556. 								<li>

  557. 									<h5><span class="tsd-flag ts-flagOptional">Optional</span> snapshot: <a href="" class="tsd-signature-type">SS</a></h5>

  558. 								</li>

  559. 							</ul>

  560. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>

  561. 						</li>

  562. 					</ul>

  563. 				</section>

  564. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  565. 					<a name="componentwillmount" class="tsd-anchor"></a>

  566. 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Mount</h3>

  567. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  568. 						<li class="tsd-signature tsd-kind-icon">component<wbr>Will<wbr>Mount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>

  569. 					</ul>

  570. 					<ul class="tsd-descriptions">

  571. 						<li class="tsd-description">

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

  573. 								<p>Inherited from DeprecatedLifecycle.componentWillMount</p>

  574. 								<ul>

  575. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:633</li>

  576. 								</ul>

  577. 							</aside>

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

  579. 								<div class="lead">

  580. 									<p>Called immediately before mounting occurs, and before <code>Component#render</code>.

  581. 									Avoid introducing any side-effects or subscriptions in this method.</p>

  582. 								</div>

  583. 								<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps

  584. 								prevents this from being invoked.</p>

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

  586. 									<dt>deprecated</dt>

  587. 									<dd><p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>

  588. 									</dd>

  589. 									<dt>see</dt>

  590. 									<dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</a></p>

  591. 									</dd>

  592. 									<dt>see</dt>

  593. 									<dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p>

  594. 									</dd>

  595. 								</dl>

  596. 							</div>

  597. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>

  598. 						</li>

  599. 					</ul>

  600. 				</section>

  601. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  602. 					<a name="componentwillreceiveprops" class="tsd-anchor"></a>

  603. 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Receive<wbr>Props</h3>

  604. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  605. 						<li class="tsd-signature tsd-kind-icon">component<wbr>Will<wbr>Receive<wbr>Props<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>

  606. 					</ul>

  607. 					<ul class="tsd-descriptions">

  608. 						<li class="tsd-description">

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

  610. 								<p>Inherited from DeprecatedLifecycle.componentWillReceiveProps</p>

  611. 								<ul>

  612. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:662</li>

  613. 								</ul>

  614. 							</aside>

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

  616. 								<div class="lead">

  617. 									<p>Called when the component may be receiving new props.

  618. 										React may call this even if props have not changed, so be sure to compare new and existing

  619. 									props if you only want to handle changes.</p>

  620. 								</div>

  621. 								<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>

  622. 								<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps

  623. 								prevents this from being invoked.</p>

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

  625. 									<dt>deprecated</dt>

  626. 									<dd><p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>

  627. 									</dd>

  628. 									<dt>see</dt>

  629. 									<dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</a></p>

  630. 									</dd>

  631. 									<dt>see</dt>

  632. 									<dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p>

  633. 									</dd>

  634. 								</dl>

  635. 							</div>

  636. 							<h4 class="tsd-parameters-title">Parameters</h4>

  637. 							<ul class="tsd-parameters">

  638. 								<li>

  639. 									<h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span></h5>

  640. 								</li>

  641. 								<li>

  642. 									<h5>nextContext: <span class="tsd-signature-type">any</span></h5>

  643. 								</li>

  644. 							</ul>

  645. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>

  646. 						</li>

  647. 					</ul>

  648. 				</section>

  649. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  650. 					<a name="componentwillunmount" class="tsd-anchor"></a>

  651. 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Unmount</h3>

  652. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  653. 						<li class="tsd-signature tsd-kind-icon">component<wbr>Will<wbr>Unmount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>

  654. 					</ul>

  655. 					<ul class="tsd-descriptions">

  656. 						<li class="tsd-description">

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

  658. 								<p>Inherited from ComponentLifecycle.componentWillUnmount</p>

  659. 								<ul>

  660. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:571</li>

  661. 								</ul>

  662. 							</aside>

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

  664. 								<div class="lead">

  665. 									<p>Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as

  666. 									cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p>

  667. 								</div>

  668. 							</div>

  669. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>

  670. 						</li>

  671. 					</ul>

  672. 				</section>

  673. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  674. 					<a name="componentwillupdate" class="tsd-anchor"></a>

  675. 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Update</h3>

  676. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  677. 						<li class="tsd-signature tsd-kind-icon">component<wbr>Will<wbr>Update<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span>, nextState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>

  678. 					</ul>

  679. 					<ul class="tsd-descriptions">

  680. 						<li class="tsd-description">

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

  682. 								<p>Inherited from DeprecatedLifecycle.componentWillUpdate</p>

  683. 								<ul>

  684. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:692</li>

  685. 								</ul>

  686. 							</aside>

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

  688. 								<div class="lead">

  689. 									<p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>

  690. 								</div>

  691. 								<p>Note: You cannot call <code>Component#setState</code> here.</p>

  692. 								<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps

  693. 								prevents this from being invoked.</p>

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

  695. 									<dt>deprecated</dt>

  696. 									<dd><p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>

  697. 									</dd>

  698. 									<dt>see</dt>

  699. 									<dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</a></p>

  700. 									</dd>

  701. 									<dt>see</dt>

  702. 									<dd><p><a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></p>

  703. 									</dd>

  704. 								</dl>

  705. 							</div>

  706. 							<h4 class="tsd-parameters-title">Parameters</h4>

  707. 							<ul class="tsd-parameters">

  708. 								<li>

  709. 									<h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span></h5>

  710. 								</li>

  711. 								<li>

  712. 									<h5>nextState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span></h5>

  713. 								</li>

  714. 								<li>

  715. 									<h5>nextContext: <span class="tsd-signature-type">any</span></h5>

  716. 								</li>

  717. 							</ul>

  718. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>

  719. 						</li>

  720. 					</ul>

  721. 				</section>

  722. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  723. 					<a name="forceupdate" class="tsd-anchor"></a>

  724. 					<h3>force<wbr>Update</h3>

  725. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  726. 						<li class="tsd-signature tsd-kind-icon">force<wbr>Update<span class="tsd-signature-symbol">(</span>callBack<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>

  727. 					</ul>

  728. 					<ul class="tsd-descriptions">

  729. 						<li class="tsd-description">

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

  731. 								<p>Inherited from Component.forceUpdate</p>

  732. 								<ul>

  733. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:451</li>

  734. 								</ul>

  735. 							</aside>

  736. 							<h4 class="tsd-parameters-title">Parameters</h4>

  737. 							<ul class="tsd-parameters">

  738. 								<li>

  739. 									<h5><span class="tsd-flag ts-flagOptional">Optional</span> callBack: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></h5>

  740. 								</li>

  741. 							</ul>

  742. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>

  743. 						</li>

  744. 					</ul>

  745. 				</section>

  746. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">

  747. 					<a name="gethtmlprops" class="tsd-anchor"></a>

  748. 					<h3><span class="tsd-flag ts-flagPrivate">Private</span> getHTMLProps</h3>

  749. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">

  750. 						<li class="tsd-signature tsd-kind-icon">getHTMLProps<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a></li>

  751. 					</ul>

  752. 					<ul class="tsd-descriptions">

  753. 						<li class="tsd-description">

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

  755. 								<ul>

  756. 									<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/AgoraView.native.tsx#L48">AgoraView.native.tsx:48</a></li>

  757. 								</ul>

  758. 							</aside>

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

  760. 								<div class="lead">

  761. 									<p>getHTMLProps</p>

  762. 								</div>

  763. 								<p>get agora view props</p>

  764. 							</div>

  765. 							<h4 class="tsd-returns-title">Returns <a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a></h4>

  766. 						</li>

  767. 					</ul>

  768. 				</section>

  769. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  770. 					<a name="getsnapshotbeforeupdate" class="tsd-anchor"></a>

  771. 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> get<wbr>Snapshot<wbr>Before<wbr>Update</h3>

  772. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  773. 						<li class="tsd-signature tsd-kind-icon">get<wbr>Snapshot<wbr>Before<wbr>Update<span class="tsd-signature-symbol">(</span>prevProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span>, prevState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SS</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li>

  774. 					</ul>

  775. 					<ul class="tsd-descriptions">

  776. 						<li class="tsd-description">

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

  778. 								<p>Inherited from NewLifecycle.getSnapshotBeforeUpdate</p>

  779. 								<ul>

  780. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:612</li>

  781. 								</ul>

  782. 							</aside>

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

  784. 								<div class="lead">

  785. 									<p>Runs before React applies the result of <code>render</code> to the document, and

  786. 										returns an object to be given to componentDidUpdate. Useful for saving

  787. 									things such as scroll position before <code>render</code> causes changes to it.</p>

  788. 								</div>

  789. 								<p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated

  790. 								lifecycle events from running.</p>

  791. 							</div>

  792. 							<h4 class="tsd-parameters-title">Parameters</h4>

  793. 							<ul class="tsd-parameters">

  794. 								<li>

  795. 									<h5>prevProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span></h5>

  796. 								</li>

  797. 								<li>

  798. 									<h5>prevState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span></h5>

  799. 								</li>

  800. 							</ul>

  801. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SS</span>

  802. 								<span class="tsd-signature-symbol"> | </span>

  803. 								<span class="tsd-signature-type">null</span>

  804. 							</h4>

  805. 						</li>

  806. 					</ul>

  807. 				</section>

  808. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">

  809. 					<a name="render" class="tsd-anchor"></a>

  810. 					<h3>render</h3>

  811. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">

  812. 						<li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span></li>

  813. 					</ul>

  814. 					<ul class="tsd-descriptions">

  815. 						<li class="tsd-description">

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

  817. 								<p>Overrides Component.render</p>

  818. 								<ul>

  819. 									<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/AgoraView.native.tsx#L37">AgoraView.native.tsx:37</a></li>

  820. 								</ul>

  821. 							</aside>

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

  823. 								<div class="lead">

  824. 									<p>render</p>

  825. 								</div>

  826. 								<p>It would render view for VideoStream</p>

  827. 							</div>

  828. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4>

  829. 						</li>

  830. 					</ul>

  831. 				</section>

  832. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">

  833. 					<a name="setstate" class="tsd-anchor"></a>

  834. 					<h3>set<wbr>State</h3>

  835. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">

  836. 						<li class="tsd-signature tsd-kind-icon">set<wbr>State&lt;K&gt;<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>

  837. 					</ul>

  838. 					<ul class="tsd-descriptions">

  839. 						<li class="tsd-description">

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

  841. 								<p>Inherited from Component.setState</p>

  842. 								<ul>

  843. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:446</li>

  844. 								</ul>

  845. 							</aside>

  846. 							<h4 class="tsd-type-parameters-title">Type parameters</h4>

  847. 							<ul class="tsd-type-parameters">

  848. 								<li>

  849. 									<h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">keyof S</span></h4>

  850. 								</li>

  851. 							</ul>

  852. 							<h4 class="tsd-parameters-title">Parameters</h4>

  853. 							<ul class="tsd-parameters">

  854. 								<li>

  855. 									<h5>state: <span class="tsd-signature-type">function</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></h5>

  856. 								</li>

  857. 								<li>

  858. 									<h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></h5>

  859. 								</li>

  860. 							</ul>

  861. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>

  862. 						</li>

  863. 					</ul>

  864. 				</section>

  865. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  866. 					<a name="shouldcomponentupdate" class="tsd-anchor"></a>

  867. 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> should<wbr>Component<wbr>Update</h3>

  868. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  869. 						<li class="tsd-signature tsd-kind-icon">should<wbr>Component<wbr>Update<span class="tsd-signature-symbol">(</span>nextProps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span>, nextState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span>, nextContext<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>

  870. 					</ul>

  871. 					<ul class="tsd-descriptions">

  872. 						<li class="tsd-description">

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

  874. 								<p>Inherited from ComponentLifecycle.shouldComponentUpdate</p>

  875. 								<ul>

  876. 									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:566</li>

  877. 								</ul>

  878. 							</aside>

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

  880. 								<div class="lead">

  881. 									<p>Called to determine whether the change in props and state should trigger a re-render.</p>

  882. 								</div>

  883. 								<p><code>Component</code> always returns true.

  884. 									<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any

  885. 								props or states have changed.</p>

  886. 								<p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code>

  887. 								and <code>componentDidUpdate</code> will not be called.</p>

  888. 							</div>

  889. 							<h4 class="tsd-parameters-title">Parameters</h4>

  890. 							<ul class="tsd-parameters">

  891. 								<li>

  892. 									<h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a><span class="tsd-signature-symbol">&gt;</span></h5>

  893. 								</li>

  894. 								<li>

  895. 									<h5>nextState: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">S</span><span class="tsd-signature-symbol">&gt;</span></h5>

  896. 								</li>

  897. 								<li>

  898. 									<h5>nextContext: <span class="tsd-signature-type">any</span></h5>

  899. 								</li>

  900. 							</ul>

  901. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>

  902. 						</li>

  903. 					</ul>

  904. 				</section>

  905. 			</section>

  906. 		</div>

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

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

  909. 				<ul>

  910. 					<li class="globals  ">

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

  912. 					</li>

  913. 				</ul>

  914. 			</nav>

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

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

  917. 				</ul>

  918. 				<ul class="current">

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

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

  921. 						<ul>

  922. 							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">

  923. 								<a href="agoraview.html#constructor" class="tsd-kind-icon">constructor</a>

  924. 							</li>

  925. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">

  926. 								<a href="agoraview.html#context" class="tsd-kind-icon">context</a>

  927. 							</li>

  928. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">

  929. 								<a href="agoraview.html#props" class="tsd-kind-icon">props</a>

  930. 							</li>

  931. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">

  932. 								<a href="agoraview.html#refs" class="tsd-kind-icon">refs</a>

  933. 							</li>

  934. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">

  935. 								<a href="agoraview.html#state" class="tsd-kind-icon">state</a>

  936. 							</li>

  937. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static">

  938. 								<a href="agoraview.html#contexttype" class="tsd-kind-icon">context<wbr>Type</a>

  939. 							</li>

  940. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  941. 								<a href="agoraview.html#unsafe_componentwillmount" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Mount</a>

  942. 							</li>

  943. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  944. 								<a href="agoraview.html#unsafe_componentwillreceiveprops" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Receive<wbr>Props</a>

  945. 							</li>

  946. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  947. 								<a href="agoraview.html#unsafe_componentwillupdate" class="tsd-kind-icon">UNSAFE_<wbr>component<wbr>Will<wbr>Update</a>

  948. 							</li>

  949. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  950. 								<a href="agoraview.html#componentdidcatch" class="tsd-kind-icon">component<wbr>Did<wbr>Catch</a>

  951. 							</li>

  952. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  953. 								<a href="agoraview.html#componentdidmount" class="tsd-kind-icon">component<wbr>Did<wbr>Mount</a>

  954. 							</li>

  955. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  956. 								<a href="agoraview.html#componentdidupdate" class="tsd-kind-icon">component<wbr>Did<wbr>Update</a>

  957. 							</li>

  958. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  959. 								<a href="agoraview.html#componentwillmount" class="tsd-kind-icon">component<wbr>Will<wbr>Mount</a>

  960. 							</li>

  961. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  962. 								<a href="agoraview.html#componentwillreceiveprops" class="tsd-kind-icon">component<wbr>Will<wbr>Receive<wbr>Props</a>

  963. 							</li>

  964. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  965. 								<a href="agoraview.html#componentwillunmount" class="tsd-kind-icon">component<wbr>Will<wbr>Unmount</a>

  966. 							</li>

  967. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  968. 								<a href="agoraview.html#componentwillupdate" class="tsd-kind-icon">component<wbr>Will<wbr>Update</a>

  969. 							</li>

  970. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  971. 								<a href="agoraview.html#forceupdate" class="tsd-kind-icon">force<wbr>Update</a>

  972. 							</li>

  973. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">

  974. 								<a href="agoraview.html#gethtmlprops" class="tsd-kind-icon">getHTMLProps</a>

  975. 							</li>

  976. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  977. 								<a href="agoraview.html#getsnapshotbeforeupdate" class="tsd-kind-icon">get<wbr>Snapshot<wbr>Before<wbr>Update</a>

  978. 							</li>

  979. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">

  980. 								<a href="agoraview.html#render" class="tsd-kind-icon">render</a>

  981. 							</li>

  982. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">

  983. 								<a href="agoraview.html#setstate" class="tsd-kind-icon">set<wbr>State</a>

  984. 							</li>

  985. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">

  986. 								<a href="agoraview.html#shouldcomponentupdate" class="tsd-kind-icon">should<wbr>Component<wbr>Update</a>

  987. 							</li>

  988. 						</ul>

  989. 					</li>

  990. 				</ul>

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

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

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

  994. 					</li>

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

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

  997. 					</li>

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

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

  1000. 					</li>

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

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

  1003. 					</li>

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

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

  1006. 					</li>

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

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

  1009. 					</li>

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

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

  1012. 					</li>

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

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

  1015. 					</li>

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

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

  1018. 					</li>

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

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

  1021. 					</li>

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

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

  1024. 					</li>

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

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

  1027. 					</li>

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

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

  1030. 					</li>

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

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

  1033. 					</li>

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

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

  1036. 					</li>

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

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

  1039. 					</li>

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

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

  1042. 					</li>

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

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

  1045. 					</li>

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

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

  1048. 					</li>

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

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

  1051. 					</li>

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

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

  1054. 					</li>

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

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

  1057. 					</li>

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

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

  1060. 					</li>

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

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

  1063. 					</li>

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

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

  1066. 					</li>

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

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

  1069. 					</li>

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

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

  1072. 					</li>

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

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

  1075. 					</li>

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

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

  1078. 					</li>

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

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

  1081. 					</li>

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

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

  1084. 					</li>

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

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

  1087. 					</li>

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

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

  1090. 					</li>

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

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

  1093. 					</li>

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

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

  1096. 					</li>

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

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

  1099. 					</li>

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

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

  1102. 					</li>

  1103. 				</ul>

  1104. 			</nav>

  1105. 		</div>

  1106. 	</div>

  1107. </div>

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

  1109. 	<div class="container">

  1110. 		<h2>Legend</h2>

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

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

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

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

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

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

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

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

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

  1120. 			</ul>

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

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

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

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

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

  1126. 			</ul>

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

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

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

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

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

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

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

  1134. 			</ul>

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

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

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

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

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

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

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

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

  1143. 			</ul>

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

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

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

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

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

  1149. 			</ul>

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

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

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

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

  1154. 			</ul>

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

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

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

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

  1159. 			</ul>

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

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

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

  1163. 			</ul>

  1164. 		</div>

  1165. 	</div>

  1166. </footer>

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

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

  1169. </div>

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

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

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

  1173. </body>

  1174. </html>