Browse Source

chore. update docs

matrixbirds 5 years ago
parent
commit
6182ea47c4
34 changed files with 13584 additions and 891 deletions
  1. 1
    1
      docs/api/assets/js/search.js
  2. 160
    46
      docs/api/classes/agoraview.html
  3. 621
    554
      docs/api/classes/rtcengine.html
  4. 213
    4
      docs/api/globals.html
  5. 104
    286
      docs/api/index.html
  6. 2534
    0
      docs/api/interfaces/agoraviewprops.html
  7. 350
    0
      docs/api/interfaces/audioframeoption.html
  8. 350
    0
      docs/api/interfaces/audiomixingoption.html
  9. 322
    0
      docs/api/interfaces/audiorecordingoption.html
  10. 364
    0
      docs/api/interfaces/backgroundimage.html
  11. 371
    0
      docs/api/interfaces/beautyoption.html
  12. 320
    0
      docs/api/interfaces/cameracapturerconfiguration.html
  13. 350
    0
      docs/api/interfaces/color.html
  14. 336
    0
      docs/api/interfaces/datastreamoption.html
  15. 308
    0
      docs/api/interfaces/defaultvideostreamoption.html
  16. 364
    0
      docs/api/interfaces/imageoption.html
  17. 356
    0
      docs/api/interfaces/injectstreamoption.html
  18. 371
    0
      docs/api/interfaces/lastmileprobeconfig.html
  19. 490
    0
      docs/api/interfaces/livetranscodingoption.html
  20. 322
    0
      docs/api/interfaces/mixedaudioframeoption.html
  21. 467
    0
      docs/api/interfaces/option.html
  22. 392
    0
      docs/api/interfaces/playeffectoption.html
  23. 322
    0
      docs/api/interfaces/positionoption.html
  24. 434
    0
      docs/api/interfaces/publisherconfig.html
  25. 322
    0
      docs/api/interfaces/publishstreamoption.html
  26. 350
    0
      docs/api/interfaces/rect.html
  27. 308
    0
      docs/api/interfaces/removeinjectstreamoption.html
  28. 308
    0
      docs/api/interfaces/removepublishstreamoption.html
  29. 322
    0
      docs/api/interfaces/size.html
  30. 364
    0
      docs/api/interfaces/transcodinguser.html
  31. 391
    0
      docs/api/interfaces/videoencoderconfig.html
  32. 336
    0
      docs/api/interfaces/videooption.html
  33. 322
    0
      docs/api/interfaces/videostreamoption.html
  34. 339
    0
      docs/api/interfaces/voicedecorator.html

+ 1
- 1
docs/api/assets/js/search.js
File diff suppressed because it is too large
View File


+ 160
- 46
docs/api/classes/agoraview.html View File

74
 					<p>This class is used to rendering native sdk stream</p>
74
 					<p>This class is used to rendering native sdk stream</p>
75
 					<dl class="tsd-comment-tags">
75
 					<dl class="tsd-comment-tags">
76
 						<dt>props</dt>
76
 						<dt>props</dt>
77
-						<dd><p>{@link AgoraViewProps}</p>
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>
78
 						</dd>
93
 						</dd>
79
 					</dl>
94
 					</dl>
80
 				</div>
95
 				</div>
97
 				<h3>Hierarchy</h3>
112
 				<h3>Hierarchy</h3>
98
 				<ul class="tsd-hierarchy">
113
 				<ul class="tsd-hierarchy">
99
 					<li>
114
 					<li>
100
-						<span class="tsd-signature-type">Component</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">&gt;</span>
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>
101
 						<ul class="tsd-hierarchy">
116
 						<ul class="tsd-hierarchy">
102
 							<li>
117
 							<li>
103
 								<span class="target">AgoraView</span>
118
 								<span class="target">AgoraView</span>
156
 					<a name="constructor" class="tsd-anchor"></a>
171
 					<a name="constructor" class="tsd-anchor"></a>
157
 					<h3>constructor</h3>
172
 					<h3>constructor</h3>
158
 					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
173
 					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
159
-						<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><span class="tsd-signature-type">AgoraViewProps</span><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>
160
-						<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">AgoraViewProps</span>, 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>
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>
161
 					</ul>
176
 					</ul>
162
 					<ul class="tsd-descriptions">
177
 					<ul class="tsd-descriptions">
163
 						<li class="tsd-description">
178
 						<li class="tsd-description">
164
 							<aside class="tsd-sources">
179
 							<aside class="tsd-sources">
165
 								<p>Inherited from Component.__constructor</p>
180
 								<p>Inherited from Component.__constructor</p>
166
 								<ul>
181
 								<ul>
167
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:405</li>
182
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:434</li>
168
 								</ul>
183
 								</ul>
169
 							</aside>
184
 							</aside>
170
 							<h4 class="tsd-parameters-title">Parameters</h4>
185
 							<h4 class="tsd-parameters-title">Parameters</h4>
171
 							<ul class="tsd-parameters">
186
 							<ul class="tsd-parameters">
172
 								<li>
187
 								<li>
173
-									<h5>props: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">&gt;</span></h5>
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>
174
 								</li>
189
 								</li>
175
 							</ul>
190
 							</ul>
176
 							<h4 class="tsd-returns-title">Returns <a href="agoraview.html" class="tsd-signature-type">AgoraView</a></h4>
191
 							<h4 class="tsd-returns-title">Returns <a href="agoraview.html" class="tsd-signature-type">AgoraView</a></h4>
179
 							<aside class="tsd-sources">
194
 							<aside class="tsd-sources">
180
 								<p>Inherited from Component.__constructor</p>
195
 								<p>Inherited from Component.__constructor</p>
181
 								<ul>
196
 								<ul>
182
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:407</li>
197
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:436</li>
183
 								</ul>
198
 								</ul>
184
 							</aside>
199
 							</aside>
185
 							<div class="tsd-comment tsd-typography">
200
 							<div class="tsd-comment tsd-typography">
194
 							<h4 class="tsd-parameters-title">Parameters</h4>
209
 							<h4 class="tsd-parameters-title">Parameters</h4>
195
 							<ul class="tsd-parameters">
210
 							<ul class="tsd-parameters">
196
 								<li>
211
 								<li>
197
-									<h5>props: <span class="tsd-signature-type">AgoraViewProps</span></h5>
212
+									<h5>props: <a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a></h5>
198
 								</li>
213
 								</li>
199
 								<li>
214
 								<li>
200
 									<h5><span class="tsd-flag ts-flagOptional">Optional</span> context: <span class="tsd-signature-type">any</span></h5>
215
 									<h5><span class="tsd-flag ts-flagOptional">Optional</span> context: <span class="tsd-signature-type">any</span></h5>
214
 					<aside class="tsd-sources">
229
 					<aside class="tsd-sources">
215
 						<p>Inherited from Component.context</p>
230
 						<p>Inherited from Component.context</p>
216
 						<ul>
231
 						<ul>
217
-							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:405</li>
232
+							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:434</li>
218
 						</ul>
233
 						</ul>
219
 					</aside>
234
 					</aside>
220
 					<div class="tsd-comment tsd-typography">
235
 					<div class="tsd-comment tsd-typography">
237
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
252
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
238
 					<a name="props" class="tsd-anchor"></a>
253
 					<a name="props" class="tsd-anchor"></a>
239
 					<h3>props</h3>
254
 					<h3>props</h3>
240
-					<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><span class="tsd-signature-type">AgoraViewProps</span><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>
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>
241
 					<aside class="tsd-sources">
256
 					<aside class="tsd-sources">
242
 						<p>Inherited from Component.props</p>
257
 						<p>Inherited from Component.props</p>
243
 						<ul>
258
 						<ul>
244
-							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:430</li>
259
+							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:459</li>
245
 						</ul>
260
 						</ul>
246
 					</aside>
261
 					</aside>
247
 				</section>
262
 				</section>
252
 					<aside class="tsd-sources">
267
 					<aside class="tsd-sources">
253
 						<p>Inherited from Component.refs</p>
268
 						<p>Inherited from Component.refs</p>
254
 						<ul>
269
 						<ul>
255
-							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:436</li>
270
+							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:465</li>
256
 						</ul>
271
 						</ul>
257
 					</aside>
272
 					</aside>
258
 					<div class="tsd-comment tsd-typography">
273
 					<div class="tsd-comment tsd-typography">
278
 					<aside class="tsd-sources">
293
 					<aside class="tsd-sources">
279
 						<p>Inherited from Component.state</p>
294
 						<p>Inherited from Component.state</p>
280
 						<ul>
295
 						<ul>
281
-							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:431</li>
296
+							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:460</li>
282
 						</ul>
297
 						</ul>
283
 					</aside>
298
 					</aside>
284
 				</section>
299
 				</section>
289
 					<aside class="tsd-sources">
304
 					<aside class="tsd-sources">
290
 						<p>Inherited from Component.contextType</p>
305
 						<p>Inherited from Component.contextType</p>
291
 						<ul>
306
 						<ul>
292
-							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:390</li>
307
+							<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:419</li>
293
 						</ul>
308
 						</ul>
294
 					</aside>
309
 					</aside>
295
 					<div class="tsd-comment tsd-typography">
310
 					<div class="tsd-comment tsd-typography">
328
 							<aside class="tsd-sources">
343
 							<aside class="tsd-sources">
329
 								<p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount</p>
344
 								<p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount</p>
330
 								<ul>
345
 								<ul>
331
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:618</li>
346
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:647</li>
332
 								</ul>
347
 								</ul>
333
 							</aside>
348
 							</aside>
334
 							<div class="tsd-comment tsd-typography">
349
 							<div class="tsd-comment tsd-typography">
359
 					<a name="unsafe_componentwillreceiveprops" class="tsd-anchor"></a>
374
 					<a name="unsafe_componentwillreceiveprops" class="tsd-anchor"></a>
360
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component<wbr>Will<wbr>Receive<wbr>Props</h3>
375
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component<wbr>Will<wbr>Receive<wbr>Props</h3>
361
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
376
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
362
-						<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><span class="tsd-signature-type">AgoraViewProps</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>
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>
363
 					</ul>
378
 					</ul>
364
 					<ul class="tsd-descriptions">
379
 					<ul class="tsd-descriptions">
365
 						<li class="tsd-description">
380
 						<li class="tsd-description">
366
 							<aside class="tsd-sources">
381
 							<aside class="tsd-sources">
367
 								<p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps</p>
382
 								<p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps</p>
368
 								<ul>
383
 								<ul>
369
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:650</li>
384
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:679</li>
370
 								</ul>
385
 								</ul>
371
 							</aside>
386
 							</aside>
372
 							<div class="tsd-comment tsd-typography">
387
 							<div class="tsd-comment tsd-typography">
394
 							<h4 class="tsd-parameters-title">Parameters</h4>
409
 							<h4 class="tsd-parameters-title">Parameters</h4>
395
 							<ul class="tsd-parameters">
410
 							<ul class="tsd-parameters">
396
 								<li>
411
 								<li>
397
-									<h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">&gt;</span></h5>
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>
398
 								</li>
413
 								</li>
399
 								<li>
414
 								<li>
400
 									<h5>nextContext: <span class="tsd-signature-type">any</span></h5>
415
 									<h5>nextContext: <span class="tsd-signature-type">any</span></h5>
408
 					<a name="unsafe_componentwillupdate" class="tsd-anchor"></a>
423
 					<a name="unsafe_componentwillupdate" class="tsd-anchor"></a>
409
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component<wbr>Will<wbr>Update</h3>
424
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component<wbr>Will<wbr>Update</h3>
410
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
425
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
411
-						<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><span class="tsd-signature-type">AgoraViewProps</span><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>
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>
412
 					</ul>
427
 					</ul>
413
 					<ul class="tsd-descriptions">
428
 					<ul class="tsd-descriptions">
414
 						<li class="tsd-description">
429
 						<li class="tsd-description">
415
 							<aside class="tsd-sources">
430
 							<aside class="tsd-sources">
416
 								<p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate</p>
431
 								<p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate</p>
417
 								<ul>
432
 								<ul>
418
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:678</li>
433
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:707</li>
419
 								</ul>
434
 								</ul>
420
 							</aside>
435
 							</aside>
421
 							<div class="tsd-comment tsd-typography">
436
 							<div class="tsd-comment tsd-typography">
441
 							<h4 class="tsd-parameters-title">Parameters</h4>
456
 							<h4 class="tsd-parameters-title">Parameters</h4>
442
 							<ul class="tsd-parameters">
457
 							<ul class="tsd-parameters">
443
 								<li>
458
 								<li>
444
-									<h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">&gt;</span></h5>
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>
445
 								</li>
460
 								</li>
446
 								<li>
461
 								<li>
447
 									<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>
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>
465
 							<aside class="tsd-sources">
480
 							<aside class="tsd-sources">
466
 								<p>Inherited from ComponentLifecycle.componentDidCatch</p>
481
 								<p>Inherited from ComponentLifecycle.componentDidCatch</p>
467
 								<ul>
482
 								<ul>
468
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:547</li>
483
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:576</li>
469
 								</ul>
484
 								</ul>
470
 							</aside>
485
 							</aside>
471
 							<div class="tsd-comment tsd-typography">
486
 							<div class="tsd-comment tsd-typography">
498
 							<aside class="tsd-sources">
513
 							<aside class="tsd-sources">
499
 								<p>Inherited from ComponentLifecycle.componentDidMount</p>
514
 								<p>Inherited from ComponentLifecycle.componentDidMount</p>
500
 								<ul>
515
 								<ul>
501
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:526</li>
516
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:555</li>
502
 								</ul>
517
 								</ul>
503
 							</aside>
518
 							</aside>
504
 							<div class="tsd-comment tsd-typography">
519
 							<div class="tsd-comment tsd-typography">
514
 					<a name="componentdidupdate" class="tsd-anchor"></a>
529
 					<a name="componentdidupdate" class="tsd-anchor"></a>
515
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Did<wbr>Update</h3>
530
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Did<wbr>Update</h3>
516
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
531
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
517
-						<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><span class="tsd-signature-type">AgoraViewProps</span><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>
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>
518
 					</ul>
533
 					</ul>
519
 					<ul class="tsd-descriptions">
534
 					<ul class="tsd-descriptions">
520
 						<li class="tsd-description">
535
 						<li class="tsd-description">
521
 							<aside class="tsd-sources">
536
 							<aside class="tsd-sources">
522
 								<p>Inherited from NewLifecycle.componentDidUpdate</p>
537
 								<p>Inherited from NewLifecycle.componentDidUpdate</p>
523
 								<ul>
538
 								<ul>
524
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:589</li>
539
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:618</li>
525
 								</ul>
540
 								</ul>
526
 							</aside>
541
 							</aside>
527
 							<div class="tsd-comment tsd-typography">
542
 							<div class="tsd-comment tsd-typography">
533
 							<h4 class="tsd-parameters-title">Parameters</h4>
548
 							<h4 class="tsd-parameters-title">Parameters</h4>
534
 							<ul class="tsd-parameters">
549
 							<ul class="tsd-parameters">
535
 								<li>
550
 								<li>
536
-									<h5>prevProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">&gt;</span></h5>
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>
537
 								</li>
552
 								</li>
538
 								<li>
553
 								<li>
539
 									<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>
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>
557
 							<aside class="tsd-sources">
572
 							<aside class="tsd-sources">
558
 								<p>Inherited from DeprecatedLifecycle.componentWillMount</p>
573
 								<p>Inherited from DeprecatedLifecycle.componentWillMount</p>
559
 								<ul>
574
 								<ul>
560
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:604</li>
575
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:633</li>
561
 								</ul>
576
 								</ul>
562
 							</aside>
577
 							</aside>
563
 							<div class="tsd-comment tsd-typography">
578
 							<div class="tsd-comment tsd-typography">
587
 					<a name="componentwillreceiveprops" class="tsd-anchor"></a>
602
 					<a name="componentwillreceiveprops" class="tsd-anchor"></a>
588
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Receive<wbr>Props</h3>
603
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Receive<wbr>Props</h3>
589
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
604
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
590
-						<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><span class="tsd-signature-type">AgoraViewProps</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>
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>
591
 					</ul>
606
 					</ul>
592
 					<ul class="tsd-descriptions">
607
 					<ul class="tsd-descriptions">
593
 						<li class="tsd-description">
608
 						<li class="tsd-description">
594
 							<aside class="tsd-sources">
609
 							<aside class="tsd-sources">
595
 								<p>Inherited from DeprecatedLifecycle.componentWillReceiveProps</p>
610
 								<p>Inherited from DeprecatedLifecycle.componentWillReceiveProps</p>
596
 								<ul>
611
 								<ul>
597
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:633</li>
612
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:662</li>
598
 								</ul>
613
 								</ul>
599
 							</aside>
614
 							</aside>
600
 							<div class="tsd-comment tsd-typography">
615
 							<div class="tsd-comment tsd-typography">
621
 							<h4 class="tsd-parameters-title">Parameters</h4>
636
 							<h4 class="tsd-parameters-title">Parameters</h4>
622
 							<ul class="tsd-parameters">
637
 							<ul class="tsd-parameters">
623
 								<li>
638
 								<li>
624
-									<h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">&gt;</span></h5>
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>
625
 								</li>
640
 								</li>
626
 								<li>
641
 								<li>
627
 									<h5>nextContext: <span class="tsd-signature-type">any</span></h5>
642
 									<h5>nextContext: <span class="tsd-signature-type">any</span></h5>
642
 							<aside class="tsd-sources">
657
 							<aside class="tsd-sources">
643
 								<p>Inherited from ComponentLifecycle.componentWillUnmount</p>
658
 								<p>Inherited from ComponentLifecycle.componentWillUnmount</p>
644
 								<ul>
659
 								<ul>
645
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:542</li>
660
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:571</li>
646
 								</ul>
661
 								</ul>
647
 							</aside>
662
 							</aside>
648
 							<div class="tsd-comment tsd-typography">
663
 							<div class="tsd-comment tsd-typography">
659
 					<a name="componentwillupdate" class="tsd-anchor"></a>
674
 					<a name="componentwillupdate" class="tsd-anchor"></a>
660
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Update</h3>
675
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wbr>Update</h3>
661
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
676
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
662
-						<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><span class="tsd-signature-type">AgoraViewProps</span><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>
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>
663
 					</ul>
678
 					</ul>
664
 					<ul class="tsd-descriptions">
679
 					<ul class="tsd-descriptions">
665
 						<li class="tsd-description">
680
 						<li class="tsd-description">
666
 							<aside class="tsd-sources">
681
 							<aside class="tsd-sources">
667
 								<p>Inherited from DeprecatedLifecycle.componentWillUpdate</p>
682
 								<p>Inherited from DeprecatedLifecycle.componentWillUpdate</p>
668
 								<ul>
683
 								<ul>
669
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:663</li>
684
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:692</li>
670
 								</ul>
685
 								</ul>
671
 							</aside>
686
 							</aside>
672
 							<div class="tsd-comment tsd-typography">
687
 							<div class="tsd-comment tsd-typography">
691
 							<h4 class="tsd-parameters-title">Parameters</h4>
706
 							<h4 class="tsd-parameters-title">Parameters</h4>
692
 							<ul class="tsd-parameters">
707
 							<ul class="tsd-parameters">
693
 								<li>
708
 								<li>
694
-									<h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">&gt;</span></h5>
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>
695
 								</li>
710
 								</li>
696
 								<li>
711
 								<li>
697
 									<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>
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>
715
 							<aside class="tsd-sources">
730
 							<aside class="tsd-sources">
716
 								<p>Inherited from Component.forceUpdate</p>
731
 								<p>Inherited from Component.forceUpdate</p>
717
 								<ul>
732
 								<ul>
718
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:422</li>
733
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:451</li>
719
 								</ul>
734
 								</ul>
720
 							</aside>
735
 							</aside>
721
 							<h4 class="tsd-parameters-title">Parameters</h4>
736
 							<h4 class="tsd-parameters-title">Parameters</h4>
732
 					<a name="gethtmlprops" class="tsd-anchor"></a>
747
 					<a name="gethtmlprops" class="tsd-anchor"></a>
733
 					<h3><span class="tsd-flag ts-flagPrivate">Private</span> getHTMLProps</h3>
748
 					<h3><span class="tsd-flag ts-flagPrivate">Private</span> getHTMLProps</h3>
734
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
749
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
735
-						<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><span class="tsd-signature-type">AgoraViewProps</span></li>
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>
736
 					</ul>
751
 					</ul>
737
 					<ul class="tsd-descriptions">
752
 					<ul class="tsd-descriptions">
738
 						<li class="tsd-description">
753
 						<li class="tsd-description">
739
 							<aside class="tsd-sources">
754
 							<aside class="tsd-sources">
740
 								<ul>
755
 								<ul>
741
-									<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/AgoraView.native.tsx#L42">AgoraView.native.tsx:42</a></li>
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>
742
 								</ul>
757
 								</ul>
743
 							</aside>
758
 							</aside>
744
 							<div class="tsd-comment tsd-typography">
759
 							<div class="tsd-comment tsd-typography">
747
 								</div>
762
 								</div>
748
 								<p>get agora view props</p>
763
 								<p>get agora view props</p>
749
 							</div>
764
 							</div>
750
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AgoraViewProps</span></h4>
765
+							<h4 class="tsd-returns-title">Returns <a href="../interfaces/agoraviewprops.html" class="tsd-signature-type">AgoraViewProps</a></h4>
751
 						</li>
766
 						</li>
752
 					</ul>
767
 					</ul>
753
 				</section>
768
 				</section>
755
 					<a name="getsnapshotbeforeupdate" class="tsd-anchor"></a>
770
 					<a name="getsnapshotbeforeupdate" class="tsd-anchor"></a>
756
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> get<wbr>Snapshot<wbr>Before<wbr>Update</h3>
771
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> get<wbr>Snapshot<wbr>Before<wbr>Update</h3>
757
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
772
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
758
-						<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><span class="tsd-signature-type">AgoraViewProps</span><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>
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>
759
 					</ul>
774
 					</ul>
760
 					<ul class="tsd-descriptions">
775
 					<ul class="tsd-descriptions">
761
 						<li class="tsd-description">
776
 						<li class="tsd-description">
762
 							<aside class="tsd-sources">
777
 							<aside class="tsd-sources">
763
 								<p>Inherited from NewLifecycle.getSnapshotBeforeUpdate</p>
778
 								<p>Inherited from NewLifecycle.getSnapshotBeforeUpdate</p>
764
 								<ul>
779
 								<ul>
765
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:583</li>
780
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:612</li>
766
 								</ul>
781
 								</ul>
767
 							</aside>
782
 							</aside>
768
 							<div class="tsd-comment tsd-typography">
783
 							<div class="tsd-comment tsd-typography">
777
 							<h4 class="tsd-parameters-title">Parameters</h4>
792
 							<h4 class="tsd-parameters-title">Parameters</h4>
778
 							<ul class="tsd-parameters">
793
 							<ul class="tsd-parameters">
779
 								<li>
794
 								<li>
780
-									<h5>prevProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">&gt;</span></h5>
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>
781
 								</li>
796
 								</li>
782
 								<li>
797
 								<li>
783
 									<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>
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>
801
 							<aside class="tsd-sources">
816
 							<aside class="tsd-sources">
802
 								<p>Overrides Component.render</p>
817
 								<p>Overrides Component.render</p>
803
 								<ul>
818
 								<ul>
804
-									<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/AgoraView.native.tsx#L31">AgoraView.native.tsx:31</a></li>
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>
805
 								</ul>
820
 								</ul>
806
 							</aside>
821
 							</aside>
807
 							<div class="tsd-comment tsd-typography">
822
 							<div class="tsd-comment tsd-typography">
825
 							<aside class="tsd-sources">
840
 							<aside class="tsd-sources">
826
 								<p>Inherited from Component.setState</p>
841
 								<p>Inherited from Component.setState</p>
827
 								<ul>
842
 								<ul>
828
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:417</li>
843
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:446</li>
829
 								</ul>
844
 								</ul>
830
 							</aside>
845
 							</aside>
831
 							<h4 class="tsd-type-parameters-title">Type parameters</h4>
846
 							<h4 class="tsd-type-parameters-title">Type parameters</h4>
851
 					<a name="shouldcomponentupdate" class="tsd-anchor"></a>
866
 					<a name="shouldcomponentupdate" class="tsd-anchor"></a>
852
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> should<wbr>Component<wbr>Update</h3>
867
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> should<wbr>Component<wbr>Update</h3>
853
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
868
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
854
-						<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><span class="tsd-signature-type">AgoraViewProps</span><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>
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>
855
 					</ul>
870
 					</ul>
856
 					<ul class="tsd-descriptions">
871
 					<ul class="tsd-descriptions">
857
 						<li class="tsd-description">
872
 						<li class="tsd-description">
858
 							<aside class="tsd-sources">
873
 							<aside class="tsd-sources">
859
 								<p>Inherited from ComponentLifecycle.shouldComponentUpdate</p>
874
 								<p>Inherited from ComponentLifecycle.shouldComponentUpdate</p>
860
 								<ul>
875
 								<ul>
861
-									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:537</li>
876
+									<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:566</li>
862
 								</ul>
877
 								</ul>
863
 							</aside>
878
 							</aside>
864
 							<div class="tsd-comment tsd-typography">
879
 							<div class="tsd-comment tsd-typography">
874
 							<h4 class="tsd-parameters-title">Parameters</h4>
889
 							<h4 class="tsd-parameters-title">Parameters</h4>
875
 							<ul class="tsd-parameters">
890
 							<ul class="tsd-parameters">
876
 								<li>
891
 								<li>
877
-									<h5>nextProps: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">&gt;</span></h5>
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>
878
 								</li>
893
 								</li>
879
 								<li>
894
 								<li>
880
 									<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>
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>
977
 					<li class=" tsd-kind-class">
992
 					<li class=" tsd-kind-class">
978
 						<a href="rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
993
 						<a href="rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
979
 					</li>
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>
980
 					<li class=" tsd-kind-variable tsd-is-not-exported">
1094
 					<li class=" tsd-kind-variable tsd-is-not-exported">
981
 						<a href="../globals.html#agora" class="tsd-kind-icon">Agora</a>
1095
 						<a href="../globals.html#agora" class="tsd-kind-icon">Agora</a>
982
 					</li>
1096
 					</li>

+ 621
- 554
docs/api/classes/rtcengine.html
File diff suppressed because it is too large
View File


+ 213
- 4
docs/api/globals.html View File

74
 								<li class="tsd-kind-class"><a href="classes/rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a></li>
74
 								<li class="tsd-kind-class"><a href="classes/rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a></li>
75
 							</ul>
75
 							</ul>
76
 						</section>
76
 						</section>
77
+						<section class="tsd-index-section ">
78
+							<h3>Interfaces</h3>
79
+							<ul class="tsd-index-list">
80
+								<li class="tsd-kind-interface"><a href="interfaces/agoraviewprops.html" class="tsd-kind-icon">Agora<wbr>View<wbr>Props</a></li>
81
+								<li class="tsd-kind-interface"><a href="interfaces/audioframeoption.html" class="tsd-kind-icon">Audio<wbr>Frame<wbr>Option</a></li>
82
+								<li class="tsd-kind-interface"><a href="interfaces/audiomixingoption.html" class="tsd-kind-icon">Audio<wbr>Mixing<wbr>Option</a></li>
83
+								<li class="tsd-kind-interface"><a href="interfaces/audiorecordingoption.html" class="tsd-kind-icon">Audio<wbr>Recording<wbr>Option</a></li>
84
+								<li class="tsd-kind-interface"><a href="interfaces/backgroundimage.html" class="tsd-kind-icon">Background<wbr>Image</a></li>
85
+								<li class="tsd-kind-interface"><a href="interfaces/beautyoption.html" class="tsd-kind-icon">Beauty<wbr>Option</a></li>
86
+								<li class="tsd-kind-interface"><a href="interfaces/cameracapturerconfiguration.html" class="tsd-kind-icon">Camera<wbr>Capturer<wbr>Configuration</a></li>
87
+								<li class="tsd-kind-interface"><a href="interfaces/color.html" class="tsd-kind-icon">Color</a></li>
88
+								<li class="tsd-kind-interface"><a href="interfaces/datastreamoption.html" class="tsd-kind-icon">Data<wbr>Stream<wbr>Option</a></li>
89
+								<li class="tsd-kind-interface"><a href="interfaces/defaultvideostreamoption.html" class="tsd-kind-icon">Default<wbr>Video<wbr>Stream<wbr>Option</a></li>
90
+								<li class="tsd-kind-interface"><a href="interfaces/imageoption.html" class="tsd-kind-icon">Image<wbr>Option</a></li>
91
+								<li class="tsd-kind-interface"><a href="interfaces/injectstreamoption.html" class="tsd-kind-icon">Inject<wbr>Stream<wbr>Option</a></li>
92
+								<li class="tsd-kind-interface"><a href="interfaces/lastmileprobeconfig.html" class="tsd-kind-icon">Lastmile<wbr>Probe<wbr>Config</a></li>
93
+								<li class="tsd-kind-interface"><a href="interfaces/livetranscodingoption.html" class="tsd-kind-icon">Live<wbr>Transcoding<wbr>Option</a></li>
94
+								<li class="tsd-kind-interface"><a href="interfaces/mixedaudioframeoption.html" class="tsd-kind-icon">Mixed<wbr>Audio<wbr>Frame<wbr>Option</a></li>
95
+								<li class="tsd-kind-interface"><a href="interfaces/option.html" class="tsd-kind-icon">Option</a></li>
96
+								<li class="tsd-kind-interface"><a href="interfaces/playeffectoption.html" class="tsd-kind-icon">Play<wbr>Effect<wbr>Option</a></li>
97
+								<li class="tsd-kind-interface"><a href="interfaces/positionoption.html" class="tsd-kind-icon">Position<wbr>Option</a></li>
98
+								<li class="tsd-kind-interface"><a href="interfaces/publishstreamoption.html" class="tsd-kind-icon">Publish<wbr>Stream<wbr>Option</a></li>
99
+								<li class="tsd-kind-interface"><a href="interfaces/publisherconfig.html" class="tsd-kind-icon">Publisher<wbr>Config</a></li>
100
+								<li class="tsd-kind-interface"><a href="interfaces/rect.html" class="tsd-kind-icon">Rect</a></li>
101
+								<li class="tsd-kind-interface"><a href="interfaces/removeinjectstreamoption.html" class="tsd-kind-icon">Remove<wbr>Inject<wbr>Stream<wbr>Option</a></li>
102
+								<li class="tsd-kind-interface"><a href="interfaces/removepublishstreamoption.html" class="tsd-kind-icon">Remove<wbr>Publish<wbr>Stream<wbr>Option</a></li>
103
+								<li class="tsd-kind-interface"><a href="interfaces/size.html" class="tsd-kind-icon">Size</a></li>
104
+								<li class="tsd-kind-interface"><a href="interfaces/transcodinguser.html" class="tsd-kind-icon">Transcoding<wbr>User</a></li>
105
+								<li class="tsd-kind-interface"><a href="interfaces/videoencoderconfig.html" class="tsd-kind-icon">Video<wbr>Encoder<wbr>Config</a></li>
106
+								<li class="tsd-kind-interface"><a href="interfaces/videooption.html" class="tsd-kind-icon">Video<wbr>Option</a></li>
107
+								<li class="tsd-kind-interface"><a href="interfaces/videostreamoption.html" class="tsd-kind-icon">Video<wbr>Stream<wbr>Option</a></li>
108
+								<li class="tsd-kind-interface"><a href="interfaces/voicedecorator.html" class="tsd-kind-icon">Voice<wbr>Decorator</a></li>
109
+							</ul>
110
+						</section>
111
+						<section class="tsd-index-section ">
112
+							<h3>Type aliases</h3>
113
+							<ul class="tsd-index-list">
114
+								<li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="globals.html#callback" class="tsd-kind-icon">Callback</a></li>
115
+								<li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="globals.html#nullable" class="tsd-kind-icon">Nullable</a></li>
116
+								<li class="tsd-kind-type-alias"><a href="globals.html#number" class="tsd-kind-icon">Number</a></li>
117
+								<li class="tsd-kind-type-alias"><a href="globals.html#string" class="tsd-kind-icon">String</a></li>
118
+							</ul>
119
+						</section>
77
 						<section class="tsd-index-section tsd-is-not-exported">
120
 						<section class="tsd-index-section tsd-is-not-exported">
78
 							<h3>Variables</h3>
121
 							<h3>Variables</h3>
79
 							<ul class="tsd-index-list">
122
 							<ul class="tsd-index-list">
85
 					</div>
128
 					</div>
86
 				</section>
129
 				</section>
87
 			</section>
130
 			</section>
131
+			<section class="tsd-panel-group tsd-member-group ">
132
+				<h2>Type aliases</h2>
133
+				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
134
+					<a name="callback" class="tsd-anchor"></a>
135
+					<h3>Callback</h3>
136
+					<div class="tsd-signature tsd-kind-icon">Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
137
+					<aside class="tsd-sources">
138
+						<ul>
139
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L134">types.ts:134</a></li>
140
+						</ul>
141
+					</aside>
142
+					<div class="tsd-type-declaration">
143
+						<h4>Type declaration</h4>
144
+						<ul class="tsd-parameters">
145
+							<li class="tsd-parameter-siganture">
146
+								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
147
+									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, data<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">T</span></li>
148
+								</ul>
149
+								<ul class="tsd-descriptions">
150
+									<li class="tsd-description">
151
+										<h4 class="tsd-parameters-title">Parameters</h4>
152
+										<ul class="tsd-parameters">
153
+											<li>
154
+												<h5>err: <span class="tsd-signature-type">any</span></h5>
155
+											</li>
156
+											<li>
157
+												<h5>data: <span class="tsd-signature-type">any</span></h5>
158
+											</li>
159
+										</ul>
160
+										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
161
+									</li>
162
+								</ul>
163
+							</li>
164
+						</ul>
165
+					</div>
166
+				</section>
167
+				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
168
+					<a name="nullable" class="tsd-anchor"></a>
169
+					<h3>Nullable</h3>
170
+					<div class="tsd-signature tsd-kind-icon">Nullable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</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">undefined</span></div>
171
+					<aside class="tsd-sources">
172
+						<ul>
173
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L136">types.ts:136</a></li>
174
+						</ul>
175
+					</aside>
176
+				</section>
177
+				<section class="tsd-panel tsd-member tsd-kind-type-alias">
178
+					<a name="number" class="tsd-anchor"></a>
179
+					<h3>Number</h3>
180
+					<div class="tsd-signature tsd-kind-icon">Number<span class="tsd-signature-symbol">:</span> <a href="globals.html#nullable" class="tsd-signature-type">Nullable</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">0</span></div>
181
+					<aside class="tsd-sources">
182
+						<ul>
183
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L139">types.ts:139</a></li>
184
+						</ul>
185
+					</aside>
186
+				</section>
187
+				<section class="tsd-panel tsd-member tsd-kind-type-alias">
188
+					<a name="string" class="tsd-anchor"></a>
189
+					<h3>String</h3>
190
+					<div class="tsd-signature tsd-kind-icon">String<span class="tsd-signature-symbol">:</span> <a href="globals.html#nullable" class="tsd-signature-type">Nullable</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
191
+					<aside class="tsd-sources">
192
+						<ul>
193
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L138">types.ts:138</a></li>
194
+						</ul>
195
+					</aside>
196
+				</section>
197
+			</section>
88
 			<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
198
 			<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
89
 				<h2>Variables</h2>
199
 				<h2>Variables</h2>
90
 				<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
200
 				<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
93
 					<div class="tsd-signature tsd-kind-icon">Agora<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
203
 					<div class="tsd-signature tsd-kind-icon">Agora<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
94
 					<aside class="tsd-sources">
204
 					<aside class="tsd-sources">
95
 						<ul>
205
 						<ul>
96
-							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L31">RtcEngine.native.ts:31</a></li>
206
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/RtcEngine.native.ts#L31">RtcEngine.native.ts:31</a></li>
97
 						</ul>
207
 						</ul>
98
 					</aside>
208
 					</aside>
99
 				</section>
209
 				</section>
103
 					<div class="tsd-signature tsd-kind-icon">Agora<wbr>Event<wbr>Emitter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"> =&nbsp;new NativeEventEmitter(Agora)</span></div>
213
 					<div class="tsd-signature tsd-kind-icon">Agora<wbr>Event<wbr>Emitter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"> =&nbsp;new NativeEventEmitter(Agora)</span></div>
104
 					<aside class="tsd-sources">
214
 					<aside class="tsd-sources">
105
 						<ul>
215
 						<ul>
106
-							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L32">RtcEngine.native.ts:32</a></li>
216
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/RtcEngine.native.ts#L32">RtcEngine.native.ts:32</a></li>
107
 						</ul>
217
 						</ul>
108
 					</aside>
218
 					</aside>
109
 				</section>
219
 				</section>
110
 				<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
220
 				<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
111
 					<a name="rctagoraview" class="tsd-anchor"></a>
221
 					<a name="rctagoraview" class="tsd-anchor"></a>
112
 					<h3><span class="tsd-flag ts-flagConst">Const</span> RCTAgora<wbr>View</h3>
222
 					<h3><span class="tsd-flag ts-flagConst">Const</span> RCTAgora<wbr>View</h3>
113
-					<div class="tsd-signature tsd-kind-icon">RCTAgora<wbr>View<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> =&nbsp;requireNativeComponent(&quot;RCTAgoraView&quot;)</span></div>
223
+					<div class="tsd-signature tsd-kind-icon">RCTAgora<wbr>View<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> =&nbsp;requireNativeComponent(&quot;RCTAgoraVideoView&quot;)</span></div>
114
 					<aside class="tsd-sources">
224
 					<aside class="tsd-sources">
115
 						<ul>
225
 						<ul>
116
-							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/AgoraView.native.tsx#L16">AgoraView.native.tsx:16</a></li>
226
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/AgoraView.native.tsx#L16">AgoraView.native.tsx:16</a></li>
117
 						</ul>
227
 						</ul>
118
 					</aside>
228
 					</aside>
119
 					<div class="tsd-comment tsd-typography">
229
 					<div class="tsd-comment tsd-typography">
141
 					<li class=" tsd-kind-class">
251
 					<li class=" tsd-kind-class">
142
 						<a href="classes/rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
252
 						<a href="classes/rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
143
 					</li>
253
 					</li>
254
+					<li class=" tsd-kind-interface">
255
+						<a href="interfaces/agoraviewprops.html" class="tsd-kind-icon">Agora<wbr>View<wbr>Props</a>
256
+					</li>
257
+					<li class=" tsd-kind-interface">
258
+						<a href="interfaces/audioframeoption.html" class="tsd-kind-icon">Audio<wbr>Frame<wbr>Option</a>
259
+					</li>
260
+					<li class=" tsd-kind-interface">
261
+						<a href="interfaces/audiomixingoption.html" class="tsd-kind-icon">Audio<wbr>Mixing<wbr>Option</a>
262
+					</li>
263
+					<li class=" tsd-kind-interface">
264
+						<a href="interfaces/audiorecordingoption.html" class="tsd-kind-icon">Audio<wbr>Recording<wbr>Option</a>
265
+					</li>
266
+					<li class=" tsd-kind-interface">
267
+						<a href="interfaces/backgroundimage.html" class="tsd-kind-icon">Background<wbr>Image</a>
268
+					</li>
269
+					<li class=" tsd-kind-interface">
270
+						<a href="interfaces/beautyoption.html" class="tsd-kind-icon">Beauty<wbr>Option</a>
271
+					</li>
272
+					<li class=" tsd-kind-interface">
273
+						<a href="interfaces/cameracapturerconfiguration.html" class="tsd-kind-icon">Camera<wbr>Capturer<wbr>Configuration</a>
274
+					</li>
275
+					<li class=" tsd-kind-interface">
276
+						<a href="interfaces/color.html" class="tsd-kind-icon">Color</a>
277
+					</li>
278
+					<li class=" tsd-kind-interface">
279
+						<a href="interfaces/datastreamoption.html" class="tsd-kind-icon">Data<wbr>Stream<wbr>Option</a>
280
+					</li>
281
+					<li class=" tsd-kind-interface">
282
+						<a href="interfaces/defaultvideostreamoption.html" class="tsd-kind-icon">Default<wbr>Video<wbr>Stream<wbr>Option</a>
283
+					</li>
284
+					<li class=" tsd-kind-interface">
285
+						<a href="interfaces/imageoption.html" class="tsd-kind-icon">Image<wbr>Option</a>
286
+					</li>
287
+					<li class=" tsd-kind-interface">
288
+						<a href="interfaces/injectstreamoption.html" class="tsd-kind-icon">Inject<wbr>Stream<wbr>Option</a>
289
+					</li>
290
+					<li class=" tsd-kind-interface">
291
+						<a href="interfaces/lastmileprobeconfig.html" class="tsd-kind-icon">Lastmile<wbr>Probe<wbr>Config</a>
292
+					</li>
293
+					<li class=" tsd-kind-interface">
294
+						<a href="interfaces/livetranscodingoption.html" class="tsd-kind-icon">Live<wbr>Transcoding<wbr>Option</a>
295
+					</li>
296
+					<li class=" tsd-kind-interface">
297
+						<a href="interfaces/mixedaudioframeoption.html" class="tsd-kind-icon">Mixed<wbr>Audio<wbr>Frame<wbr>Option</a>
298
+					</li>
299
+					<li class=" tsd-kind-interface">
300
+						<a href="interfaces/option.html" class="tsd-kind-icon">Option</a>
301
+					</li>
302
+					<li class=" tsd-kind-interface">
303
+						<a href="interfaces/playeffectoption.html" class="tsd-kind-icon">Play<wbr>Effect<wbr>Option</a>
304
+					</li>
305
+					<li class=" tsd-kind-interface">
306
+						<a href="interfaces/positionoption.html" class="tsd-kind-icon">Position<wbr>Option</a>
307
+					</li>
308
+					<li class=" tsd-kind-interface">
309
+						<a href="interfaces/publishstreamoption.html" class="tsd-kind-icon">Publish<wbr>Stream<wbr>Option</a>
310
+					</li>
311
+					<li class=" tsd-kind-interface">
312
+						<a href="interfaces/publisherconfig.html" class="tsd-kind-icon">Publisher<wbr>Config</a>
313
+					</li>
314
+					<li class=" tsd-kind-interface">
315
+						<a href="interfaces/rect.html" class="tsd-kind-icon">Rect</a>
316
+					</li>
317
+					<li class=" tsd-kind-interface">
318
+						<a href="interfaces/removeinjectstreamoption.html" class="tsd-kind-icon">Remove<wbr>Inject<wbr>Stream<wbr>Option</a>
319
+					</li>
320
+					<li class=" tsd-kind-interface">
321
+						<a href="interfaces/removepublishstreamoption.html" class="tsd-kind-icon">Remove<wbr>Publish<wbr>Stream<wbr>Option</a>
322
+					</li>
323
+					<li class=" tsd-kind-interface">
324
+						<a href="interfaces/size.html" class="tsd-kind-icon">Size</a>
325
+					</li>
326
+					<li class=" tsd-kind-interface">
327
+						<a href="interfaces/transcodinguser.html" class="tsd-kind-icon">Transcoding<wbr>User</a>
328
+					</li>
329
+					<li class=" tsd-kind-interface">
330
+						<a href="interfaces/videoencoderconfig.html" class="tsd-kind-icon">Video<wbr>Encoder<wbr>Config</a>
331
+					</li>
332
+					<li class=" tsd-kind-interface">
333
+						<a href="interfaces/videooption.html" class="tsd-kind-icon">Video<wbr>Option</a>
334
+					</li>
335
+					<li class=" tsd-kind-interface">
336
+						<a href="interfaces/videostreamoption.html" class="tsd-kind-icon">Video<wbr>Stream<wbr>Option</a>
337
+					</li>
338
+					<li class=" tsd-kind-interface">
339
+						<a href="interfaces/voicedecorator.html" class="tsd-kind-icon">Voice<wbr>Decorator</a>
340
+					</li>
341
+					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
342
+						<a href="globals.html#callback" class="tsd-kind-icon">Callback</a>
343
+					</li>
344
+					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
345
+						<a href="globals.html#nullable" class="tsd-kind-icon">Nullable</a>
346
+					</li>
347
+					<li class=" tsd-kind-type-alias">
348
+						<a href="globals.html#number" class="tsd-kind-icon">Number</a>
349
+					</li>
350
+					<li class=" tsd-kind-type-alias">
351
+						<a href="globals.html#string" class="tsd-kind-icon">String</a>
352
+					</li>
144
 					<li class=" tsd-kind-variable tsd-is-not-exported">
353
 					<li class=" tsd-kind-variable tsd-is-not-exported">
145
 						<a href="globals.html#agora" class="tsd-kind-icon">Agora</a>
354
 						<a href="globals.html#agora" class="tsd-kind-icon">Agora</a>
146
 					</li>
355
 					</li>

+ 104
- 286
docs/api/index.html View File

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>
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>
77
 				<h2 id="compatibility">Compatibility</h2>
78
 				<ul>
78
 				<ul>
79
-					<li>react native 0.55.x</li>
79
+					<li><blockquote>
80
+							<p>= react native 0.55.x</p>
81
+						</blockquote>
82
+					</li>
80
 					<li>iOS SDK 8.0+</li>
83
 					<li>iOS SDK 8.0+</li>
81
 					<li>Android 5.0+ x86 arm64 armv7a</li>
84
 					<li>Android 5.0+ x86 arm64 armv7a</li>
82
 				</ul>
85
 				</ul>
101
 				<h2 id="ios">iOS</h2>
104
 				<h2 id="ios">iOS</h2>
102
 				<p>  <a href="https://docs.agora.io/cn/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html">中文</a>
105
 				<p>  <a href="https://docs.agora.io/cn/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html">中文</a>
103
 				<a href="https://docs.agora.io/en/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html">English</a></p>
106
 				<a href="https://docs.agora.io/en/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html">English</a></p>
104
-				<h2 id="2-3-api-docs"><a href="https://syanbo.github.io/react-native-agora/globals.html">2.3 API DOCS</a></h2>
105
-				<h2 id="2-4-api-docs"><a href="https://syanbo.github.io/react-native-agora/v2.4/globals.html">2.4 API DOCS</a></h2>
106
-				<h4 id="events">Events</h4>
107
-				<pre><code class="language-javascript">RtcEngine.on(<span class="hljs-string">'eventName'</span>, (data) =&gt; {
108
-    <span class="hljs-built_in">console</span>.log(data);
109
-});</code></pre>
110
-				<table>
111
-					<thead>
112
-						<tr>
113
-							<th>Name</th>
114
-							<th>Description</th>
115
-							<th>Platform</th>
116
-						</tr>
117
-					</thead>
118
-					<tbody><tr>
119
-							<td>warning</td>
120
-							<td>warning</td>
121
-							<td>all</td>
122
-						</tr>
123
-						<tr>
124
-							<td>error</td>
125
-							<td>error</td>
126
-							<td>all</td>
127
-						</tr>
128
-						<tr>
129
-							<td>apiCallExecute</td>
130
-							<td>capture agora native api call executed</td>
131
-							<td>all</td>
132
-						</tr>
133
-						<tr>
134
-							<td>joinChannelSuccess</td>
135
-							<td>join channel success</td>
136
-							<td>all</td>
137
-						</tr>
138
-						<tr>
139
-							<td>reJoinChannelSuccess</td>
140
-							<td>rejoin channel success</td>
141
-							<td>all</td>
142
-						</tr>
143
-						<tr>
144
-							<td>leaveChannel</td>
145
-							<td>quit channel</td>
146
-							<td>all</td>
147
-						</tr>
148
-						<tr>
149
-							<td>clientRoleChanged</td>
150
-							<td>when changed client role</td>
151
-							<td>all</td>
152
-						</tr>
153
-						<tr>
154
-							<td>userJoined</td>
155
-							<td>when user joined channel</td>
156
-							<td>all</td>
157
-						</tr>
158
-						<tr>
159
-							<td>userOffline</td>
160
-							<td>when user left channel</td>
161
-							<td>all</td>
162
-						</tr>
163
-						<tr>
164
-							<td>connectionStateChanged</td>
165
-							<td>when connection state changed</td>
166
-							<td>all</td>
167
-						</tr>
168
-						<tr>
169
-							<td>connectionLost</td>
170
-							<td>when connection lost</td>
171
-							<td>all</td>
172
-						</tr>
173
-						<tr>
174
-							<td>tokenPrivilegeWillExpire</td>
175
-							<td>when token will expire</td>
176
-							<td>all</td>
177
-						</tr>
178
-						<tr>
179
-							<td>requestToken</td>
180
-							<td>when token expired</td>
181
-							<td>all</td>
182
-						</tr>
183
-						<tr>
184
-							<td>microphoneEnabled</td>
185
-							<td>when microphone enabled</td>
186
-							<td>all</td>
187
-						</tr>
188
-						<tr>
189
-							<td>audioVolumeIndication</td>
190
-							<td>notice audio volume</td>
191
-							<td>all</td>
192
-						</tr>
193
-						<tr>
194
-							<td>activeSpeaker</td>
195
-							<td>reports which user is the loudest speaker</td>
196
-							<td>all</td>
197
-						</tr>
198
-						<tr>
199
-							<td>firstLocalAudioFrame</td>
200
-							<td>when the first local audio frame is sent</td>
201
-							<td>all</td>
202
-						</tr>
203
-						<tr>
204
-							<td>firstRemoteAudioFrame</td>
205
-							<td>when the first remote audio frame is sent</td>
206
-							<td>all</td>
207
-						</tr>
208
-						<tr>
209
-							<td>videoStopped</td>
210
-							<td>when video stopped</td>
211
-							<td>all</td>
212
-						</tr>
213
-						<tr>
214
-							<td>firstLocalVideoFrame</td>
215
-							<td>when first local video frame is sent</td>
216
-							<td>all</td>
217
-						</tr>
218
-						<tr>
219
-							<td>firstRemoteVideoDecoded</td>
220
-							<td>when first remote video is decoded</td>
221
-							<td>all</td>
222
-						</tr>
223
-						<tr>
224
-							<td>firstRemoteVideoFrame</td>
225
-							<td>when first remote video frame is rendered</td>
226
-							<td>all</td>
227
-						</tr>
228
-						<tr>
229
-							<td>userMuteAudio</td>
230
-							<td>when a remote user&#39;s audio stream is muted/unmuted</td>
231
-							<td>all</td>
232
-						</tr>
233
-						<tr>
234
-							<td>userMuteVideo</td>
235
-							<td>when a remote user&#39;s video stream is muted/unmuted</td>
236
-							<td>all</td>
237
-						</tr>
238
-						<tr>
239
-							<td>userEnableVideo</td>
240
-							<td>when a remote user enables/disables the video module</td>
241
-							<td>all</td>
242
-						</tr>
243
-						<tr>
244
-							<td>userEnableLocalVideo</td>
245
-							<td>when a remote user enables/disables the local video capture function</td>
246
-							<td>all</td>
247
-						</tr>
248
-						<tr>
249
-							<td>videoSizeChanged</td>
250
-							<td>when the video size or rotation information of a specified remote user changes</td>
251
-							<td>all</td>
252
-						</tr>
253
-						<tr>
254
-							<td>remoteVideoStateChanged</td>
255
-							<td>when the remote video stream state changes</td>
256
-							<td>all</td>
257
-						</tr>
258
-						<tr>
259
-							<td>localPublishFallbackToAudioOnly</td>
260
-							<td>Occurs when the published video stream falls back to an audio-only stream due to unreliable network conditions or switches back to the video when the network conditions improve.</td>
261
-							<td>all</td>
262
-						</tr>
263
-						<tr>
264
-							<td>remoteSubscribeFallbackToAudioOnly</td>
265
-							<td>Occurs when the remote video stream falls back to an audio-only stream due to unreliable network conditions or switches back to the video after the network conditions improve.</td>
266
-							<td>all</td>
267
-						</tr>
268
-						<tr>
269
-							<td>audioRouteChanged</td>
270
-							<td>when the local audio pkayout route changes</td>
271
-							<td>all</td>
272
-						</tr>
273
-						<tr>
274
-							<td>cameraReady</td>
275
-							<td>when the camera is turned on and ready to capture video</td>
276
-							<td>all</td>
277
-						</tr>
278
-						<tr>
279
-							<td>cameraFocusAreaChanged</td>
280
-							<td>when the camera focus area is changed</td>
281
-							<td>all</td>
282
-						</tr>
283
-						<tr>
284
-							<td>cameraExposureAreaChanged</td>
285
-							<td>The camera exposure area has changed</td>
286
-							<td>all</td>
287
-						</tr>
288
-						<tr>
289
-							<td>remoteAudioStats</td>
290
-							<td>Reports the statistics of the audio stream from each remote user/host.</td>
291
-							<td>all</td>
292
-						</tr>
293
-						<tr>
294
-							<td>rtcStats</td>
295
-							<td>Reports the statistics of the RtcEngine once every two seconds</td>
296
-							<td>all</td>
297
-						</tr>
298
-						<tr>
299
-							<td>lastmileQuality</td>
300
-							<td>Reports the last mile network quality of the local user once every two seconds before the user joins the channel. Last mile refers to the connection between the local device and Agora&#39;s edge server. After the application calls the enableLastmileTest method, this callback reports once every two seconds the uplink and downlink last mile network conditions of the local user before the user joins the channel.</td>
301
-							<td>all</td>
302
-						</tr>
303
-						<tr>
304
-							<td>networkQuality</td>
305
-							<td>Reports the last mile network quality of each user in the channel once every two seconds. Last mile refers to the connection between the local device and Agora&#39;s edge server. This callback reports once every two seconds the uplink last mile network conditions of each user in the channel. If a channel includes multiple users, then this callback will be triggered as many times.</td>
306
-							<td>all</td>
307
-						</tr>
308
-						<tr>
309
-							<td>localVideoStats</td>
310
-							<td>Reports the statistics of the uploading local video streams. This callback is triggered once every two seconds for each individual user/host. If there are multiple users/hosts in the channel, this callback is triggered multiple times every 2 seconds.</td>
311
-							<td>all</td>
312
-						</tr>
313
-						<tr>
314
-							<td>remoteVideoStats</td>
315
-							<td>Reports the statistics of the video stream from each remote user/host. The SDK triggers this callback once every two seconds for each remote user/host. If a channel includes multiple remote users, the SDK triggers this callback as many times. This callback reports statistics more closely linked to the real-user experience of the video transmission quality than the statistics that the onRemoteVideoTransportStats callback reports</td>
316
-							<td>all</td>
317
-						</tr>
318
-						<tr>
319
-							<td>audioTransportStatsOfUid</td>
320
-							<td>Reports the transport-layer statistics of each remote audio stream.</td>
321
-							<td>all</td>
322
-						</tr>
323
-						<tr>
324
-							<td>videoTransportStatsOfUid</td>
325
-							<td>Reports the transport-layer statistics of each remote video stream.</td>
326
-							<td>all</td>
327
-						</tr>
328
-						<tr>
329
-							<td>localAudioMixingFinish</td>
330
-							<td>Occurs when the audio mixing file playback finishes.</td>
331
-							<td>all</td>
332
-						</tr>
333
-						<tr>
334
-							<td>remoteAudioMixingStart</td>
335
-							<td>Occurs when a remote user starts audio mixing.</td>
336
-							<td>ios</td>
337
-						</tr>
338
-						<tr>
339
-							<td>remoteAudioMixingFinish</td>
340
-							<td>Occurs when a remote user finishes audio mixing.</td>
341
-							<td>ios</td>
342
-						</tr>
343
-						<tr>
344
-							<td>audioEffectFinish</td>
345
-							<td>Occurs when the audio effect file playback finishes.</td>
346
-							<td>all</td>
347
-						</tr>
348
-						<tr>
349
-							<td>streamPublished</td>
350
-							<td>Occurs when a CDN live stream is published.</td>
351
-							<td>all</td>
352
-						</tr>
353
-						<tr>
354
-							<td>streamUnpublish</td>
355
-							<td>Occurs when CDN live streaming stops. This callback notifies the host that the CDN live stream is unpublished.</td>
356
-							<td>all</td>
357
-						</tr>
358
-						<tr>
359
-							<td>transcodingUpdate</td>
360
-							<td>Occurs when the publisher&#39;s transcoding settings are updated.</td>
361
-							<td>all</td>
362
-						</tr>
363
-						<tr>
364
-							<td>streamInjectedStatus</td>
365
-							<td>Reports the status of the injected online media stream.</td>
366
-							<td>all</td>
367
-						</tr>
368
-						<tr>
369
-							<td>receiveStreamMessage</td>
370
-							<td>Occurs when the local user receives a remote data stream within five seconds.</td>
371
-							<td>all</td>
372
-						</tr>
373
-						<tr>
374
-							<td>occurStreamMessageError</td>
375
-							<td>Occurs when the local user fails to receive a remote data stream.</td>
376
-							<td>all</td>
377
-						</tr>
378
-						<tr>
379
-							<td>mediaEngineLoaded</td>
380
-							<td>Occurs when the media engine is loaded.</td>
381
-							<td>all</td>
382
-						</tr>
383
-						<tr>
384
-							<td>mediaEngineStartCall</td>
385
-							<td>Occurs when the media engine starts.</td>
386
-							<td>all</td>
387
-						</tr>
388
-				</tbody></table>
107
+				<h2 id="api-docs"><a href="https://syanbo.github.io/react-native-agora/globals.html">API DOCS</a></h2>
389
 				<h2 id="resources">Resources</h2>
108
 				<h2 id="resources">Resources</h2>
390
 				<ul>
109
 				<ul>
391
 					<li>Complete <a href="https://docs.agora.io/en/">API documentation</a> at the Developer Center</li>
110
 					<li>Complete <a href="https://docs.agora.io/en/">API documentation</a> at the Developer Center</li>
410
 					<li class=" tsd-kind-class">
129
 					<li class=" tsd-kind-class">
411
 						<a href="classes/rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
130
 						<a href="classes/rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
412
 					</li>
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>
413
 					<li class=" tsd-kind-variable tsd-is-not-exported">
231
 					<li class=" tsd-kind-variable tsd-is-not-exported">
414
 						<a href="globals.html#agora" class="tsd-kind-icon">Agora</a>
232
 						<a href="globals.html#agora" class="tsd-kind-icon">Agora</a>
415
 					</li>
233
 					</li>

+ 2534
- 0
docs/api/interfaces/agoraviewprops.html
File diff suppressed because it is too large
View File


+ 350
- 0
docs/api/interfaces/audioframeoption.html View File

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

+ 350
- 0
docs/api/interfaces/audiomixingoption.html View File

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

+ 322
- 0
docs/api/interfaces/audiorecordingoption.html View File

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

+ 364
- 0
docs/api/interfaces/backgroundimage.html View File

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

+ 371
- 0
docs/api/interfaces/beautyoption.html View File

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

+ 320
- 0
docs/api/interfaces/cameracapturerconfiguration.html View File

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>CameraCapturerConfiguration | 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="cameracapturerconfiguration.html">CameraCapturerConfiguration</a>
60
+				</li>
61
+			</ul>
62
+			<h1>Interface CameraCapturerConfiguration</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>CameraCapturerConfiguration is setCameraCapturerConfiguration&#39;s config parameter</p>
73
+					</div>
74
+					<dl class="tsd-comment-tags">
75
+						<dt>property</dt>
76
+						<dd><p>preference: number | The Camera capture preference and the value range is [0 is &quot;(default) self-adapts the camera output parameters to the system performance and network conditions to balance CPU consumption and video preview quality.&quot;, 1 is &quot;prioritizes the system performance. The SDK chooses the dimension and frame rate of the local camera capture closest to those set by setVideoEncoderConfiguration.&quot;, 2 is &quot;prioritizes the local preview quality. The SDK chooses higher camera output parameters to improve the local video preview quality. This option requires extra CPU and RAM usage for video pre-processing.&quot;]</p>
77
+						</dd>
78
+					</dl>
79
+				</div>
80
+			</section>
81
+			<section class="tsd-panel tsd-hierarchy">
82
+				<h3>Hierarchy</h3>
83
+				<ul class="tsd-hierarchy">
84
+					<li>
85
+						<span class="target">CameraCapturerConfiguration</span>
86
+					</li>
87
+				</ul>
88
+			</section>
89
+			<section class="tsd-panel-group tsd-index-group">
90
+				<h2>Index</h2>
91
+				<section class="tsd-panel tsd-index-panel">
92
+					<div class="tsd-index-content">
93
+						<section class="tsd-index-section ">
94
+							<h3>Properties</h3>
95
+							<ul class="tsd-index-list">
96
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="cameracapturerconfiguration.html#preference" class="tsd-kind-icon">preference</a></li>
97
+							</ul>
98
+						</section>
99
+					</div>
100
+				</section>
101
+			</section>
102
+			<section class="tsd-panel-group tsd-member-group ">
103
+				<h2>Properties</h2>
104
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
105
+					<a name="preference" class="tsd-anchor"></a>
106
+					<h3>preference</h3>
107
+					<div class="tsd-signature tsd-kind-icon">preference<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
108
+					<aside class="tsd-sources">
109
+						<ul>
110
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L269">types.ts:269</a></li>
111
+						</ul>
112
+					</aside>
113
+				</section>
114
+			</section>
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="agoraviewprops.html" class="tsd-kind-icon">Agora<wbr>View<wbr>Props</a>
134
+					</li>
135
+					<li class=" tsd-kind-interface">
136
+						<a href="audioframeoption.html" class="tsd-kind-icon">Audio<wbr>Frame<wbr>Option</a>
137
+					</li>
138
+					<li class=" tsd-kind-interface">
139
+						<a href="audiomixingoption.html" class="tsd-kind-icon">Audio<wbr>Mixing<wbr>Option</a>
140
+					</li>
141
+					<li class=" tsd-kind-interface">
142
+						<a href="audiorecordingoption.html" class="tsd-kind-icon">Audio<wbr>Recording<wbr>Option</a>
143
+					</li>
144
+					<li class=" tsd-kind-interface">
145
+						<a href="backgroundimage.html" class="tsd-kind-icon">Background<wbr>Image</a>
146
+					</li>
147
+					<li class=" tsd-kind-interface">
148
+						<a href="beautyoption.html" class="tsd-kind-icon">Beauty<wbr>Option</a>
149
+					</li>
150
+				</ul>
151
+				<ul class="current">
152
+					<li class="current tsd-kind-interface">
153
+						<a href="cameracapturerconfiguration.html" class="tsd-kind-icon">Camera<wbr>Capturer<wbr>Configuration</a>
154
+						<ul>
155
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
156
+								<a href="cameracapturerconfiguration.html#preference" class="tsd-kind-icon">preference</a>
157
+							</li>
158
+						</ul>
159
+					</li>
160
+				</ul>
161
+				<ul class="after-current">
162
+					<li class=" tsd-kind-interface">
163
+						<a href="color.html" class="tsd-kind-icon">Color</a>
164
+					</li>
165
+					<li class=" tsd-kind-interface">
166
+						<a href="datastreamoption.html" class="tsd-kind-icon">Data<wbr>Stream<wbr>Option</a>
167
+					</li>
168
+					<li class=" tsd-kind-interface">
169
+						<a href="defaultvideostreamoption.html" class="tsd-kind-icon">Default<wbr>Video<wbr>Stream<wbr>Option</a>
170
+					</li>
171
+					<li class=" tsd-kind-interface">
172
+						<a href="imageoption.html" class="tsd-kind-icon">Image<wbr>Option</a>
173
+					</li>
174
+					<li class=" tsd-kind-interface">
175
+						<a href="injectstreamoption.html" class="tsd-kind-icon">Inject<wbr>Stream<wbr>Option</a>
176
+					</li>
177
+					<li class=" tsd-kind-interface">
178
+						<a href="lastmileprobeconfig.html" class="tsd-kind-icon">Lastmile<wbr>Probe<wbr>Config</a>
179
+					</li>
180
+					<li class=" tsd-kind-interface">
181
+						<a href="livetranscodingoption.html" class="tsd-kind-icon">Live<wbr>Transcoding<wbr>Option</a>
182
+					</li>
183
+					<li class=" tsd-kind-interface">
184
+						<a href="mixedaudioframeoption.html" class="tsd-kind-icon">Mixed<wbr>Audio<wbr>Frame<wbr>Option</a>
185
+					</li>
186
+					<li class=" tsd-kind-interface">
187
+						<a href="option.html" class="tsd-kind-icon">Option</a>
188
+					</li>
189
+					<li class=" tsd-kind-interface">
190
+						<a href="playeffectoption.html" class="tsd-kind-icon">Play<wbr>Effect<wbr>Option</a>
191
+					</li>
192
+					<li class=" tsd-kind-interface">
193
+						<a href="positionoption.html" class="tsd-kind-icon">Position<wbr>Option</a>
194
+					</li>
195
+					<li class=" tsd-kind-interface">
196
+						<a href="publishstreamoption.html" class="tsd-kind-icon">Publish<wbr>Stream<wbr>Option</a>
197
+					</li>
198
+					<li class=" tsd-kind-interface">
199
+						<a href="publisherconfig.html" class="tsd-kind-icon">Publisher<wbr>Config</a>
200
+					</li>
201
+					<li class=" tsd-kind-interface">
202
+						<a href="rect.html" class="tsd-kind-icon">Rect</a>
203
+					</li>
204
+					<li class=" tsd-kind-interface">
205
+						<a href="removeinjectstreamoption.html" class="tsd-kind-icon">Remove<wbr>Inject<wbr>Stream<wbr>Option</a>
206
+					</li>
207
+					<li class=" tsd-kind-interface">
208
+						<a href="removepublishstreamoption.html" class="tsd-kind-icon">Remove<wbr>Publish<wbr>Stream<wbr>Option</a>
209
+					</li>
210
+					<li class=" tsd-kind-interface">
211
+						<a href="size.html" class="tsd-kind-icon">Size</a>
212
+					</li>
213
+					<li class=" tsd-kind-interface">
214
+						<a href="transcodinguser.html" class="tsd-kind-icon">Transcoding<wbr>User</a>
215
+					</li>
216
+					<li class=" tsd-kind-interface">
217
+						<a href="videoencoderconfig.html" class="tsd-kind-icon">Video<wbr>Encoder<wbr>Config</a>
218
+					</li>
219
+					<li class=" tsd-kind-interface">
220
+						<a href="videooption.html" class="tsd-kind-icon">Video<wbr>Option</a>
221
+					</li>
222
+					<li class=" tsd-kind-interface">
223
+						<a href="videostreamoption.html" class="tsd-kind-icon">Video<wbr>Stream<wbr>Option</a>
224
+					</li>
225
+					<li class=" tsd-kind-interface">
226
+						<a href="voicedecorator.html" class="tsd-kind-icon">Voice<wbr>Decorator</a>
227
+					</li>
228
+					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
229
+						<a href="../globals.html#callback" class="tsd-kind-icon">Callback</a>
230
+					</li>
231
+					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
232
+						<a href="../globals.html#nullable" class="tsd-kind-icon">Nullable</a>
233
+					</li>
234
+					<li class=" tsd-kind-type-alias">
235
+						<a href="../globals.html#number" class="tsd-kind-icon">Number</a>
236
+					</li>
237
+					<li class=" tsd-kind-type-alias">
238
+						<a href="../globals.html#string" class="tsd-kind-icon">String</a>
239
+					</li>
240
+					<li class=" tsd-kind-variable tsd-is-not-exported">
241
+						<a href="../globals.html#agora" class="tsd-kind-icon">Agora</a>
242
+					</li>
243
+					<li class=" tsd-kind-variable tsd-is-not-exported">
244
+						<a href="../globals.html#agoraeventemitter" class="tsd-kind-icon">Agora<wbr>Event<wbr>Emitter</a>
245
+					</li>
246
+					<li class=" tsd-kind-variable tsd-is-not-exported">
247
+						<a href="../globals.html#rctagoraview" class="tsd-kind-icon">RCTAgora<wbr>View</a>
248
+					</li>
249
+				</ul>
250
+			</nav>
251
+		</div>
252
+	</div>
253
+</div>
254
+<footer class="with-border-bottom">
255
+	<div class="container">
256
+		<h2>Legend</h2>
257
+		<div class="tsd-legend-group">
258
+			<ul class="tsd-legend">
259
+				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
260
+				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
261
+				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
262
+				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
263
+				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
264
+				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
265
+				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
266
+			</ul>
267
+			<ul class="tsd-legend">
268
+				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
269
+				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
270
+				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
271
+				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
272
+			</ul>
273
+			<ul class="tsd-legend">
274
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
275
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
276
+				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
277
+				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
278
+				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
279
+				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
280
+			</ul>
281
+			<ul class="tsd-legend">
282
+				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
283
+				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
284
+				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
285
+				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
286
+				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
287
+				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
288
+				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
289
+			</ul>
290
+			<ul class="tsd-legend">
291
+				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
292
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
293
+				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
294
+				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
295
+			</ul>
296
+			<ul class="tsd-legend">
297
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
298
+				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
299
+				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
300
+			</ul>
301
+			<ul class="tsd-legend">
302
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
303
+				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
304
+				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
305
+			</ul>
306
+			<ul class="tsd-legend">
307
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
308
+				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
309
+			</ul>
310
+		</div>
311
+	</div>
312
+</footer>
313
+<div class="container tsd-generator">
314
+	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
315
+</div>
316
+<div class="overlay"></div>
317
+<script src="../assets/js/main.js"></script>
318
+<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
319
+</body>
320
+</html>

+ 350
- 0
docs/api/interfaces/color.html View File

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

+ 336
- 0
docs/api/interfaces/datastreamoption.html View File

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

+ 308
- 0
docs/api/interfaces/defaultvideostreamoption.html View File

1
+<!doctype html>
2
+<html class="default no-js">
3
+<head>
4
+	<meta charset="utf-8">
5
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+	<title>DefaultVideoStreamOption | react-native-agora</title>
7
+	<meta name="description" content="">
8
+	<meta name="viewport" content="width=device-width, initial-scale=1">
9
+	<link rel="stylesheet" href="../assets/css/main.css">
10
+</head>
11
+<body>
12
+<header>
13
+	<div class="tsd-page-toolbar">
14
+		<div class="container">
15
+			<div class="table-wrap">
16
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
+					<div class="field">
18
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
+						<input id="tsd-search-field" type="text" />
20
+					</div>
21
+					<ul class="results">
22
+						<li class="state loading">Preparing search index...</li>
23
+						<li class="state failure">The search index is not available</li>
24
+					</ul>
25
+					<a href="../index.html" class="title">react-native-agora</a>
26
+				</div>
27
+				<div class="table-cell" id="tsd-widgets">
28
+					<div id="tsd-filter">
29
+						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
+						<div class="tsd-filter-group">
31
+							<div class="tsd-select" id="tsd-filter-visibility">
32
+								<span class="tsd-select-label">All</span>
33
+								<ul class="tsd-select-list">
34
+									<li data-value="public">Public</li>
35
+									<li data-value="protected">Public/Protected</li>
36
+									<li data-value="private" class="selected">All</li>
37
+								</ul>
38
+							</div>
39
+							<input type="checkbox" id="tsd-filter-inherited" checked />
40
+							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
+							<input type="checkbox" id="tsd-filter-externals" checked />
42
+							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
+							<input type="checkbox" id="tsd-filter-only-exported" />
44
+							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
+						</div>
46
+					</div>
47
+					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
+				</div>
49
+			</div>
50
+		</div>
51
+	</div>
52
+	<div class="tsd-page-title">
53
+		<div class="container">
54
+			<ul class="tsd-breadcrumb">
55
+				<li>
56
+					<a href="../globals.html">Globals</a>
57
+				</li>
58
+				<li>
59
+					<a href="defaultvideostreamoption.html">DefaultVideoStreamOption</a>
60
+				</li>
61
+			</ul>
62
+			<h1>Interface DefaultVideoStreamOption</h1>
63
+		</div>
64
+	</div>
65
+</header>
66
+<div class="container container-main">
67
+	<div class="row">
68
+		<div class="col-8 col-content">
69
+			<section class="tsd-panel tsd-hierarchy">
70
+				<h3>Hierarchy</h3>
71
+				<ul class="tsd-hierarchy">
72
+					<li>
73
+						<span class="target">DefaultVideoStreamOption</span>
74
+					</li>
75
+				</ul>
76
+			</section>
77
+			<section class="tsd-panel-group tsd-index-group">
78
+				<h2>Index</h2>
79
+				<section class="tsd-panel tsd-index-panel">
80
+					<div class="tsd-index-content">
81
+						<section class="tsd-index-section ">
82
+							<h3>Properties</h3>
83
+							<ul class="tsd-index-list">
84
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="defaultvideostreamoption.html#streamtype" class="tsd-kind-icon">stream<wbr>Type</a></li>
85
+							</ul>
86
+						</section>
87
+					</div>
88
+				</section>
89
+			</section>
90
+			<section class="tsd-panel-group tsd-member-group ">
91
+				<h2>Properties</h2>
92
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
93
+					<a name="streamtype" class="tsd-anchor"></a>
94
+					<h3>stream<wbr>Type</h3>
95
+					<div class="tsd-signature tsd-kind-icon">stream<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
96
+					<aside class="tsd-sources">
97
+						<ul>
98
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L198">types.ts:198</a></li>
99
+						</ul>
100
+					</aside>
101
+				</section>
102
+			</section>
103
+		</div>
104
+		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
105
+			<nav class="tsd-navigation primary">
106
+				<ul>
107
+					<li class="globals  ">
108
+						<a href="../globals.html"><em>Globals</em></a>
109
+					</li>
110
+				</ul>
111
+			</nav>
112
+			<nav class="tsd-navigation secondary menu-sticky">
113
+				<ul class="before-current">
114
+					<li class=" tsd-kind-class tsd-has-type-parameter">
115
+						<a href="../classes/agoraview.html" class="tsd-kind-icon">Agora<wbr>View</a>
116
+					</li>
117
+					<li class=" tsd-kind-class">
118
+						<a href="../classes/rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
119
+					</li>
120
+					<li class=" tsd-kind-interface">
121
+						<a href="agoraviewprops.html" class="tsd-kind-icon">Agora<wbr>View<wbr>Props</a>
122
+					</li>
123
+					<li class=" tsd-kind-interface">
124
+						<a href="audioframeoption.html" class="tsd-kind-icon">Audio<wbr>Frame<wbr>Option</a>
125
+					</li>
126
+					<li class=" tsd-kind-interface">
127
+						<a href="audiomixingoption.html" class="tsd-kind-icon">Audio<wbr>Mixing<wbr>Option</a>
128
+					</li>
129
+					<li class=" tsd-kind-interface">
130
+						<a href="audiorecordingoption.html" class="tsd-kind-icon">Audio<wbr>Recording<wbr>Option</a>
131
+					</li>
132
+					<li class=" tsd-kind-interface">
133
+						<a href="backgroundimage.html" class="tsd-kind-icon">Background<wbr>Image</a>
134
+					</li>
135
+					<li class=" tsd-kind-interface">
136
+						<a href="beautyoption.html" class="tsd-kind-icon">Beauty<wbr>Option</a>
137
+					</li>
138
+					<li class=" tsd-kind-interface">
139
+						<a href="cameracapturerconfiguration.html" class="tsd-kind-icon">Camera<wbr>Capturer<wbr>Configuration</a>
140
+					</li>
141
+					<li class=" tsd-kind-interface">
142
+						<a href="color.html" class="tsd-kind-icon">Color</a>
143
+					</li>
144
+					<li class=" tsd-kind-interface">
145
+						<a href="datastreamoption.html" class="tsd-kind-icon">Data<wbr>Stream<wbr>Option</a>
146
+					</li>
147
+				</ul>
148
+				<ul class="current">
149
+					<li class="current tsd-kind-interface">
150
+						<a href="defaultvideostreamoption.html" class="tsd-kind-icon">Default<wbr>Video<wbr>Stream<wbr>Option</a>
151
+						<ul>
152
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
153
+								<a href="defaultvideostreamoption.html#streamtype" class="tsd-kind-icon">stream<wbr>Type</a>
154
+							</li>
155
+						</ul>
156
+					</li>
157
+				</ul>
158
+				<ul class="after-current">
159
+					<li class=" tsd-kind-interface">
160
+						<a href="imageoption.html" class="tsd-kind-icon">Image<wbr>Option</a>
161
+					</li>
162
+					<li class=" tsd-kind-interface">
163
+						<a href="injectstreamoption.html" class="tsd-kind-icon">Inject<wbr>Stream<wbr>Option</a>
164
+					</li>
165
+					<li class=" tsd-kind-interface">
166
+						<a href="lastmileprobeconfig.html" class="tsd-kind-icon">Lastmile<wbr>Probe<wbr>Config</a>
167
+					</li>
168
+					<li class=" tsd-kind-interface">
169
+						<a href="livetranscodingoption.html" class="tsd-kind-icon">Live<wbr>Transcoding<wbr>Option</a>
170
+					</li>
171
+					<li class=" tsd-kind-interface">
172
+						<a href="mixedaudioframeoption.html" class="tsd-kind-icon">Mixed<wbr>Audio<wbr>Frame<wbr>Option</a>
173
+					</li>
174
+					<li class=" tsd-kind-interface">
175
+						<a href="option.html" class="tsd-kind-icon">Option</a>
176
+					</li>
177
+					<li class=" tsd-kind-interface">
178
+						<a href="playeffectoption.html" class="tsd-kind-icon">Play<wbr>Effect<wbr>Option</a>
179
+					</li>
180
+					<li class=" tsd-kind-interface">
181
+						<a href="positionoption.html" class="tsd-kind-icon">Position<wbr>Option</a>
182
+					</li>
183
+					<li class=" tsd-kind-interface">
184
+						<a href="publishstreamoption.html" class="tsd-kind-icon">Publish<wbr>Stream<wbr>Option</a>
185
+					</li>
186
+					<li class=" tsd-kind-interface">
187
+						<a href="publisherconfig.html" class="tsd-kind-icon">Publisher<wbr>Config</a>
188
+					</li>
189
+					<li class=" tsd-kind-interface">
190
+						<a href="rect.html" class="tsd-kind-icon">Rect</a>
191
+					</li>
192
+					<li class=" tsd-kind-interface">
193
+						<a href="removeinjectstreamoption.html" class="tsd-kind-icon">Remove<wbr>Inject<wbr>Stream<wbr>Option</a>
194
+					</li>
195
+					<li class=" tsd-kind-interface">
196
+						<a href="removepublishstreamoption.html" class="tsd-kind-icon">Remove<wbr>Publish<wbr>Stream<wbr>Option</a>
197
+					</li>
198
+					<li class=" tsd-kind-interface">
199
+						<a href="size.html" class="tsd-kind-icon">Size</a>
200
+					</li>
201
+					<li class=" tsd-kind-interface">
202
+						<a href="transcodinguser.html" class="tsd-kind-icon">Transcoding<wbr>User</a>
203
+					</li>
204
+					<li class=" tsd-kind-interface">
205
+						<a href="videoencoderconfig.html" class="tsd-kind-icon">Video<wbr>Encoder<wbr>Config</a>
206
+					</li>
207
+					<li class=" tsd-kind-interface">
208
+						<a href="videooption.html" class="tsd-kind-icon">Video<wbr>Option</a>
209
+					</li>
210
+					<li class=" tsd-kind-interface">
211
+						<a href="videostreamoption.html" class="tsd-kind-icon">Video<wbr>Stream<wbr>Option</a>
212
+					</li>
213
+					<li class=" tsd-kind-interface">
214
+						<a href="voicedecorator.html" class="tsd-kind-icon">Voice<wbr>Decorator</a>
215
+					</li>
216
+					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
217
+						<a href="../globals.html#callback" class="tsd-kind-icon">Callback</a>
218
+					</li>
219
+					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
220
+						<a href="../globals.html#nullable" class="tsd-kind-icon">Nullable</a>
221
+					</li>
222
+					<li class=" tsd-kind-type-alias">
223
+						<a href="../globals.html#number" class="tsd-kind-icon">Number</a>
224
+					</li>
225
+					<li class=" tsd-kind-type-alias">
226
+						<a href="../globals.html#string" class="tsd-kind-icon">String</a>
227
+					</li>
228
+					<li class=" tsd-kind-variable tsd-is-not-exported">
229
+						<a href="../globals.html#agora" class="tsd-kind-icon">Agora</a>
230
+					</li>
231
+					<li class=" tsd-kind-variable tsd-is-not-exported">
232
+						<a href="../globals.html#agoraeventemitter" class="tsd-kind-icon">Agora<wbr>Event<wbr>Emitter</a>
233
+					</li>
234
+					<li class=" tsd-kind-variable tsd-is-not-exported">
235
+						<a href="../globals.html#rctagoraview" class="tsd-kind-icon">RCTAgora<wbr>View</a>
236
+					</li>
237
+				</ul>
238
+			</nav>
239
+		</div>
240
+	</div>
241
+</div>
242
+<footer class="with-border-bottom">
243
+	<div class="container">
244
+		<h2>Legend</h2>
245
+		<div class="tsd-legend-group">
246
+			<ul class="tsd-legend">
247
+				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
248
+				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
249
+				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
250
+				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
251
+				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
252
+				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
253
+				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
254
+			</ul>
255
+			<ul class="tsd-legend">
256
+				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
257
+				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
258
+				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
259
+				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
260
+			</ul>
261
+			<ul class="tsd-legend">
262
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
263
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
264
+				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
265
+				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
266
+				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
267
+				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
268
+			</ul>
269
+			<ul class="tsd-legend">
270
+				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
271
+				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
272
+				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
273
+				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
274
+				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
275
+				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
276
+				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
277
+			</ul>
278
+			<ul class="tsd-legend">
279
+				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
280
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
281
+				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
282
+				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
283
+			</ul>
284
+			<ul class="tsd-legend">
285
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
286
+				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
287
+				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
288
+			</ul>
289
+			<ul class="tsd-legend">
290
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
291
+				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
292
+				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
293
+			</ul>
294
+			<ul class="tsd-legend">
295
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
296
+				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
297
+			</ul>
298
+		</div>
299
+	</div>
300
+</footer>
301
+<div class="container tsd-generator">
302
+	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
303
+</div>
304
+<div class="overlay"></div>
305
+<script src="../assets/js/main.js"></script>
306
+<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
307
+</body>
308
+</html>

+ 364
- 0
docs/api/interfaces/imageoption.html View File

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

+ 356
- 0
docs/api/interfaces/injectstreamoption.html View File

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

+ 371
- 0
docs/api/interfaces/lastmileprobeconfig.html View File

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

+ 490
- 0
docs/api/interfaces/livetranscodingoption.html View File

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>LiveTranscodingOption | 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="livetranscodingoption.html">LiveTranscodingOption</a>
60
+				</li>
61
+			</ul>
62
+			<h1>Interface LiveTranscodingOption</h1>
63
+		</div>
64
+	</div>
65
+</header>
66
+<div class="container container-main">
67
+	<div class="row">
68
+		<div class="col-8 col-content">
69
+			<section class="tsd-panel tsd-hierarchy">
70
+				<h3>Hierarchy</h3>
71
+				<ul class="tsd-hierarchy">
72
+					<li>
73
+						<span class="target">LiveTranscodingOption</span>
74
+					</li>
75
+				</ul>
76
+			</section>
77
+			<section class="tsd-panel-group tsd-index-group">
78
+				<h2>Index</h2>
79
+				<section class="tsd-panel tsd-index-panel">
80
+					<div class="tsd-index-content">
81
+						<section class="tsd-index-section ">
82
+							<h3>Properties</h3>
83
+							<ul class="tsd-index-list">
84
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#audiobitrate" class="tsd-kind-icon">audio<wbr>Bitrate</a></li>
85
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#audiochannels" class="tsd-kind-icon">audio<wbr>Channels</a></li>
86
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#audiosamplerate" class="tsd-kind-icon">audio<wbr>Sample<wbr>Rate</a></li>
87
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#backgroundcolor" class="tsd-kind-icon">background<wbr>Color</a></li>
88
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#backgroundimage" class="tsd-kind-icon">background<wbr>Image</a></li>
89
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#lowlatency" class="tsd-kind-icon">low<wbr>Latency</a></li>
90
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#size" class="tsd-kind-icon">size</a></li>
91
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#transcodingextrainfo" class="tsd-kind-icon">transcoding<wbr>Extra<wbr>Info</a></li>
92
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#transcodingusers" class="tsd-kind-icon">transcoding<wbr>Users</a></li>
93
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#videobitrate" class="tsd-kind-icon">video<wbr>Bitrate</a></li>
94
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#videocodecprofile" class="tsd-kind-icon">video<wbr>Codec<wbr>Profile</a></li>
95
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#videoframerate" class="tsd-kind-icon">video<wbr>Framerate</a></li>
96
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#videogop" class="tsd-kind-icon">video<wbr>Gop</a></li>
97
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="livetranscodingoption.html#watermark" class="tsd-kind-icon">watermark</a></li>
98
+							</ul>
99
+						</section>
100
+					</div>
101
+				</section>
102
+			</section>
103
+			<section class="tsd-panel-group tsd-member-group ">
104
+				<h2>Properties</h2>
105
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
106
+					<a name="audiobitrate" class="tsd-anchor"></a>
107
+					<h3>audio<wbr>Bitrate</h3>
108
+					<div class="tsd-signature tsd-kind-icon">audio<wbr>Bitrate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
109
+					<aside class="tsd-sources">
110
+						<ul>
111
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L119">types.ts:119</a></li>
112
+						</ul>
113
+					</aside>
114
+				</section>
115
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
116
+					<a name="audiochannels" class="tsd-anchor"></a>
117
+					<h3>audio<wbr>Channels</h3>
118
+					<div class="tsd-signature tsd-kind-icon">audio<wbr>Channels<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
119
+					<aside class="tsd-sources">
120
+						<ul>
121
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L120">types.ts:120</a></li>
122
+						</ul>
123
+					</aside>
124
+				</section>
125
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
126
+					<a name="audiosamplerate" class="tsd-anchor"></a>
127
+					<h3>audio<wbr>Sample<wbr>Rate</h3>
128
+					<div class="tsd-signature tsd-kind-icon">audio<wbr>Sample<wbr>Rate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
129
+					<aside class="tsd-sources">
130
+						<ul>
131
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L118">types.ts:118</a></li>
132
+						</ul>
133
+					</aside>
134
+				</section>
135
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
136
+					<a name="backgroundcolor" class="tsd-anchor"></a>
137
+					<h3>background<wbr>Color</h3>
138
+					<div class="tsd-signature tsd-kind-icon">background<wbr>Color<span class="tsd-signature-symbol">:</span> <a href="color.html" class="tsd-signature-type">Color</a></div>
139
+					<aside class="tsd-sources">
140
+						<ul>
141
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L117">types.ts:117</a></li>
142
+						</ul>
143
+					</aside>
144
+				</section>
145
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
146
+					<a name="backgroundimage" class="tsd-anchor"></a>
147
+					<h3>background<wbr>Image</h3>
148
+					<div class="tsd-signature tsd-kind-icon">background<wbr>Image<span class="tsd-signature-symbol">:</span> <a href="backgroundimage.html" class="tsd-signature-type">BackgroundImage</a></div>
149
+					<aside class="tsd-sources">
150
+						<ul>
151
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L116">types.ts:116</a></li>
152
+						</ul>
153
+					</aside>
154
+				</section>
155
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
156
+					<a name="lowlatency" class="tsd-anchor"></a>
157
+					<h3>low<wbr>Latency</h3>
158
+					<div class="tsd-signature tsd-kind-icon">low<wbr>Latency<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
159
+					<aside class="tsd-sources">
160
+						<ul>
161
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L110">types.ts:110</a></li>
162
+						</ul>
163
+					</aside>
164
+				</section>
165
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
166
+					<a name="size" class="tsd-anchor"></a>
167
+					<h3>size</h3>
168
+					<div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <a href="size.html" class="tsd-signature-type">Size</a></div>
169
+					<aside class="tsd-sources">
170
+						<ul>
171
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L107">types.ts:107</a></li>
172
+						</ul>
173
+					</aside>
174
+				</section>
175
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
176
+					<a name="transcodingextrainfo" class="tsd-anchor"></a>
177
+					<h3>transcoding<wbr>Extra<wbr>Info</h3>
178
+					<div class="tsd-signature tsd-kind-icon">transcoding<wbr>Extra<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
179
+					<aside class="tsd-sources">
180
+						<ul>
181
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L114">types.ts:114</a></li>
182
+						</ul>
183
+					</aside>
184
+				</section>
185
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
186
+					<a name="transcodingusers" class="tsd-anchor"></a>
187
+					<h3>transcoding<wbr>Users</h3>
188
+					<div class="tsd-signature tsd-kind-icon">transcoding<wbr>Users<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="transcodinguser.html" class="tsd-signature-type">TranscodingUser</a><span class="tsd-signature-symbol">&gt;</span></div>
189
+					<aside class="tsd-sources">
190
+						<ul>
191
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L113">types.ts:113</a></li>
192
+						</ul>
193
+					</aside>
194
+				</section>
195
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
196
+					<a name="videobitrate" class="tsd-anchor"></a>
197
+					<h3>video<wbr>Bitrate</h3>
198
+					<div class="tsd-signature tsd-kind-icon">video<wbr>Bitrate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
199
+					<aside class="tsd-sources">
200
+						<ul>
201
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L108">types.ts:108</a></li>
202
+						</ul>
203
+					</aside>
204
+				</section>
205
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
206
+					<a name="videocodecprofile" class="tsd-anchor"></a>
207
+					<h3>video<wbr>Codec<wbr>Profile</h3>
208
+					<div class="tsd-signature tsd-kind-icon">video<wbr>Codec<wbr>Profile<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
209
+					<aside class="tsd-sources">
210
+						<ul>
211
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L112">types.ts:112</a></li>
212
+						</ul>
213
+					</aside>
214
+				</section>
215
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
216
+					<a name="videoframerate" class="tsd-anchor"></a>
217
+					<h3>video<wbr>Framerate</h3>
218
+					<div class="tsd-signature tsd-kind-icon">video<wbr>Framerate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
219
+					<aside class="tsd-sources">
220
+						<ul>
221
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L109">types.ts:109</a></li>
222
+						</ul>
223
+					</aside>
224
+				</section>
225
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
226
+					<a name="videogop" class="tsd-anchor"></a>
227
+					<h3>video<wbr>Gop</h3>
228
+					<div class="tsd-signature tsd-kind-icon">video<wbr>Gop<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
229
+					<aside class="tsd-sources">
230
+						<ul>
231
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L111">types.ts:111</a></li>
232
+						</ul>
233
+					</aside>
234
+				</section>
235
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
236
+					<a name="watermark" class="tsd-anchor"></a>
237
+					<h3>watermark</h3>
238
+					<div class="tsd-signature tsd-kind-icon">watermark<span class="tsd-signature-symbol">:</span> <a href="backgroundimage.html" class="tsd-signature-type">BackgroundImage</a></div>
239
+					<aside class="tsd-sources">
240
+						<ul>
241
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L115">types.ts:115</a></li>
242
+						</ul>
243
+					</aside>
244
+				</section>
245
+			</section>
246
+		</div>
247
+		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
248
+			<nav class="tsd-navigation primary">
249
+				<ul>
250
+					<li class="globals  ">
251
+						<a href="../globals.html"><em>Globals</em></a>
252
+					</li>
253
+				</ul>
254
+			</nav>
255
+			<nav class="tsd-navigation secondary menu-sticky">
256
+				<ul class="before-current">
257
+					<li class=" tsd-kind-class tsd-has-type-parameter">
258
+						<a href="../classes/agoraview.html" class="tsd-kind-icon">Agora<wbr>View</a>
259
+					</li>
260
+					<li class=" tsd-kind-class">
261
+						<a href="../classes/rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
262
+					</li>
263
+					<li class=" tsd-kind-interface">
264
+						<a href="agoraviewprops.html" class="tsd-kind-icon">Agora<wbr>View<wbr>Props</a>
265
+					</li>
266
+					<li class=" tsd-kind-interface">
267
+						<a href="audioframeoption.html" class="tsd-kind-icon">Audio<wbr>Frame<wbr>Option</a>
268
+					</li>
269
+					<li class=" tsd-kind-interface">
270
+						<a href="audiomixingoption.html" class="tsd-kind-icon">Audio<wbr>Mixing<wbr>Option</a>
271
+					</li>
272
+					<li class=" tsd-kind-interface">
273
+						<a href="audiorecordingoption.html" class="tsd-kind-icon">Audio<wbr>Recording<wbr>Option</a>
274
+					</li>
275
+					<li class=" tsd-kind-interface">
276
+						<a href="backgroundimage.html" class="tsd-kind-icon">Background<wbr>Image</a>
277
+					</li>
278
+					<li class=" tsd-kind-interface">
279
+						<a href="beautyoption.html" class="tsd-kind-icon">Beauty<wbr>Option</a>
280
+					</li>
281
+					<li class=" tsd-kind-interface">
282
+						<a href="cameracapturerconfiguration.html" class="tsd-kind-icon">Camera<wbr>Capturer<wbr>Configuration</a>
283
+					</li>
284
+					<li class=" tsd-kind-interface">
285
+						<a href="color.html" class="tsd-kind-icon">Color</a>
286
+					</li>
287
+					<li class=" tsd-kind-interface">
288
+						<a href="datastreamoption.html" class="tsd-kind-icon">Data<wbr>Stream<wbr>Option</a>
289
+					</li>
290
+					<li class=" tsd-kind-interface">
291
+						<a href="defaultvideostreamoption.html" class="tsd-kind-icon">Default<wbr>Video<wbr>Stream<wbr>Option</a>
292
+					</li>
293
+					<li class=" tsd-kind-interface">
294
+						<a href="imageoption.html" class="tsd-kind-icon">Image<wbr>Option</a>
295
+					</li>
296
+					<li class=" tsd-kind-interface">
297
+						<a href="injectstreamoption.html" class="tsd-kind-icon">Inject<wbr>Stream<wbr>Option</a>
298
+					</li>
299
+					<li class=" tsd-kind-interface">
300
+						<a href="lastmileprobeconfig.html" class="tsd-kind-icon">Lastmile<wbr>Probe<wbr>Config</a>
301
+					</li>
302
+				</ul>
303
+				<ul class="current">
304
+					<li class="current tsd-kind-interface">
305
+						<a href="livetranscodingoption.html" class="tsd-kind-icon">Live<wbr>Transcoding<wbr>Option</a>
306
+						<ul>
307
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
308
+								<a href="livetranscodingoption.html#audiobitrate" class="tsd-kind-icon">audio<wbr>Bitrate</a>
309
+							</li>
310
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
311
+								<a href="livetranscodingoption.html#audiochannels" class="tsd-kind-icon">audio<wbr>Channels</a>
312
+							</li>
313
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
314
+								<a href="livetranscodingoption.html#audiosamplerate" class="tsd-kind-icon">audio<wbr>Sample<wbr>Rate</a>
315
+							</li>
316
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
317
+								<a href="livetranscodingoption.html#backgroundcolor" class="tsd-kind-icon">background<wbr>Color</a>
318
+							</li>
319
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
320
+								<a href="livetranscodingoption.html#backgroundimage" class="tsd-kind-icon">background<wbr>Image</a>
321
+							</li>
322
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
323
+								<a href="livetranscodingoption.html#lowlatency" class="tsd-kind-icon">low<wbr>Latency</a>
324
+							</li>
325
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
326
+								<a href="livetranscodingoption.html#size" class="tsd-kind-icon">size</a>
327
+							</li>
328
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
329
+								<a href="livetranscodingoption.html#transcodingextrainfo" class="tsd-kind-icon">transcoding<wbr>Extra<wbr>Info</a>
330
+							</li>
331
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
332
+								<a href="livetranscodingoption.html#transcodingusers" class="tsd-kind-icon">transcoding<wbr>Users</a>
333
+							</li>
334
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
335
+								<a href="livetranscodingoption.html#videobitrate" class="tsd-kind-icon">video<wbr>Bitrate</a>
336
+							</li>
337
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
338
+								<a href="livetranscodingoption.html#videocodecprofile" class="tsd-kind-icon">video<wbr>Codec<wbr>Profile</a>
339
+							</li>
340
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
341
+								<a href="livetranscodingoption.html#videoframerate" class="tsd-kind-icon">video<wbr>Framerate</a>
342
+							</li>
343
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
344
+								<a href="livetranscodingoption.html#videogop" class="tsd-kind-icon">video<wbr>Gop</a>
345
+							</li>
346
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
347
+								<a href="livetranscodingoption.html#watermark" class="tsd-kind-icon">watermark</a>
348
+							</li>
349
+						</ul>
350
+					</li>
351
+				</ul>
352
+				<ul class="after-current">
353
+					<li class=" tsd-kind-interface">
354
+						<a href="mixedaudioframeoption.html" class="tsd-kind-icon">Mixed<wbr>Audio<wbr>Frame<wbr>Option</a>
355
+					</li>
356
+					<li class=" tsd-kind-interface">
357
+						<a href="option.html" class="tsd-kind-icon">Option</a>
358
+					</li>
359
+					<li class=" tsd-kind-interface">
360
+						<a href="playeffectoption.html" class="tsd-kind-icon">Play<wbr>Effect<wbr>Option</a>
361
+					</li>
362
+					<li class=" tsd-kind-interface">
363
+						<a href="positionoption.html" class="tsd-kind-icon">Position<wbr>Option</a>
364
+					</li>
365
+					<li class=" tsd-kind-interface">
366
+						<a href="publishstreamoption.html" class="tsd-kind-icon">Publish<wbr>Stream<wbr>Option</a>
367
+					</li>
368
+					<li class=" tsd-kind-interface">
369
+						<a href="publisherconfig.html" class="tsd-kind-icon">Publisher<wbr>Config</a>
370
+					</li>
371
+					<li class=" tsd-kind-interface">
372
+						<a href="rect.html" class="tsd-kind-icon">Rect</a>
373
+					</li>
374
+					<li class=" tsd-kind-interface">
375
+						<a href="removeinjectstreamoption.html" class="tsd-kind-icon">Remove<wbr>Inject<wbr>Stream<wbr>Option</a>
376
+					</li>
377
+					<li class=" tsd-kind-interface">
378
+						<a href="removepublishstreamoption.html" class="tsd-kind-icon">Remove<wbr>Publish<wbr>Stream<wbr>Option</a>
379
+					</li>
380
+					<li class=" tsd-kind-interface">
381
+						<a href="size.html" class="tsd-kind-icon">Size</a>
382
+					</li>
383
+					<li class=" tsd-kind-interface">
384
+						<a href="transcodinguser.html" class="tsd-kind-icon">Transcoding<wbr>User</a>
385
+					</li>
386
+					<li class=" tsd-kind-interface">
387
+						<a href="videoencoderconfig.html" class="tsd-kind-icon">Video<wbr>Encoder<wbr>Config</a>
388
+					</li>
389
+					<li class=" tsd-kind-interface">
390
+						<a href="videooption.html" class="tsd-kind-icon">Video<wbr>Option</a>
391
+					</li>
392
+					<li class=" tsd-kind-interface">
393
+						<a href="videostreamoption.html" class="tsd-kind-icon">Video<wbr>Stream<wbr>Option</a>
394
+					</li>
395
+					<li class=" tsd-kind-interface">
396
+						<a href="voicedecorator.html" class="tsd-kind-icon">Voice<wbr>Decorator</a>
397
+					</li>
398
+					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
399
+						<a href="../globals.html#callback" class="tsd-kind-icon">Callback</a>
400
+					</li>
401
+					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
402
+						<a href="../globals.html#nullable" class="tsd-kind-icon">Nullable</a>
403
+					</li>
404
+					<li class=" tsd-kind-type-alias">
405
+						<a href="../globals.html#number" class="tsd-kind-icon">Number</a>
406
+					</li>
407
+					<li class=" tsd-kind-type-alias">
408
+						<a href="../globals.html#string" class="tsd-kind-icon">String</a>
409
+					</li>
410
+					<li class=" tsd-kind-variable tsd-is-not-exported">
411
+						<a href="../globals.html#agora" class="tsd-kind-icon">Agora</a>
412
+					</li>
413
+					<li class=" tsd-kind-variable tsd-is-not-exported">
414
+						<a href="../globals.html#agoraeventemitter" class="tsd-kind-icon">Agora<wbr>Event<wbr>Emitter</a>
415
+					</li>
416
+					<li class=" tsd-kind-variable tsd-is-not-exported">
417
+						<a href="../globals.html#rctagoraview" class="tsd-kind-icon">RCTAgora<wbr>View</a>
418
+					</li>
419
+				</ul>
420
+			</nav>
421
+		</div>
422
+	</div>
423
+</div>
424
+<footer class="with-border-bottom">
425
+	<div class="container">
426
+		<h2>Legend</h2>
427
+		<div class="tsd-legend-group">
428
+			<ul class="tsd-legend">
429
+				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
430
+				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
431
+				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
432
+				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
433
+				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
434
+				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
435
+				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
436
+			</ul>
437
+			<ul class="tsd-legend">
438
+				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
439
+				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
440
+				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
441
+				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
442
+			</ul>
443
+			<ul class="tsd-legend">
444
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
445
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
446
+				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
447
+				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
448
+				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
449
+				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
450
+			</ul>
451
+			<ul class="tsd-legend">
452
+				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
453
+				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
454
+				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
455
+				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
456
+				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
457
+				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
458
+				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
459
+			</ul>
460
+			<ul class="tsd-legend">
461
+				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
462
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
463
+				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
464
+				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
465
+			</ul>
466
+			<ul class="tsd-legend">
467
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
468
+				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
469
+				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
470
+			</ul>
471
+			<ul class="tsd-legend">
472
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
473
+				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
474
+				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
475
+			</ul>
476
+			<ul class="tsd-legend">
477
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
478
+				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
479
+			</ul>
480
+		</div>
481
+	</div>
482
+</footer>
483
+<div class="container tsd-generator">
484
+	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
485
+</div>
486
+<div class="overlay"></div>
487
+<script src="../assets/js/main.js"></script>
488
+<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
489
+</body>
490
+</html>

+ 322
- 0
docs/api/interfaces/mixedaudioframeoption.html View File

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

+ 467
- 0
docs/api/interfaces/option.html View File

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>Option | 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="option.html">Option</a>
60
+				</li>
61
+			</ul>
62
+			<h1>Interface Option</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>Option is work for init method</p>
73
+					</div>
74
+					<dl class="tsd-comment-tags">
75
+						<dt>property:</dt>
76
+						<dd><p>string appid Sets the appid</p>
77
+						</dd>
78
+						<dt>property:</dt>
79
+						<dd><p>number channelProfile Sets the channel mode. 0 is communication mode, 1 is broadcasting mode</p>
80
+						</dd>
81
+						<dt>property:</dt>
82
+						<dd><p><a href="videoencoderconfig.html">VideoEncoderConfig</a> sets video encoding config</p>
83
+						</dd>
84
+						<dt>property:</dt>
85
+						<dd><p>mode is optional sets only enable video / audio, 0 is audio mode, 1 is video mode</p>
86
+						</dd>
87
+						<dt>property:</dt>
88
+						<dd><p>clientRole is only work in live mode, 1 is host, 2 is audience</p>
89
+						</dd>
90
+						<dt>property:</dt>
91
+						<dd><p>dualStream is optional parameter only for enable for detail see <a href="https://docs.agora.io/en/Video/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/enableDualStreamMode:" class="external">https://docs.agora.io/en/Video/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/enableDualStreamMode:</a></p>
92
+						</dd>
93
+						<dt>property:</dt>
94
+						<dd><p>audioProfile <a href="https://docs.agora.io/en/Video/API%20Reference/oc/Constants/AgoraAudioProfile.html" class="external">https://docs.agora.io/en/Video/API%20Reference/oc/Constants/AgoraAudioProfile.html</a></p>
95
+						</dd>
96
+						<dt>property:</dt>
97
+						<dd><p>audioScenario <a href="https://docs.agora.io/en/Video/API%20Reference/oc/Constants/AgoraAudioScenario.html" class="external">https://docs.agora.io/en/Video/API%20Reference/oc/Constants/AgoraAudioScenario.html</a></p>
98
+						</dd>
99
+					</dl>
100
+				</div>
101
+			</section>
102
+			<section class="tsd-panel tsd-hierarchy">
103
+				<h3>Hierarchy</h3>
104
+				<ul class="tsd-hierarchy">
105
+					<li>
106
+						<span class="target">Option</span>
107
+					</li>
108
+				</ul>
109
+			</section>
110
+			<section class="tsd-panel-group tsd-index-group">
111
+				<h2>Index</h2>
112
+				<section class="tsd-panel tsd-index-panel">
113
+					<div class="tsd-index-content">
114
+						<section class="tsd-index-section ">
115
+							<h3>Properties</h3>
116
+							<ul class="tsd-index-list">
117
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="option.html#appid" class="tsd-kind-icon">appid</a></li>
118
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="option.html#audioprofile" class="tsd-kind-icon">audio<wbr>Profile</a></li>
119
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="option.html#audioscenario" class="tsd-kind-icon">audio<wbr>Scenario</a></li>
120
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="option.html#beauty" class="tsd-kind-icon">beauty</a></li>
121
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="option.html#channelprofile" class="tsd-kind-icon">channel<wbr>Profile</a></li>
122
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="option.html#clientrole" class="tsd-kind-icon">client<wbr>Role</a></li>
123
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="option.html#dualstream" class="tsd-kind-icon">dual<wbr>Stream</a></li>
124
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="option.html#mode" class="tsd-kind-icon">mode</a></li>
125
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="option.html#videoencoderconfig" class="tsd-kind-icon">video<wbr>Encoder<wbr>Config</a></li>
126
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="option.html#voice" class="tsd-kind-icon">voice</a></li>
127
+							</ul>
128
+						</section>
129
+					</div>
130
+				</section>
131
+			</section>
132
+			<section class="tsd-panel-group tsd-member-group ">
133
+				<h2>Properties</h2>
134
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
135
+					<a name="appid" class="tsd-anchor"></a>
136
+					<h3>appid</h3>
137
+					<div class="tsd-signature tsd-kind-icon">appid<span class="tsd-signature-symbol">:</span> <a href="../globals.html#string" class="tsd-signature-type">String</a></div>
138
+					<aside class="tsd-sources">
139
+						<ul>
140
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L33">types.ts:33</a></li>
141
+						</ul>
142
+					</aside>
143
+				</section>
144
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
145
+					<a name="audioprofile" class="tsd-anchor"></a>
146
+					<h3>audio<wbr>Profile</h3>
147
+					<div class="tsd-signature tsd-kind-icon">audio<wbr>Profile<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
148
+					<aside class="tsd-sources">
149
+						<ul>
150
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L39">types.ts:39</a></li>
151
+						</ul>
152
+					</aside>
153
+				</section>
154
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
155
+					<a name="audioscenario" class="tsd-anchor"></a>
156
+					<h3>audio<wbr>Scenario</h3>
157
+					<div class="tsd-signature tsd-kind-icon">audio<wbr>Scenario<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
158
+					<aside class="tsd-sources">
159
+						<ul>
160
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L40">types.ts:40</a></li>
161
+						</ul>
162
+					</aside>
163
+				</section>
164
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
165
+					<a name="beauty" class="tsd-anchor"></a>
166
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> beauty</h3>
167
+					<div class="tsd-signature tsd-kind-icon">beauty<span class="tsd-signature-symbol">:</span> <a href="beautyoption.html" class="tsd-signature-type">BeautyOption</a></div>
168
+					<aside class="tsd-sources">
169
+						<ul>
170
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L41">types.ts:41</a></li>
171
+						</ul>
172
+					</aside>
173
+				</section>
174
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
175
+					<a name="channelprofile" class="tsd-anchor"></a>
176
+					<h3>channel<wbr>Profile</h3>
177
+					<div class="tsd-signature tsd-kind-icon">channel<wbr>Profile<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
178
+					<aside class="tsd-sources">
179
+						<ul>
180
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L34">types.ts:34</a></li>
181
+						</ul>
182
+					</aside>
183
+				</section>
184
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
185
+					<a name="clientrole" class="tsd-anchor"></a>
186
+					<h3>client<wbr>Role</h3>
187
+					<div class="tsd-signature tsd-kind-icon">client<wbr>Role<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
188
+					<aside class="tsd-sources">
189
+						<ul>
190
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L38">types.ts:38</a></li>
191
+						</ul>
192
+					</aside>
193
+				</section>
194
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
195
+					<a name="dualstream" class="tsd-anchor"></a>
196
+					<h3>dual<wbr>Stream</h3>
197
+					<div class="tsd-signature tsd-kind-icon">dual<wbr>Stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
198
+					<aside class="tsd-sources">
199
+						<ul>
200
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L36">types.ts:36</a></li>
201
+						</ul>
202
+					</aside>
203
+				</section>
204
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
205
+					<a name="mode" class="tsd-anchor"></a>
206
+					<h3>mode</h3>
207
+					<div class="tsd-signature tsd-kind-icon">mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
208
+					<aside class="tsd-sources">
209
+						<ul>
210
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L37">types.ts:37</a></li>
211
+						</ul>
212
+					</aside>
213
+				</section>
214
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
215
+					<a name="videoencoderconfig" class="tsd-anchor"></a>
216
+					<h3>video<wbr>Encoder<wbr>Config</h3>
217
+					<div class="tsd-signature tsd-kind-icon">video<wbr>Encoder<wbr>Config<span class="tsd-signature-symbol">:</span> <a href="videoencoderconfig.html" class="tsd-signature-type">VideoEncoderConfig</a></div>
218
+					<aside class="tsd-sources">
219
+						<ul>
220
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L35">types.ts:35</a></li>
221
+						</ul>
222
+					</aside>
223
+				</section>
224
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
225
+					<a name="voice" class="tsd-anchor"></a>
226
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> voice</h3>
227
+					<div class="tsd-signature tsd-kind-icon">voice<span class="tsd-signature-symbol">:</span> <a href="voicedecorator.html" class="tsd-signature-type">VoiceDecorator</a></div>
228
+					<aside class="tsd-sources">
229
+						<ul>
230
+							<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L42">types.ts:42</a></li>
231
+						</ul>
232
+					</aside>
233
+				</section>
234
+			</section>
235
+		</div>
236
+		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
237
+			<nav class="tsd-navigation primary">
238
+				<ul>
239
+					<li class="globals  ">
240
+						<a href="../globals.html"><em>Globals</em></a>
241
+					</li>
242
+				</ul>
243
+			</nav>
244
+			<nav class="tsd-navigation secondary menu-sticky">
245
+				<ul class="before-current">
246
+					<li class=" tsd-kind-class tsd-has-type-parameter">
247
+						<a href="../classes/agoraview.html" class="tsd-kind-icon">Agora<wbr>View</a>
248
+					</li>
249
+					<li class=" tsd-kind-class">
250
+						<a href="../classes/rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
251
+					</li>
252
+					<li class=" tsd-kind-interface">
253
+						<a href="agoraviewprops.html" class="tsd-kind-icon">Agora<wbr>View<wbr>Props</a>
254
+					</li>
255
+					<li class=" tsd-kind-interface">
256
+						<a href="audioframeoption.html" class="tsd-kind-icon">Audio<wbr>Frame<wbr>Option</a>
257
+					</li>
258
+					<li class=" tsd-kind-interface">
259
+						<a href="audiomixingoption.html" class="tsd-kind-icon">Audio<wbr>Mixing<wbr>Option</a>
260
+					</li>
261
+					<li class=" tsd-kind-interface">
262
+						<a href="audiorecordingoption.html" class="tsd-kind-icon">Audio<wbr>Recording<wbr>Option</a>
263
+					</li>
264
+					<li class=" tsd-kind-interface">
265
+						<a href="backgroundimage.html" class="tsd-kind-icon">Background<wbr>Image</a>
266
+					</li>
267
+					<li class=" tsd-kind-interface">
268
+						<a href="beautyoption.html" class="tsd-kind-icon">Beauty<wbr>Option</a>
269
+					</li>
270
+					<li class=" tsd-kind-interface">
271
+						<a href="cameracapturerconfiguration.html" class="tsd-kind-icon">Camera<wbr>Capturer<wbr>Configuration</a>
272
+					</li>
273
+					<li class=" tsd-kind-interface">
274
+						<a href="color.html" class="tsd-kind-icon">Color</a>
275
+					</li>
276
+					<li class=" tsd-kind-interface">
277
+						<a href="datastreamoption.html" class="tsd-kind-icon">Data<wbr>Stream<wbr>Option</a>
278
+					</li>
279
+					<li class=" tsd-kind-interface">
280
+						<a href="defaultvideostreamoption.html" class="tsd-kind-icon">Default<wbr>Video<wbr>Stream<wbr>Option</a>
281
+					</li>
282
+					<li class=" tsd-kind-interface">
283
+						<a href="imageoption.html" class="tsd-kind-icon">Image<wbr>Option</a>
284
+					</li>
285
+					<li class=" tsd-kind-interface">
286
+						<a href="injectstreamoption.html" class="tsd-kind-icon">Inject<wbr>Stream<wbr>Option</a>
287
+					</li>
288
+					<li class=" tsd-kind-interface">
289
+						<a href="lastmileprobeconfig.html" class="tsd-kind-icon">Lastmile<wbr>Probe<wbr>Config</a>
290
+					</li>
291
+					<li class=" tsd-kind-interface">
292
+						<a href="livetranscodingoption.html" class="tsd-kind-icon">Live<wbr>Transcoding<wbr>Option</a>
293
+					</li>
294
+					<li class=" tsd-kind-interface">
295
+						<a href="mixedaudioframeoption.html" class="tsd-kind-icon">Mixed<wbr>Audio<wbr>Frame<wbr>Option</a>
296
+					</li>
297
+				</ul>
298
+				<ul class="current">
299
+					<li class="current tsd-kind-interface">
300
+						<a href="option.html" class="tsd-kind-icon">Option</a>
301
+						<ul>
302
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
303
+								<a href="option.html#appid" class="tsd-kind-icon">appid</a>
304
+							</li>
305
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
306
+								<a href="option.html#audioprofile" class="tsd-kind-icon">audio<wbr>Profile</a>
307
+							</li>
308
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
309
+								<a href="option.html#audioscenario" class="tsd-kind-icon">audio<wbr>Scenario</a>
310
+							</li>
311
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
312
+								<a href="option.html#beauty" class="tsd-kind-icon">beauty</a>
313
+							</li>
314
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
315
+								<a href="option.html#channelprofile" class="tsd-kind-icon">channel<wbr>Profile</a>
316
+							</li>
317
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
318
+								<a href="option.html#clientrole" class="tsd-kind-icon">client<wbr>Role</a>
319
+							</li>
320
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
321
+								<a href="option.html#dualstream" class="tsd-kind-icon">dual<wbr>Stream</a>
322
+							</li>
323
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
324
+								<a href="option.html#mode" class="tsd-kind-icon">mode</a>
325
+							</li>
326
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
327
+								<a href="option.html#videoencoderconfig" class="tsd-kind-icon">video<wbr>Encoder<wbr>Config</a>
328
+							</li>
329
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
330
+								<a href="option.html#voice" class="tsd-kind-icon">voice</a>
331
+							</li>
332
+						</ul>
333
+					</li>
334
+				</ul>
335
+				<ul class="after-current">
336
+					<li class=" tsd-kind-interface">
337
+						<a href="playeffectoption.html" class="tsd-kind-icon">Play<wbr>Effect<wbr>Option</a>
338
+					</li>
339
+					<li class=" tsd-kind-interface">
340
+						<a href="positionoption.html" class="tsd-kind-icon">Position<wbr>Option</a>
341
+					</li>
342
+					<li class=" tsd-kind-interface">
343
+						<a href="publishstreamoption.html" class="tsd-kind-icon">Publish<wbr>Stream<wbr>Option</a>
344
+					</li>
345
+					<li class=" tsd-kind-interface">
346
+						<a href="publisherconfig.html" class="tsd-kind-icon">Publisher<wbr>Config</a>
347
+					</li>
348
+					<li class=" tsd-kind-interface">
349
+						<a href="rect.html" class="tsd-kind-icon">Rect</a>
350
+					</li>
351
+					<li class=" tsd-kind-interface">
352
+						<a href="removeinjectstreamoption.html" class="tsd-kind-icon">Remove<wbr>Inject<wbr>Stream<wbr>Option</a>
353
+					</li>
354
+					<li class=" tsd-kind-interface">
355
+						<a href="removepublishstreamoption.html" class="tsd-kind-icon">Remove<wbr>Publish<wbr>Stream<wbr>Option</a>
356
+					</li>
357
+					<li class=" tsd-kind-interface">
358
+						<a href="size.html" class="tsd-kind-icon">Size</a>
359
+					</li>
360
+					<li class=" tsd-kind-interface">
361
+						<a href="transcodinguser.html" class="tsd-kind-icon">Transcoding<wbr>User</a>
362
+					</li>
363
+					<li class=" tsd-kind-interface">
364
+						<a href="videoencoderconfig.html" class="tsd-kind-icon">Video<wbr>Encoder<wbr>Config</a>
365
+					</li>
366
+					<li class=" tsd-kind-interface">
367
+						<a href="videooption.html" class="tsd-kind-icon">Video<wbr>Option</a>
368
+					</li>
369
+					<li class=" tsd-kind-interface">
370
+						<a href="videostreamoption.html" class="tsd-kind-icon">Video<wbr>Stream<wbr>Option</a>
371
+					</li>
372
+					<li class=" tsd-kind-interface">
373
+						<a href="voicedecorator.html" class="tsd-kind-icon">Voice<wbr>Decorator</a>
374
+					</li>
375
+					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
376
+						<a href="../globals.html#callback" class="tsd-kind-icon">Callback</a>
377
+					</li>
378
+					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
379
+						<a href="../globals.html#nullable" class="tsd-kind-icon">Nullable</a>
380
+					</li>
381
+					<li class=" tsd-kind-type-alias">
382
+						<a href="../globals.html#number" class="tsd-kind-icon">Number</a>
383
+					</li>
384
+					<li class=" tsd-kind-type-alias">
385
+						<a href="../globals.html#string" class="tsd-kind-icon">String</a>
386
+					</li>
387
+					<li class=" tsd-kind-variable tsd-is-not-exported">
388
+						<a href="../globals.html#agora" class="tsd-kind-icon">Agora</a>
389
+					</li>
390
+					<li class=" tsd-kind-variable tsd-is-not-exported">
391
+						<a href="../globals.html#agoraeventemitter" class="tsd-kind-icon">Agora<wbr>Event<wbr>Emitter</a>
392
+					</li>
393
+					<li class=" tsd-kind-variable tsd-is-not-exported">
394
+						<a href="../globals.html#rctagoraview" class="tsd-kind-icon">RCTAgora<wbr>View</a>
395
+					</li>
396
+				</ul>
397
+			</nav>
398
+		</div>
399
+	</div>
400
+</div>
401
+<footer class="with-border-bottom">
402
+	<div class="container">
403
+		<h2>Legend</h2>
404
+		<div class="tsd-legend-group">
405
+			<ul class="tsd-legend">
406
+				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
407
+				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
408
+				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
409
+				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
410
+				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
411
+				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
412
+				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
413
+			</ul>
414
+			<ul class="tsd-legend">
415
+				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
416
+				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
417
+				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
418
+				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
419
+			</ul>
420
+			<ul class="tsd-legend">
421
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
422
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
423
+				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
424
+				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
425
+				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
426
+				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
427
+			</ul>
428
+			<ul class="tsd-legend">
429
+				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
430
+				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
431
+				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
432
+				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
433
+				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
434
+				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
435
+				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
436
+			</ul>
437
+			<ul class="tsd-legend">
438
+				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
439
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
440
+				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
441
+				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
442
+			</ul>
443
+			<ul class="tsd-legend">
444
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
445
+				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
446
+				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
447
+			</ul>
448
+			<ul class="tsd-legend">
449
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
450
+				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
451
+				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
452
+			</ul>
453
+			<ul class="tsd-legend">
454
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
455
+				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
456
+			</ul>
457
+		</div>
458
+	</div>
459
+</footer>
460
+<div class="container tsd-generator">
461
+	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
462
+</div>
463
+<div class="overlay"></div>
464
+<script src="../assets/js/main.js"></script>
465
+<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
466
+</body>
467
+</html>

+ 392
- 0
docs/api/interfaces/playeffectoption.html View File

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

+ 322
- 0
docs/api/interfaces/positionoption.html View File

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

+ 434
- 0
docs/api/interfaces/publisherconfig.html View File

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

+ 322
- 0
docs/api/interfaces/publishstreamoption.html View File

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

+ 350
- 0
docs/api/interfaces/rect.html View File

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

+ 308
- 0
docs/api/interfaces/removeinjectstreamoption.html View File

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

+ 308
- 0
docs/api/interfaces/removepublishstreamoption.html View File

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

+ 322
- 0
docs/api/interfaces/size.html View File

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

+ 364
- 0
docs/api/interfaces/transcodinguser.html View File

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

+ 391
- 0
docs/api/interfaces/videoencoderconfig.html View File

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

+ 336
- 0
docs/api/interfaces/videooption.html View File

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

+ 322
- 0
docs/api/interfaces/videostreamoption.html View File

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

+ 339
- 0
docs/api/interfaces/voicedecorator.html View File

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