ホーム エクスプローラ ヘルプ
サインイン
githab
/
urtc-sdk-web
2
0
Fork 0
ファイル 課題 0 プルリクエスト 0 Wiki
ツリー: 0fe2872bb8
ブランチ タグ
urtc-sdk-web
/
docs
/
index.html

index.html 98 KB
履歴 Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468 
  1. <!doctype html>
    2. 

  2. <html class="default no-js">
    3. 

  3. <head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    6. 

  6. 	<title>@urtc/sdk-web</title>
    7. 

  7. 	<meta name="description" content="Documentation for @urtc/sdk-web">
    8. 

  8. 	<meta name="viewport" content="width=device-width, initial-scale=1">
    9. 

  9. 	<link rel="stylesheet" href="assets/css/main.css">
    10. 

  10. 	<script async src="assets/js/search.js" id="search-script"></script>
    11. 

  11. </head>
    12. 

  12. <body>
    13. 

  13. <header>
    14. 

  14. 	<div class="tsd-page-toolbar">
    15. 

  15. 		<div class="container">
    16. 

  16. 			<div class="table-wrap">
    17. 

  17. 				<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
    18. 

  18. 					<div class="field">
    19. 

  19. 						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
    20. 

  20. 						<input id="tsd-search-field" type="text" />
    21. 

  21. 					</div>
    22. 

  22. 					<ul class="results">
    23. 

  23. 						<li class="state loading">Preparing search index...</li>
    24. 

  24. 						<li class="state failure">The search index is not available</li>
    25. 

  25. 					</ul>
    26. 

  26. 					<a href="index.html" class="title">@urtc/sdk-web</a>
    27. 

  27. 				</div>
    28. 

  28. 				<div class="table-cell" id="tsd-widgets">
    29. 

  29. 					<div id="tsd-filter">
    30. 

  30. 						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
    31. 

  31. 						<div class="tsd-filter-group">
    32. 

  32. 							<div class="tsd-select" id="tsd-filter-visibility">
    33. 

  33. 								<span class="tsd-select-label">All</span>
    34. 

  34. 								<ul class="tsd-select-list">
    35. 

  35. 									<li data-value="public">Public</li>
    36. 

  36. 									<li data-value="protected">Public/Protected</li>
    37. 

  37. 									<li data-value="private" class="selected">All</li>
    38. 

  38. 								</ul>
    39. 

  39. 							</div>
    40. 

  40. 							<input type="checkbox" id="tsd-filter-inherited" checked />
    41. 

  41. 							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
    42. 

  42. 							<input type="checkbox" id="tsd-filter-externals" checked />
    43. 

  43. 							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
    44. 

  44. 						</div>
    45. 

  45. 					</div>
    46. 

  46. 					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
    47. 

  47. 				</div>
    48. 

  48. 			</div>
    49. 

  49. 		</div>
    50. 

  50. 	</div>
    51. 

  51. 	<div class="tsd-page-title">
    52. 

  52. 		<div class="container">
    53. 

  53. 			<h1>@urtc/sdk-web</h1>
    54. 

  54. 		</div>
    55. 

  55. 	</div>
    56. 

  56. </header>
    57. 

  57. <div class="container container-main">
    58. 

  58. 	<div class="row">
    59. 

  59. 		<div class="col-8 col-content">
    60. 

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

  61. 				<h2>Index</h2>
    62. 

  62. 				<section class="tsd-panel tsd-index-panel">
    63. 

  63. 					<div class="tsd-index-content">
    64. 

  64. 						<section class="tsd-index-section ">
    65. 

  65. 							<h3>Classes</h3>
    66. 

  66. 							<ul class="tsd-index-list">
    67. 

  67. 								<li class="tsd-kind-class"><a href="classes/client.html" class="tsd-kind-icon">Client</a></li>
    68. 

  68. 								<li class="tsd-kind-class"><a href="classes/localstream.html" class="tsd-kind-icon">Local<wbr>Stream</a></li>
    69. 

  69. 								<li class="tsd-kind-class"><a href="classes/remotestream.html" class="tsd-kind-icon">Remote<wbr>Stream</a></li>
    70. 

  70. 								<li class="tsd-kind-class"><a href="classes/rtcerror.html" class="tsd-kind-icon">Rtc<wbr>Error</a></li>
    71. 

  71. 								<li class="tsd-kind-class"><a href="classes/stream.html" class="tsd-kind-icon">Stream</a></li>
    72. 

  72. 								<li class="tsd-kind-class"><a href="classes/user.html" class="tsd-kind-icon">User</a></li>
    73. 

  73. 							</ul>
    74. 

  74. 						</section>
    75. 

  75. 						<section class="tsd-index-section ">
    76. 

  76. 							<h3>Interfaces</h3>
    77. 

  77. 							<ul class="tsd-index-list">
    78. 

  78. 								<li class="tsd-kind-interface"><a href="interfaces/audiostats.html" class="tsd-kind-icon">Audio<wbr>Stats</a></li>
    79. 

  79. 								<li class="tsd-kind-interface"><a href="interfaces/clientoptions.html" class="tsd-kind-icon">Client<wbr>Options</a></li>
    80. 

  80. 								<li class="tsd-kind-interface"><a href="interfaces/clientplugin.html" class="tsd-kind-icon">Client<wbr>Plugin</a></li>
    81. 

  81. 								<li class="tsd-kind-interface"><a href="interfaces/codecs.html" class="tsd-kind-icon">Codecs</a></li>
    82. 

  82. 								<li class="tsd-kind-interface"><a href="interfaces/devicedetectionoptions.html" class="tsd-kind-icon">Device<wbr>Detection<wbr>Options</a></li>
    83. 

  83. 								<li class="tsd-kind-interface"><a href="interfaces/joinoptions.html" class="tsd-kind-icon">Join<wbr>Options</a></li>
    84. 

  84. 								<li class="tsd-kind-interface"><a href="interfaces/localstreamoptions.html" class="tsd-kind-icon">Local<wbr>Stream<wbr>Options</a></li>
    85. 

  85. 								<li class="tsd-kind-interface"><a href="interfaces/networkstats.html" class="tsd-kind-icon">Network<wbr>Stats</a></li>
    86. 

  86. 								<li class="tsd-kind-interface"><a href="interfaces/playoptions.html" class="tsd-kind-icon">Play<wbr>Options</a></li>
    87. 

  87. 								<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/rtcevent.html" class="tsd-kind-icon">Rtc<wbr>Event</a></li>
    88. 

  88. 								<li class="tsd-kind-interface"><a href="interfaces/serverconfig.html" class="tsd-kind-icon">Server<wbr>Config</a></li>
    89. 

  89. 								<li class="tsd-kind-interface"><a href="interfaces/snapshotoptions.html" class="tsd-kind-icon">Snapshot<wbr>Options</a></li>
    90. 

  90. 								<li class="tsd-kind-interface"><a href="interfaces/streamplugin.html" class="tsd-kind-icon">Stream<wbr>Plugin</a></li>
    91. 

  91. 								<li class="tsd-kind-interface"><a href="interfaces/streamstats.html" class="tsd-kind-icon">Stream<wbr>Stats</a></li>
    92. 

  92. 								<li class="tsd-kind-interface"><a href="interfaces/videostats.html" class="tsd-kind-icon">Video<wbr>Stats</a></li>
    93. 

  93. 							</ul>
    94. 

  94. 						</section>
    95. 

  95. 						<section class="tsd-index-section ">
    96. 

  96. 							<h3>Type aliases</h3>
    97. 

  97. 							<ul class="tsd-index-list">
    98. 

  98. 								<li class="tsd-kind-type-alias"><a href="index.html#audiocodec" class="tsd-kind-icon">Audio<wbr>Codec</a></li>
    99. 

  99. 								<li class="tsd-kind-type-alias"><a href="index.html#errorcode" class="tsd-kind-icon">Error<wbr>Code</a></li>
    100. 

  100. 								<li class="tsd-kind-type-alias"><a href="index.html#mediatype" class="tsd-kind-icon">Media<wbr>Type</a></li>
    101. 

  101. 								<li class="tsd-kind-type-alias"><a href="index.html#playcontrolstype" class="tsd-kind-icon">Play<wbr>Controls<wbr>Type</a></li>
    102. 

  102. 								<li class="tsd-kind-type-alias"><a href="index.html#playervideofittype" class="tsd-kind-icon">Player<wbr>Video<wbr>Fit<wbr>Type</a></li>
    103. 

  103. 								<li class="tsd-kind-type-alias"><a href="index.html#roletype" class="tsd-kind-icon">Role<wbr>Type</a></li>
    104. 

  104. 								<li class="tsd-kind-type-alias"><a href="index.html#roomtype" class="tsd-kind-icon">Room<wbr>Type</a></li>
    105. 

  105. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcconnectionevent" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>Event</a></li>
    106. 

  106. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcconnectioneventtype" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>Event<wbr>Type</a></li>
    107. 

  107. 								<li class="tsd-kind-type-alias"><a href="index.html#rtceventtype" class="tsd-kind-icon">Rtc<wbr>Event<wbr>Type</a></li>
    108. 

  108. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcplayerevent" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event</a></li>
    109. 

  109. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcplayereventtype" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event<wbr>Type</a></li>
    110. 

  110. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcstreamevent" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event</a></li>
    111. 

  111. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcstreameventtype" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event<wbr>Type</a></li>
    112. 

  112. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcuserevent" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event</a></li>
    113. 

  113. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcusereventtype" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event<wbr>Type</a></li>
    114. 

  114. 								<li class="tsd-kind-type-alias"><a href="index.html#screenprofile" class="tsd-kind-icon">Screen<wbr>Profile</a></li>
    115. 

  115. 								<li class="tsd-kind-type-alias"><a href="index.html#switchdevicetype" class="tsd-kind-icon">Switch<wbr>Device<wbr>Type</a></li>
    116. 

  116. 								<li class="tsd-kind-type-alias"><a href="index.html#videocodec" class="tsd-kind-icon">Video<wbr>Codec</a></li>
    117. 

  117. 								<li class="tsd-kind-type-alias"><a href="index.html#videoprofile" class="tsd-kind-icon">Video<wbr>Profile</a></li>
    118. 

  118. 							</ul>
    119. 

  119. 						</section>
    120. 

  120. 						<section class="tsd-index-section ">
    121. 

  121. 							<h3>Variables</h3>
    122. 

  122. 							<ul class="tsd-index-list">
    123. 

  123. 								<li class="tsd-kind-variable"><a href="index.html#version" class="tsd-kind-icon">version</a></li>
    124. 

  124. 							</ul>
    125. 

  125. 						</section>
    126. 

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

  127. 							<h3>Functions</h3>
    128. 

  128. 							<ul class="tsd-index-list">
    129. 

  129. 								<li class="tsd-kind-function"><a href="index.html#createclient" class="tsd-kind-icon">create<wbr>Client</a></li>
    130. 

  130. 								<li class="tsd-kind-function"><a href="index.html#createstream" class="tsd-kind-icon">create<wbr>Stream</a></li>
    131. 

  131. 								<li class="tsd-kind-function"><a href="index.html#devicedetection" class="tsd-kind-icon">device<wbr>Detection</a></li>
    132. 

  132. 								<li class="tsd-kind-function"><a href="index.html#disableuploadlog" class="tsd-kind-icon">disable<wbr>Upload<wbr>Log</a></li>
    133. 

  133. 								<li class="tsd-kind-function"><a href="index.html#enableuploadlog" class="tsd-kind-icon">enable<wbr>Upload<wbr>Log</a></li>
    134. 

  134. 								<li class="tsd-kind-function"><a href="index.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a></li>
    135. 

  135. 								<li class="tsd-kind-function"><a href="index.html#getcameras" class="tsd-kind-icon">get<wbr>Cameras</a></li>
    136. 

  136. 								<li class="tsd-kind-function"><a href="index.html#getdevices" class="tsd-kind-icon">get<wbr>Devices</a></li>
    137. 

  137. 								<li class="tsd-kind-function"><a href="index.html#getloudspeakers" class="tsd-kind-icon">get<wbr>Loudspeakers</a></li>
    138. 

  138. 								<li class="tsd-kind-function"><a href="index.html#getmicrophones" class="tsd-kind-icon">get<wbr>Microphones</a></li>
    139. 

  139. 								<li class="tsd-kind-function"><a href="index.html#getsupportedcodec" class="tsd-kind-icon">get<wbr>Supported<wbr>Codec</a></li>
    140. 

  140. 								<li class="tsd-kind-function"><a href="index.html#issupportscreenshare" class="tsd-kind-icon">is<wbr>Support<wbr>Screen<wbr>Share</a></li>
    141. 

  141. 								<li class="tsd-kind-function"><a href="index.html#issupportwebrtc" class="tsd-kind-icon">is<wbr>Support<wbr>WebRTC</a></li>
    142. 

  142. 								<li class="tsd-kind-function"><a href="index.html#setloglevel" class="tsd-kind-icon">set<wbr>Log<wbr>Level</a></li>
    143. 

  143. 								<li class="tsd-kind-function"><a href="index.html#setservers" class="tsd-kind-icon">set<wbr>Servers</a></li>
    144. 

  144. 							</ul>
    145. 

  145. 						</section>
    146. 

  146. 					</div>
    147. 

  147. 				</section>
    148. 

  148. 			</section>
    149. 

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

  150. 				<h2>Type aliases</h2>
    151. 

  151. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    152. 

  152. 					<a name="audiocodec" class="tsd-anchor"></a>
    153. 

  153. 					<h3>Audio<wbr>Codec</h3>
    154. 

  154. 					<div class="tsd-signature tsd-kind-icon">Audio<wbr>Codec<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;opus&quot;</span></div>
    155. 

  155. 					<aside class="tsd-sources">
    156. 

  156. 					</aside>
    157. 

  157. 					<div class="tsd-comment tsd-typography">
    158. 

  158. 						<div class="lead">
    159. 

  159. 							<p>音频编解码格式</p>
    160. 

  160. 						</div>
    161. 

  161. 					</div>
    162. 

  162. 				</section>
    163. 

  163. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    164. 

  164. 					<a name="errorcode" class="tsd-anchor"></a>
    165. 

  165. 					<h3>Error<wbr>Code</h3>
    166. 

  166. 					<div class="tsd-signature tsd-kind-icon">Error<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="classes/rtcerror.html" class="tsd-signature-type" data-tsd-kind="Class">RtcError</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Exclude</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-symbol">typeof </span><a href="classes/rtcerror.html" class="tsd-signature-type" data-tsd-kind="Class">RtcError</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;prototype&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;getCode&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;stackTraceLimit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;prepareStackTrace&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;captureStackTrace&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">]</span></div>
    167. 

  167. 					<aside class="tsd-sources">
    168. 

  168. 					</aside>
    169. 

  169. 					<div class="tsd-comment tsd-typography">
    170. 

  170. 						<div class="lead">
    171. 

  171. 							<p>RTC 错误代码</p>
    172. 

  172. 						</div>
    173. 

  173. 						<p>通用错误及代码</p>
    174. 

  174. 						<ul>
    175. 

  175. 							<li>1000 - 非法参数</li>
    176. 

  176. 							<li>1001 - 非法操作</li>
    177. 

  177. 							<li>1002 - 不支持</li>
    178. 

  178. 							<li>1003 - 不存在</li>
    179. 

  179. 							<li>1004 - 请求失败</li>
    180. 

  180. 							<li>1999 - 其他错误</li>
    181. 

  181. 						</ul>
    182. 

  182. 						<p>房间相关错误及代码</p>
    183. 

  183. 						<ul>
    184. 

  184. 							<li>2000 - 网关不可达</li>
    185. 

  185. 							<li>2001 - 获取 Access Token 失败</li>
    186. 

  186. 							<li>2002 - Access Token 非法</li>
    187. 

  187. 							<li>2003 - Websocket 连接失败</li>
    188. 

  188. 							<li>2004 - 加入房间失败</li>
    189. 

  189. 							<li>2005 - 未加入房间</li>
    190. 

  190. 							<li>2006 - 正在加入房间</li>
    191. 

  191. 							<li>2007 - 正在离开房间</li>
    192. 

  192. 							<li>2008 - 角色类型不匹配</li>
    193. 

  193. 							<li>2009 - 信令服务器地址错误</li>
    194. 

  194. 						</ul>
    195. 

  195. 						<p>流相关错误及代码</p>
    196. 

  196. 						<ul>
    197. 

  197. 							<li>3000 - 流不存在</li>
    198. 

  198. 							<li>3001 - 同类型的流已存在</li>
    199. 

  199. 							<li>3002 - 音频不存在</li>
    200. 

  200. 							<li>3003 - 视频不存在</li>
    201. 

  201. 							<li>3004 - [中止错误] 尽管用户和操作系统都授予了访问设备硬件的权利，而且未出现可能抛出NotReadableError异常的硬件问题，但仍然有一些问题的出现导致了设备无法被使用。</li>
    202. 

  202. 							<li>3005 - [拒绝错误] 用户拒绝了当前的浏览器实例的访问请求；或者用户拒绝了当前会话的访问；或者用户在全局范围内拒绝了所有媒体访问请求。</li>
    203. 

  203. 							<li>3006 - [找不到错误] 找不到满足请求参数的媒体类型。</li>
    204. 

  204. 							<li>3007 - [无法读取错误] 尽管用户已经授权使用相应的设备，操作系统上某个硬件、浏览器或者网页层面发生的错误导致设备无法被访问。</li>
    205. 

  205. 							<li>3008 - [无法满足要求错误] 指定的要求无法被设备满足。</li>
    206. 

  206. 							<li>3009 - 流连接失败</li>
    207. 

  207. 							<li>3010 - 流正在重连</li>
    208. 

  208. 							<li>3011 - 流尚未发布</li>
    209. 

  209. 							<li>3012 - 流正在发布</li>
    210. 

  210. 							<li>3013 - 流正在取消发布</li>
    211. 

  211. 							<li>3014 - 流已经发布</li>
    212. 

  212. 							<li>3015 - 流尚未订阅</li>
    213. 

  213. 							<li>3016 - 流正在订阅</li>
    214. 

  214. 							<li>3017 - 流正在取消订阅</li>
    215. 

  215. 							<li>3018 - 流已经订阅</li>
    216. 

  216. 							<li>3019 - 自动播放被禁止错误</li>
    217. 

  217. 							<li>3020 - 视频数据异常，未成功播放</li>
    218. 

  218. 							<li>3021 - 因未曾调用或调用 play 方法失败，故不可恢复播放</li>
    219. 

  219. 						</ul>
    220. 

  220. 					</div>
    221. 

  221. 				</section>
    222. 

  222. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    223. 

  223. 					<a name="mediatype" class="tsd-anchor"></a>
    224. 

  224. 					<h3>Media<wbr>Type</h3>
    225. 

  225. 					<div class="tsd-signature tsd-kind-icon">Media<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;camera&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;screen&quot;</span></div>
    226. 

  226. 					<aside class="tsd-sources">
    227. 

  227. 					</aside>
    228. 

  228. 					<div class="tsd-comment tsd-typography">
    229. 

  229. 						<div class="lead">
    230. 

  230. 							<p>流的媒体类型, main - 主视频流，screen - 辅助视频流，通常是一个屏幕分享流</p>
    231. 

  231. 						</div>
    232. 

  232. 					</div>
    233. 

  233. 				</section>
    234. 

  234. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    235. 

  235. 					<a name="playcontrolstype" class="tsd-anchor"></a>
    236. 

  236. 					<h3>Play<wbr>Controls<wbr>Type</h3>
    237. 

  237. 					<div class="tsd-signature tsd-kind-icon">Play<wbr>Controls<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;show&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;hide&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;auto&quot;</span></div>
    238. 

  238. 					<aside class="tsd-sources">
    239. 

  239. 					</aside>
    240. 

  240. 					<div class="tsd-comment tsd-typography">
    241. 

  241. 						<div class="lead">
    242. 

  242. 							<p>视频播放时 audio / video 的控制面板的显示模式</p>
    243. 

  243. 							<ul>
    244. 

  244. 								<li>show 模式：一直显示</li>
    245. 

  245. 								<li>hide 模式：一直隐藏</li>
    246. 

  246. 								<li>auto 模式：自动判断</li>
    247. 

  247. 							</ul>
    248. 

  248. 						</div>
    249. 

  249. 					</div>
    250. 

  250. 				</section>
    251. 

  251. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    252. 

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

  253. 					<h3>Player<wbr>Video<wbr>Fit<wbr>Type</h3>
    254. 

  254. 					<div class="tsd-signature tsd-kind-icon">Player<wbr>Video<wbr>Fit<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;cover&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;contain&quot;</span></div>
    255. 

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

  256. 					</aside>
    257. 

  257. 					<div class="tsd-comment tsd-typography">
    258. 

  258. 						<div class="lead">
    259. 

  259. 							<p>视频播放时的显示模式</p>
    260. 

  260. 							<ul>
    261. 

  261. 								<li>cover 模式：优先保证视窗被填满。</li>
    262. 

  262. 								<li>contain 模式：优先保证视频内容全部显示。
    263. 

  263. 								播放摄像头视频流默认使用 cover 模式，屏幕共享视频流默认使用 contain 模式。</li>
    264. 

  264. 							</ul>
    265. 

  265. 						</div>
    266. 

  266. 					</div>
    267. 

  267. 				</section>
    268. 

  268. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    269. 

  269. 					<a name="roletype" class="tsd-anchor"></a>
    270. 

  270. 					<h3>Role<wbr>Type</h3>
    271. 

  271. 					<div class="tsd-signature tsd-kind-icon">Role<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;pull&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;push&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;push-and-pull&quot;</span></div>
    272. 

  272. 					<aside class="tsd-sources">
    273. 

  273. 					</aside>
    274. 

  274. 					<div class="tsd-comment tsd-typography">
    275. 

  275. 						<div class="lead">
    276. 

  276. 							<p>用户角色</p>
    277. 

  277. 						</div>
    278. 

  278. 					</div>
    279. 

  279. 				</section>
    280. 

  280. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    281. 

  281. 					<a name="roomtype" class="tsd-anchor"></a>
    282. 

  282. 					<h3>Room<wbr>Type</h3>
    283. 

  283. 					<div class="tsd-signature tsd-kind-icon">Room<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;conference&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;live&quot;</span></div>
    284. 

  284. 					<aside class="tsd-sources">
    285. 

  285. 					</aside>
    286. 

  286. 					<div class="tsd-comment tsd-typography">
    287. 

  287. 						<div class="lead">
    288. 

  288. 							<p>房间类型</p>
    289. 

  289. 						</div>
    290. 

  290. 					</div>
    291. 

  291. 				</section>
    292. 

  292. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    293. 

  293. 					<a name="rtcconnectionevent" class="tsd-anchor"></a>
    294. 

  294. 					<h3>Rtc<wbr>Connection<wbr>Event</h3>
    295. 

  295. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Connection<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type" data-tsd-kind="Interface">RtcEvent</a><span class="tsd-signature-symbol">&lt;</span><a href="index.html#rtcconnectioneventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcConnectionEventType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ConnectionStates</span><span class="tsd-signature-symbol">&gt;</span></div>
    296. 

  296. 					<aside class="tsd-sources">
    297. 

  297. 					</aside>
    298. 

  298. 					<div class="tsd-comment tsd-typography">
    299. 

  299. 						<div class="lead">
    300. 

  300. 							<p>Rtc 连接事件，事件类型参见 <a href="index.html#rtcconnectioneventtype">RtcConnectionEventType</a></p>
    301. 

  301. 						</div>
    302. 

  302. 					</div>
    303. 

  303. 				</section>
    304. 

  304. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    305. 

  305. 					<a name="rtcconnectioneventtype" class="tsd-anchor"></a>
    306. 

  306. 					<h3>Rtc<wbr>Connection<wbr>Event<wbr>Type</h3>
    307. 

  307. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Connection<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;connection-state-changed&quot;</span></div>
    308. 

  308. 					<aside class="tsd-sources">
    309. 

  309. 					</aside>
    310. 

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

  311. 						<div class="lead">
    312. 

  312. 							<p>Rtc 客户端连接事件类型：</p>
    313. 

  313. 						</div>
    314. 

  314. 						<p><a href="index.html#rtcconnectionevent">连接事件</a></p>
    315. 

  315. 						<ul>
    316. 

  316. 							<li>connection-state-changed - 连接状态改变</li>
    317. 

  317. 						</ul>
    318. 

  318. 						<dl class="tsd-comment-tags">
    319. 

  319. 							<dt>example</dt>
    320. 

  320. 							<dd><pre><code class="language-js"><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;connection-state-changed&#039;</span><span style="color: #000000">, (</span><span style="color: #001080">event</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    321. 

  321. <span style="color: #000000">  </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`连接状态：</span><span style="color: #0000FF">${</span><span style="color: #001080">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #000000FF">.</span><span style="color: #001080">previous</span><span style="color: #0000FF">}</span><span style="color: #A31515"> =&gt; </span><span style="color: #0000FF">${</span><span style="color: #001080">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #000000FF">.</span><span style="color: #001080">current</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    322. 

  322. <span style="color: #000000">});</span>
    323. 

  323. </code></pre>
    324. 

  324. 							</dd>
    325. 

  325. 						</dl>
    326. 

  326. 					</div>
    327. 

  327. 				</section>
    328. 

  328. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    329. 

  329. 					<a name="rtceventtype" class="tsd-anchor"></a>
    330. 

  330. 					<h3>Rtc<wbr>Event<wbr>Type</h3>
    331. 

  331. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="index.html#rtcusereventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcUserEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcstreameventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcStreamEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcconnectioneventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcConnectionEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcplayereventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcPlayerEventType</a></div>
    332. 

  332. 					<aside class="tsd-sources">
    333. 

  333. 					</aside>
    334. 

  334. 					<div class="tsd-comment tsd-typography">
    335. 

  335. 						<div class="lead">
    336. 

  336. 							<p>Rtc 事件类型</p>
    337. 

  337. 						</div>
    338. 

  338. 					</div>
    339. 

  339. 				</section>
    340. 

  340. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    341. 

  341. 					<a name="rtcplayerevent" class="tsd-anchor"></a>
    342. 

  342. 					<h3>Rtc<wbr>Player<wbr>Event</h3>
    343. 

  343. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Player<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type" data-tsd-kind="Interface">RtcEvent</a><span class="tsd-signature-symbol">&lt;</span><a href="index.html#rtcplayereventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcPlayerEventType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">PlayerEventData</span><span class="tsd-signature-symbol">&gt;</span></div>
    344. 

  344. 					<aside class="tsd-sources">
    345. 

  345. 					</aside>
    346. 

  346. 					<div class="tsd-comment tsd-typography">
    347. 

  347. 						<div class="lead">
    348. 

  348. 							<p>Rtc 连接事件，事件类型参见 <a href="index.html#rtcplayereventtype">RtcPlayerEventType</a></p>
    349. 

  349. 						</div>
    350. 

  350. 					</div>
    351. 

  351. 				</section>
    352. 

  352. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    353. 

  353. 					<a name="rtcplayereventtype" class="tsd-anchor"></a>
    354. 

  354. 					<h3>Rtc<wbr>Player<wbr>Event<wbr>Type</h3>
    355. 

  355. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Player<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;player-status-change&quot;</span></div>
    356. 

  356. 					<aside class="tsd-sources">
    357. 

  357. 					</aside>
    358. 

  358. 					<div class="tsd-comment tsd-typography">
    359. 

  359. 						<div class="lead">
    360. 

  360. 							<p>Rtc 播放器事件类型：</p>
    361. 

  361. 						</div>
    362. 

  362. 						<p><a href="index.html#rtcplayerevent">播放器事件</a></p>
    363. 

  363. 						<ul>
    364. 

  364. 							<li>player-status-change - 流播放器状态改变</li>
    365. 

  365. 						</ul>
    366. 

  366. 						<p><strong>注，此事件需在单条流上进行监听</strong></p>
    367. 

  367. 						<dl class="tsd-comment-tags">
    368. 

  368. 							<dt>example</dt>
    369. 

  369. 							<dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;player-status-change&#039;</span><span style="color: #000000">, (</span><span style="color: #001080">event</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    370. 

  370. <span style="color: #000000">  </span><span style="color: #0000FF">const</span><span style="color: #000000"> { </span><span style="color: #0070C1">data</span><span style="color: #000000"> } = </span><span style="color: #001080">event</span><span style="color: #000000">;</span>
    371. 

  371. <span style="color: #000000">  </span><span style="color: #0000FF">const</span><span style="color: #000000"> { </span><span style="color: #0070C1">type</span><span style="color: #000000">, </span><span style="color: #0070C1">status</span><span style="color: #000000"> } = </span><span style="color: #001080">data</span><span style="color: #000000">;</span>
    372. 

  372. <span style="color: #000000">  </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`stream&#039;s </span><span style="color: #0000FF">${</span><span style="color: #001080">type</span><span style="color: #0000FF">}</span><span style="color: #A31515"> status changed to </span><span style="color: #0000FF">${</span><span style="color: #001080">status</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    373. 

  373. <span style="color: #000000">});</span>
    374. 

  374. </code></pre>
    375. 

  375. 							</dd>
    376. 

  376. 						</dl>
    377. 

  377. 					</div>
    378. 

  378. 				</section>
    379. 

  379. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    380. 

  380. 					<a name="rtcstreamevent" class="tsd-anchor"></a>
    381. 

  381. 					<h3>Rtc<wbr>Stream<wbr>Event</h3>
    382. 

  382. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Stream<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type" data-tsd-kind="Interface">RtcEvent</a><span class="tsd-signature-symbol">&lt;</span><a href="index.html#rtcstreameventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcStreamEventType</a><span class="tsd-signature-symbol">, </span><a href="classes/stream.html" class="tsd-signature-type" data-tsd-kind="Class">Stream</a><span class="tsd-signature-symbol"> | </span><a href="classes/localstream.html" class="tsd-signature-type" data-tsd-kind="Class">LocalStream</a><span class="tsd-signature-symbol"> | </span><a href="classes/remotestream.html" class="tsd-signature-type" data-tsd-kind="Class">RemoteStream</a><span class="tsd-signature-symbol">&gt;</span></div>
    383. 

  383. 					<aside class="tsd-sources">
    384. 

  384. 					</aside>
    385. 

  385. 					<div class="tsd-comment tsd-typography">
    386. 

  386. 						<div class="lead">
    387. 

  387. 							<p>Rtc 流事件，事件类型参见 <a href="index.html#rtcstreameventtype">RtcStreamEventType</a></p>
    388. 

  388. 						</div>
    389. 

  389. 					</div>
    390. 

  390. 				</section>
    391. 

  391. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    392. 

  392. 					<a name="rtcstreameventtype" class="tsd-anchor"></a>
    393. 

  393. 					<h3>Rtc<wbr>Stream<wbr>Event<wbr>Type</h3>
    394. 

  394. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Stream<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stream-added&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;stream-removed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;stream-subscribed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;stream-published&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;mute-audio&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;unmute-audio&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;mute-video&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;unmute-video&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;first-key-frame&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;screenshare-stopped&quot;</span></div>
    395. 

  395. 					<aside class="tsd-sources">
    396. 

  396. 					</aside>
    397. 

  397. 					<div class="tsd-comment tsd-typography">
    398. 

  398. 						<div class="lead">
    399. 

  399. 							<p>Rtc 流事件类型：</p>
    400. 

  400. 						</div>
    401. 

  401. 						<p><a href="index.html#rtcstreamevent">流事件</a></p>
    402. 

  402. 						<ul>
    403. 

  403. 							<li>stream-added - 有远端流加入，此时事件中的 data 为 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
    404. 

  404. 							<li>stream-removed - 有远端流移除，此时事件中的 data 为 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
    405. 

  405. 							<li>stream-subscribed - 远端流订阅完成，此时事件中的 data 为 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
    406. 

  406. 							<li>stream-published - 本地流发布完成，此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流</li>
    407. 

  407. 							<li>mute-audio - 流的音频被 mute</li>
    408. 

  408. 							<li>unmute-audio - 流的音频被取消 mute</li>
    409. 

  409. 							<li>mute-video - 流的视频被 mute</li>
    410. 

  410. 							<li>unmute-video - 流的视频被取消 mute</li>
    411. 

  411. 						</ul>
    412. 

  412. 						<dl class="tsd-comment-tags">
    413. 

  413. 							<dt>example</dt>
    414. 

  414. 							<dd><pre><code class="language-js"><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;stream-add&#039;</span><span style="color: #000000">, (</span><span style="color: #001080">event</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    415. 

  415. <span style="color: #000000">  </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">subscribe</span><span style="color: #000000">(</span><span style="color: #001080">event</span><span style="color: #000000">.</span><span style="color: #001080">data</span><span style="color: #000000">);</span>
    416. 

  416. <span style="color: #000000">});</span>
    417. 

  417. </code></pre>
    418. 

  418. 								<p><strong>特别地，以下事件需在单条流上进行监听</strong></p>
    419. 

  419. 								<ul>
    420. 

  420. 									<li>screenshare-stopped - 屏幕共享流被中止，此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流</li>
    421. 

  421. 									<li>first-key-frame - 接收到远端流的首帧</li>
    422. 

  422. 								</ul>
    423. 

  423. 							</dd>
    424. 

  424. 							<dt>example</dt>
    425. 

  425. 							<dd><pre><code class="language-js"><span style="color: #001080">localStream</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;screenshare-stopped&#039;</span><span style="color: #000000">, (</span><span style="color: #001080">event</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    426. 

  426. <span style="color: #000000">  </span><span style="color: #008000">// 此事件只针对本地流有效，若本地流已发布，监听到此事件后，可以决定要不要取消发布</span>
    427. 

  427. <span style="color: #000000">  </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">unpublish</span><span style="color: #000000">(</span><span style="color: #001080">event</span><span style="color: #000000">.</span><span style="color: #001080">data</span><span style="color: #000000">);</span>
    428. 

  428. <span style="color: #000000">  </span><span style="color: #001080">event</span><span style="color: #000000">.</span><span style="color: #001080">data</span><span style="color: #000000">.</span><span style="color: #795E26">destroy</span><span style="color: #000000">();</span>
    429. 

  429. <span style="color: #000000">});</span>
    430. 

  430. </code></pre>
    431. 

  431. 							</dd>
    432. 

  432. 							<dt>example</dt>
    433. 

  433. 							<dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;first-key-frame&#039;</span><span style="color: #000000">, (</span><span style="color: #001080">event</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    434. 

  434. <span style="color: #000000">  </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`stream </span><span style="color: #0000FF">${</span><span style="color: #001080">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #0000FF">}</span><span style="color: #A31515"> got first key frame`</span><span style="color: #000000">);</span>
    435. 

  435. <span style="color: #000000">});</span>
    436. 

  436. </code></pre>
    437. 

  437. 							</dd>
    438. 

  438. 						</dl>
    439. 

  439. 					</div>
    440. 

  440. 				</section>
    441. 

  441. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    442. 

  442. 					<a name="rtcuserevent" class="tsd-anchor"></a>
    443. 

  443. 					<h3>Rtc<wbr>User<wbr>Event</h3>
    444. 

  444. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>User<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type" data-tsd-kind="Interface">RtcEvent</a><span class="tsd-signature-symbol">&lt;</span><a href="index.html#rtcusereventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcUserEventType</a><span class="tsd-signature-symbol">, </span><a href="classes/user.html" class="tsd-signature-type" data-tsd-kind="Class">User</a><span class="tsd-signature-symbol">&gt;</span></div>
    445. 

  445. 					<aside class="tsd-sources">
    446. 

  446. 					</aside>
    447. 

  447. 					<div class="tsd-comment tsd-typography">
    448. 

  448. 						<div class="lead">
    449. 

  449. 							<p>Rtc 用户事件，事件类型参见 <a href="index.html#rtcusereventtype">RtcUserEventType</a></p>
    450. 

  450. 						</div>
    451. 

  451. 					</div>
    452. 

  452. 				</section>
    453. 

  453. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    454. 

  454. 					<a name="rtcusereventtype" class="tsd-anchor"></a>
    455. 

  455. 					<h3>Rtc<wbr>User<wbr>Event<wbr>Type</h3>
    456. 

  456. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>User<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;user-joined&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;user-left&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;kick-off&quot;</span></div>
    457. 

  457. 					<aside class="tsd-sources">
    458. 

  458. 					</aside>
    459. 

  459. 					<div class="tsd-comment tsd-typography">
    460. 

  460. 						<div class="lead">
    461. 

  461. 							<p>Rtc 用户事件类型：</p>
    462. 

  462. 						</div>
    463. 

  463. 						<p><a href="index.html#rtcuserevent">用户事件</a></p>
    464. 

  464. 						<ul>
    465. 

  465. 							<li>user-joined - 有用户加入房间</li>
    466. 

  466. 							<li>user-left - 有用户离开房间</li>
    467. 

  467. 							<li>kick-off - 当前用户被踢出房间</li>
    468. 

  468. 						</ul>
    469. 

  469. 						<dl class="tsd-comment-tags">
    470. 

  470. 							<dt>example</dt>
    471. 

  471. 							<dd><pre><code class="language-js"><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;user-joined&#039;</span><span style="color: #000000">, (</span><span style="color: #001080">event</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    472. 

  472. <span style="color: #000000">  </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`用户 </span><span style="color: #0000FF">${</span><span style="color: #001080">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #000000FF">.</span><span style="color: #001080">id</span><span style="color: #0000FF">}</span><span style="color: #A31515"> 加入`</span><span style="color: #000000">);</span>
    473. 

  473. <span style="color: #000000">});</span>
    474. 

  474. </code></pre>
    475. 

  475. 							</dd>
    476. 

  476. 						</dl>
    477. 

  477. 					</div>
    478. 

  478. 				</section>
    479. 

  479. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    480. 

  480. 					<a name="screenprofile" class="tsd-anchor"></a>
    481. 

  481. 					<h3>Screen<wbr>Profile</h3>
    482. 

  482. 					<div class="tsd-signature tsd-kind-icon">Screen<wbr>Profile<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;480p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;480p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p_2&quot;</span></div>
    483. 

  483. 					<aside class="tsd-sources">
    484. 

  484. 					</aside>
    485. 

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

  486. 						<div class="lead">
    487. 

  487. 							<p>预设的屏幕共享视频 Profile</p>
    488. 

  488. 						</div>
    489. 

  489. 						<table>
    490. 

  490. 							<thead>
    491. 

  491. 								<tr>
    492. 

  492. 									<th align="center">名称</th>
    493. 

  493. 									<th align="center">视频宽</th>
    494. 

  494. 									<th align="center">视频高</th>
    495. 

  495. 									<th align="center">帧率 (fps)</th>
    496. 

  496. 									<th align="center">码率 (kbps)</th>
    497. 

  497. 								</tr>
    498. 

  498. 							</thead>
    499. 

  499. 							<tbody><tr>
    500. 

  500. 									<td align="center">480p</td>
    501. 

  501. 									<td align="center">640</td>
    502. 

  502. 									<td align="center">480</td>
    503. 

  503. 									<td align="center">5</td>
    504. 

  504. 									<td align="center">600</td>
    505. 

  505. 								</tr>
    506. 

  506. 								<tr>
    507. 

  507. 									<td align="center">480p_2</td>
    508. 

  508. 									<td align="center">640</td>
    509. 

  509. 									<td align="center">480</td>
    510. 

  510. 									<td align="center">30</td>
    511. 

  511. 									<td align="center">1000</td>
    512. 

  512. 								</tr>
    513. 

  513. 								<tr>
    514. 

  514. 									<td align="center">720p</td>
    515. 

  515. 									<td align="center">1280</td>
    516. 

  516. 									<td align="center">720</td>
    517. 

  517. 									<td align="center">5</td>
    518. 

  518. 									<td align="center">1000</td>
    519. 

  519. 								</tr>
    520. 

  520. 								<tr>
    521. 

  521. 									<td align="center">720p_2</td>
    522. 

  522. 									<td align="center">1280</td>
    523. 

  523. 									<td align="center">720</td>
    524. 

  524. 									<td align="center">30</td>
    525. 

  525. 									<td align="center">2000</td>
    526. 

  526. 								</tr>
    527. 

  527. 								<tr>
    528. 

  528. 									<td align="center">1080p</td>
    529. 

  529. 									<td align="center">1920</td>
    530. 

  530. 									<td align="center">1080</td>
    531. 

  531. 									<td align="center">5</td>
    532. 

  532. 									<td align="center">1500</td>
    533. 

  533. 								</tr>
    534. 

  534. 								<tr>
    535. 

  535. 									<td align="center">1080p_2</td>
    536. 

  536. 									<td align="center">1920</td>
    537. 

  537. 									<td align="center">1080</td>
    538. 

  538. 									<td align="center">30</td>
    539. 

  539. 									<td align="center">2500</td>
    540. 

  540. 								</tr>
    541. 

  541. 						</tbody></table>
    542. 

  542. 					</div>
    543. 

  543. 				</section>
    544. 

  544. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    545. 

  545. 					<a name="switchdevicetype" class="tsd-anchor"></a>
    546. 

  546. 					<h3>Switch<wbr>Device<wbr>Type</h3>
    547. 

  547. 					<div class="tsd-signature tsd-kind-icon">Switch<wbr>Device<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;audio&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;video&quot;</span></div>
    548. 

  548. 					<aside class="tsd-sources">
    549. 

  549. 					</aside>
    550. 

  550. 					<div class="tsd-comment tsd-typography">
    551. 

  551. 						<div class="lead">
    552. 

  552. 							<p>切换设备的类型</p>
    553. 

  553. 						</div>
    554. 

  554. 					</div>
    555. 

  555. 				</section>
    556. 

  556. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    557. 

  557. 					<a name="videocodec" class="tsd-anchor"></a>
    558. 

  558. 					<h3>Video<wbr>Codec</h3>
    559. 

  559. 					<div class="tsd-signature tsd-kind-icon">Video<wbr>Codec<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;vp8&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;h264&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;h265&quot;</span></div>
    560. 

  560. 					<aside class="tsd-sources">
    561. 

  561. 					</aside>
    562. 

  562. 					<div class="tsd-comment tsd-typography">
    563. 

  563. 						<div class="lead">
    564. 

  564. 							<p>视频编解码格式</p>
    565. 

  565. 						</div>
    566. 

  566. 						<dl class="tsd-comment-tags">
    567. 

  567. 							<dt>note</dt>
    568. 

  568. 							<dd><p>&#39;h265&#39; 目前仅部分浏览器在开启试验性功能时才支持，如 Safari 开启 <code>WebRTC H265 codec</code></p>
    569. 

  569. 							</dd>
    570. 

  570. 						</dl>
    571. 

  571. 					</div>
    572. 

  572. 				</section>
    573. 

  573. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    574. 

  574. 					<a name="videoprofile" class="tsd-anchor"></a>
    575. 

  575. 					<h3>Video<wbr>Profile</h3>
    576. 

  576. 					<div class="tsd-signature tsd-kind-icon">Video<wbr>Profile<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;180p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;180p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;240p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;360p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;360p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;480p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p_3&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p_3&quot;</span></div>
    577. 

  577. 					<aside class="tsd-sources">
    578. 

  578. 					</aside>
    579. 

  579. 					<div class="tsd-comment tsd-typography">
    580. 

  580. 						<div class="lead">
    581. 

  581. 							<p>预设的视频 Profile</p>
    582. 

  582. 						</div>
    583. 

  583. 						<table>
    584. 

  584. 							<thead>
    585. 

  585. 								<tr>
    586. 

  586. 									<th align="center">名称</th>
    587. 

  587. 									<th align="center">视频宽</th>
    588. 

  588. 									<th align="center">视频高</th>
    589. 

  589. 									<th align="center">帧率 (fps)</th>
    590. 

  590. 									<th align="center">码率 (kbps)</th>
    591. 

  591. 								</tr>
    592. 

  592. 							</thead>
    593. 

  593. 							<tbody><tr>
    594. 

  594. 									<td align="center">180p</td>
    595. 

  595. 									<td align="center">240</td>
    596. 

  596. 									<td align="center">180</td>
    597. 

  597. 									<td align="center">15</td>
    598. 

  598. 									<td align="center">200</td>
    599. 

  599. 								</tr>
    600. 

  600. 								<tr>
    601. 

  601. 									<td align="center">180p_2</td>
    602. 

  602. 									<td align="center">320</td>
    603. 

  603. 									<td align="center">180</td>
    604. 

  604. 									<td align="center">15</td>
    605. 

  605. 									<td align="center">300</td>
    606. 

  606. 								</tr>
    607. 

  607. 								<tr>
    608. 

  608. 									<td align="center">240p</td>
    609. 

  609. 									<td align="center">320</td>
    610. 

  610. 									<td align="center">240</td>
    611. 

  611. 									<td align="center">15</td>
    612. 

  612. 									<td align="center">400</td>
    613. 

  613. 								</tr>
    614. 

  614. 								<tr>
    615. 

  615. 									<td align="center">360p</td>
    616. 

  616. 									<td align="center">480</td>
    617. 

  617. 									<td align="center">360</td>
    618. 

  618. 									<td align="center">15</td>
    619. 

  619. 									<td align="center">400</td>
    620. 

  620. 								</tr>
    621. 

  621. 								<tr>
    622. 

  622. 									<td align="center">360p_2</td>
    623. 

  623. 									<td align="center">640</td>
    624. 

  624. 									<td align="center">360</td>
    625. 

  625. 									<td align="center">15</td>
    626. 

  626. 									<td align="center">500</td>
    627. 

  627. 								</tr>
    628. 

  628. 								<tr>
    629. 

  629. 									<td align="center">480p</td>
    630. 

  630. 									<td align="center">640</td>
    631. 

  631. 									<td align="center">480</td>
    632. 

  632. 									<td align="center">15</td>
    633. 

  633. 									<td align="center">600</td>
    634. 

  634. 								</tr>
    635. 

  635. 								<tr>
    636. 

  636. 									<td align="center">720p</td>
    637. 

  637. 									<td align="center">1280</td>
    638. 

  638. 									<td align="center">720</td>
    639. 

  639. 									<td align="center">15</td>
    640. 

  640. 									<td align="center">1000</td>
    641. 

  641. 								</tr>
    642. 

  642. 								<tr>
    643. 

  643. 									<td align="center">720p_2</td>
    644. 

  644. 									<td align="center">1280</td>
    645. 

  645. 									<td align="center">720</td>
    646. 

  646. 									<td align="center">15</td>
    647. 

  647. 									<td align="center">1500</td>
    648. 

  648. 								</tr>
    649. 

  649. 								<tr>
    650. 

  650. 									<td align="center">720p_3</td>
    651. 

  651. 									<td align="center">1280</td>
    652. 

  652. 									<td align="center">720</td>
    653. 

  653. 									<td align="center">30</td>
    654. 

  654. 									<td align="center">2000</td>
    655. 

  655. 								</tr>
    656. 

  656. 								<tr>
    657. 

  657. 									<td align="center">1080p</td>
    658. 

  658. 									<td align="center">1920</td>
    659. 

  659. 									<td align="center">1080</td>
    660. 

  660. 									<td align="center">15</td>
    661. 

  661. 									<td align="center">1500</td>
    662. 

  662. 								</tr>
    663. 

  663. 								<tr>
    664. 

  664. 									<td align="center">1080p_2</td>
    665. 

  665. 									<td align="center">1920</td>
    666. 

  666. 									<td align="center">1080</td>
    667. 

  667. 									<td align="center">15</td>
    668. 

  668. 									<td align="center">2000</td>
    669. 

  669. 								</tr>
    670. 

  670. 								<tr>
    671. 

  671. 									<td align="center">1080p_3</td>
    672. 

  672. 									<td align="center">1920</td>
    673. 

  673. 									<td align="center">1080</td>
    674. 

  674. 									<td align="center">30</td>
    675. 

  675. 									<td align="center">2500</td>
    676. 

  676. 								</tr>
    677. 

  677. 						</tbody></table>
    678. 

  678. 					</div>
    679. 

  679. 				</section>
    680. 

  680. 			</section>
    681. 

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

  682. 				<h2>Variables</h2>
    683. 

  683. 				<section class="tsd-panel tsd-member tsd-kind-variable">
    684. 

  684. 					<a name="version" class="tsd-anchor"></a>
    685. 

  685. 					<h3><span class="tsd-flag ts-flagConst">Const</span> version</h3>
    686. 

  686. 					<div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></div>
    687. 

  687. 					<aside class="tsd-sources">
    688. 

  688. 					</aside>
    689. 

  689. 					<div class="tsd-comment tsd-typography">
    690. 

  690. 						<div class="lead">
    691. 

  691. 							<p>当前 sdk 的版本号</p>
    692. 

  692. 						</div>
    693. 

  693. 					</div>
    694. 

  694. 				</section>
    695. 

  695. 			</section>
    696. 

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

  697. 				<h2>Functions</h2>
    698. 

  698. 				<section class="tsd-panel tsd-member tsd-kind-function">
    699. 

  699. 					<a name="createclient" class="tsd-anchor"></a>
    700. 

  700. 					<h3>create<wbr>Client</h3>
    701. 

  701. 					<ul class="tsd-signatures tsd-kind-function">
    702. 

  702. 						<li class="tsd-signature tsd-kind-icon">create<wbr>Client<span class="tsd-signature-symbol">(</span>appId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><a href="interfaces/clientoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></li>
    703. 

  703. 					</ul>
    704. 

  704. 					<ul class="tsd-descriptions">
    705. 

  705. 						<li class="tsd-description">
    706. 

  706. 							<aside class="tsd-sources">
    707. 

  707. 							</aside>
    708. 

  708. 							<div class="tsd-comment tsd-typography">
    709. 

  709. 								<div class="lead">
    710. 

  710. 									<p>创建客户端</p>
    711. 

  711. 								</div>
    712. 

  712. 								<dl class="tsd-comment-tags">
    713. 

  713. 									<dt>example</dt>
    714. 

  714. 									<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #795E26">createClient</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;AppID&#039;</span><span style="color: #000000">);</span>
    715. 

  715. <span style="color: #001080">client</span>
    716. 

  716. <span style="color: #000000">  .</span><span style="color: #795E26">join</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;roomId&#039;</span><span style="color: #000000">, </span><span style="color: #A31515">&#039;userId&#039;</span><span style="color: #000000">, </span><span style="color: #A31515">&#039;token&#039;</span><span style="color: #000000">)</span>
    717. 

  717. <span style="color: #000000">  .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    718. 

  718. <span style="color: #000000">    </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">publish</span><span style="color: #000000">(</span><span style="color: #001080">localStream</span><span style="color: #000000">);</span>
    719. 

  719. <span style="color: #000000">  })</span>
    720. 

  720. <span style="color: #000000">  .</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    721. 

  721. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`加入房间失败 </span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    722. 

  722. <span style="color: #000000">  });</span>
    723. 

  723. </code></pre>
    724. 

  724. 									</dd>
    725. 

  725. 									<dt>throws</dt>
    726. 

  726. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    727. 

  727. 									</dd>
    728. 

  728. 								</dl>
    729. 

  729. 							</div>
    730. 

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

  731. 							<ul class="tsd-parameters">
    732. 

  732. 								<li>
    733. 

  733. 									<h5>appId: <span class="tsd-signature-type">string</span></h5>
    734. 

  734. 									<div class="tsd-comment tsd-typography">
    735. 

  735. 										<p>应用 ID，可在控制台查看</p>
    736. 

  736. 									</div>
    737. 

  737. 								</li>
    738. 

  738. 								<li>
    739. 

  739. 									<h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="interfaces/clientoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientOptions</a></h5>
    740. 

  740. 									<div class="tsd-comment tsd-typography">
    741. 

  741. 										<p>定义客户端的属性</p>
    742. 

  742. 									</div>
    743. 

  743. 								</li>
    744. 

  744. 							</ul>
    745. 

  745. 							<h4 class="tsd-returns-title">Returns <a href="classes/client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4>
    746. 

  746. 						</li>
    747. 

  747. 					</ul>
    748. 

  748. 				</section>
    749. 

  749. 				<section class="tsd-panel tsd-member tsd-kind-function">
    750. 

  750. 					<a name="createstream" class="tsd-anchor"></a>
    751. 

  751. 					<h3>create<wbr>Stream</h3>
    752. 

  752. 					<ul class="tsd-signatures tsd-kind-function">
    753. 

  753. 						<li class="tsd-signature tsd-kind-icon">create<wbr>Stream<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">: </span><a href="interfaces/localstreamoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LocalStreamOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/localstream.html" class="tsd-signature-type" data-tsd-kind="Class">LocalStream</a></li>
    754. 

  754. 					</ul>
    755. 

  755. 					<ul class="tsd-descriptions">
    756. 

  756. 						<li class="tsd-description">
    757. 

  757. 							<aside class="tsd-sources">
    758. 

  758. 							</aside>
    759. 

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

  760. 								<div class="lead">
    761. 

  761. 									<p>创建本地流</p>
    762. 

  762. 								</div>
    763. 

  763. 								<dl class="tsd-comment-tags">
    764. 

  764. 									<dt>example</dt>
    765. 

  765. 									<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">localStream</span><span style="color: #000000"> = </span><span style="color: #795E26">createStream</span><span style="color: #000000">({ </span><span style="color: #001080">audio:</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span><span style="color: #000000">, </span><span style="color: #001080">video:</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span><span style="color: #000000">, </span><span style="color: #001080">screen:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span><span style="color: #000000"> });</span>
    766. 

  766. <span style="color: #001080">localStream</span>
    767. 

  767. <span style="color: #000000">  .</span><span style="color: #795E26">init</span><span style="color: #000000">()</span>
    768. 

  768. <span style="color: #000000">  .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    769. 

  769. <span style="color: #000000">    </span><span style="color: #001080">localStream</span>
    770. 

  770. <span style="color: #000000">      .</span><span style="color: #795E26">play</span><span style="color: #000000">(</span><span style="color: #001080">container</span><span style="color: #000000">)</span>
    771. 

  771. <span style="color: #000000">      .</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`播放失败: </span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">)});</span>
    772. 

  772. <span style="color: #000000">  })</span>
    773. 

  773. <span style="color: #000000">  .</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    774. 

  774. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`本地流初始化失败 </span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    775. 

  775. <span style="color: #000000">  });</span>
    776. 

  776. </code></pre>
    777. 

  777. 									</dd>
    778. 

  778. 									<dt>throws</dt>
    779. 

  779. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    780. 

  780. 									</dd>
    781. 

  781. 								</dl>
    782. 

  782. 							</div>
    783. 

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

  784. 							<ul class="tsd-parameters">
    785. 

  785. 								<li>
    786. 

  786. 									<h5>opts: <a href="interfaces/localstreamoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LocalStreamOptions</a></h5>
    787. 

  787. 									<div class="tsd-comment tsd-typography">
    788. 

  788. 										<p>必传，定义本地音视频流的属性
    789. 

  789. 										注：</p>
    790. 

  790. 										<ol>
    791. 

  791. 											<li>video, screen 不可同时为 true</li>
    792. 

  792. 											<li>audio, video, screen 不可同时为 false</li>
    793. 

  793. 											<li>若指定了 file，则 init 时将优先使用 file 来创建初始化本地流的视频</li>
    794. 

  794. 											<li>screenAudio 在不同浏览器上表现不同，参见 <a href="interfaces/localstreamoptions.html">LocalStreamOptions</a></li>
    795. 

  795. 										</ol>
    796. 

  796. 									</div>
    797. 

  797. 								</li>
    798. 

  798. 							</ul>
    799. 

  799. 							<h4 class="tsd-returns-title">Returns <a href="classes/localstream.html" class="tsd-signature-type" data-tsd-kind="Class">LocalStream</a></h4>
    800. 

  800. 						</li>
    801. 

  801. 					</ul>
    802. 

  802. 				</section>
    803. 

  803. 				<section class="tsd-panel tsd-member tsd-kind-function">
    804. 

  804. 					<a name="devicedetection" class="tsd-anchor"></a>
    805. 

  805. 					<h3>device<wbr>Detection</h3>
    806. 

  806. 					<ul class="tsd-signatures tsd-kind-function">
    807. 

  807. 						<li class="tsd-signature tsd-kind-icon">device<wbr>Detection<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="interfaces/devicedetectionoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DeviceDetectionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
    808. 

  808. 					</ul>
    809. 

  809. 					<ul class="tsd-descriptions">
    810. 

  810. 						<li class="tsd-description">
    811. 

  811. 							<aside class="tsd-sources">
    812. 

  812. 							</aside>
    813. 

  813. 							<div class="tsd-comment tsd-typography">
    814. 

  814. 								<div class="lead">
    815. 

  815. 									<p>设备可用性检测 - 创建包含麦克风音频或摄像头视频的本地流时，有可能因为麦克风或摄像头设备问题（如驱动问题，或未经授权等），导致无法正确创建。此方法可用于设备检测，根据检测结果，再决定创建本地流时启用麦克风或摄像头或麦克风和摄像头</p>
    816. 

  816. 								</div>
    817. 

  817. 								<dl class="tsd-comment-tags">
    818. 

  818. 									<dt>example</dt>
    819. 

  819. 									<dd><pre><code class="language-js"><span style="color: #795E26">deviceDetection</span><span style="color: #000000">({</span><span style="color: #001080">audio:</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span><span style="color: #000000">, </span><span style="color: #001080">video:</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span><span style="color: #000000">})</span>
    820. 

  820. <span style="color: #000000">  .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    821. 

  821. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;设备可用&#039;</span><span style="color: #000000">);</span>
    822. 

  822. <span style="color: #000000">  })</span>
    823. 

  823. <span style="color: #000000">  .</span><span style="color: #795E26">catch</span><span style="color: #000000">(</span><span style="color: #001080">err</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    824. 

  824. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`设备不可用，</span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    825. 

  825. <span style="color: #000000">  });</span>
    826. 

  826. </code></pre>
    827. 

  827. 									</dd>
    828. 

  828. 									<dt>reject</dt>
    829. 

  829. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    830. 

  830. 									</dd>
    831. 

  831. 								</dl>
    832. 

  832. 							</div>
    833. 

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

  834. 							<ul class="tsd-parameters">
    835. 

  835. 								<li>
    836. 

  836. 									<h5>options: <a href="interfaces/devicedetectionoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DeviceDetectionOptions</a></h5>
    837. 

  837. 									<div class="tsd-comment tsd-typography">
    838. 

  838. 										<p>需指定设备时，请传入设备 ID</p>
    839. 

  839. 									</div>
    840. 

  840. 								</li>
    841. 

  841. 							</ul>
    842. 

  842. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
    843. 

  843. 						</li>
    844. 

  844. 					</ul>
    845. 

  845. 				</section>
    846. 

  846. 				<section class="tsd-panel tsd-member tsd-kind-function">
    847. 

  847. 					<a name="disableuploadlog" class="tsd-anchor"></a>
    848. 

  848. 					<h3>disable<wbr>Upload<wbr>Log</h3>
    849. 

  849. 					<ul class="tsd-signatures tsd-kind-function">
    850. 

  850. 						<li class="tsd-signature tsd-kind-icon">disable<wbr>Upload<wbr>Log<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
    851. 

  851. 					</ul>
    852. 

  852. 					<ul class="tsd-descriptions">
    853. 

  853. 						<li class="tsd-description">
    854. 

  854. 							<aside class="tsd-sources">
    855. 

  855. 							</aside>
    856. 

  856. 							<div class="tsd-comment tsd-typography">
    857. 

  857. 								<div class="lead">
    858. 

  858. 									<p>关闭日志（操作/错误/状态）的上报
    859. 

  859. 									注：若无特殊原因，不建议关闭日志上报，关闭后，在线上出现错误时，将无法根据日志定位问题</p>
    860. 

  860. 								</div>
    861. 

  861. 								<dl class="tsd-comment-tags">
    862. 

  862. 									<dt>example</dt>
    863. 

  863. 									<dd><pre><code class="language-js"><span style="color: #795E26">disableUploadLog</span><span style="color: #000000">();</span>
    864. 

  864. </code></pre>
    865. 

  865. 									</dd>
    866. 

  866. 								</dl>
    867. 

  867. 							</div>
    868. 

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

  869. 						</li>
    870. 

  870. 					</ul>
    871. 

  871. 				</section>
    872. 

  872. 				<section class="tsd-panel tsd-member tsd-kind-function">
    873. 

  873. 					<a name="enableuploadlog" class="tsd-anchor"></a>
    874. 

  874. 					<h3>enable<wbr>Upload<wbr>Log</h3>
    875. 

  875. 					<ul class="tsd-signatures tsd-kind-function">
    876. 

  876. 						<li class="tsd-signature tsd-kind-icon">enable<wbr>Upload<wbr>Log<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
    877. 

  877. 					</ul>
    878. 

  878. 					<ul class="tsd-descriptions">
    879. 

  879. 						<li class="tsd-description">
    880. 

  880. 							<aside class="tsd-sources">
    881. 

  881. 							</aside>
    882. 

  882. 							<div class="tsd-comment tsd-typography">
    883. 

  883. 								<div class="lead">
    884. 

  884. 									<p>开启日志（操作/错误/状态）的上报，默认开启</p>
    885. 

  885. 								</div>
    886. 

  886. 								<dl class="tsd-comment-tags">
    887. 

  887. 									<dt>example</dt>
    888. 

  888. 									<dd><pre><code class="language-js"><span style="color: #795E26">enableUploadLog</span><span style="color: #000000">();</span>
    889. 

  889. </code></pre>
    890. 

  890. 									</dd>
    891. 

  891. 								</dl>
    892. 

  892. 							</div>
    893. 

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

  894. 						</li>
    895. 

  895. 					</ul>
    896. 

  896. 				</section>
    897. 

  897. 				<section class="tsd-panel tsd-member tsd-kind-function">
    898. 

  898. 					<a name="generatetoken" class="tsd-anchor"></a>
    899. 

  899. 					<h3>generate<wbr>Token</h3>
    900. 

  900. 					<ul class="tsd-signatures tsd-kind-function">
    901. 

  901. 						<li class="tsd-signature tsd-kind-icon">generate<wbr>Token<span class="tsd-signature-symbol">(</span>appId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, appKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, roomId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, userId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
    902. 

  902. 					</ul>
    903. 

  903. 					<ul class="tsd-descriptions">
    904. 

  904. 						<li class="tsd-description">
    905. 

  905. 							<aside class="tsd-sources">
    906. 

  906. 							</aside>
    907. 

  907. 							<div class="tsd-comment tsd-typography">
    908. 

  908. 								<div class="lead">
    909. 

  909. 									<p>根据 AppId，AppKey，RoomId，UserId 生成 token，用于开发阶段临时快速的加入房间并验证功能，由于 AppKey 不可暴露于公网，因此生产环境中不建议使用此方法生成 token。</p>
    910. 

  910. 								</div>
    911. 

  911. 								<dl class="tsd-comment-tags">
    912. 

  912. 									<dt>example</dt>
    913. 

  913. 									<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">token</span><span style="color: #000000"> = </span><span style="color: #795E26">generateToken</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;appId&#039;</span><span style="color: #000000">, </span><span style="color: #A31515">&#039;appKey&#039;</span><span style="color: #000000">, </span><span style="color: #A31515">&#039;roomId&#039;</span><span style="color: #000000">, </span><span style="color: #A31515">&#039;userId&#039;</span><span style="color: #000000">);</span>
    914. 

  914. <span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">join</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;roomId&#039;</span><span style="color: #000000">, </span><span style="color: #A31515">&#039;userId&#039;</span><span style="color: #000000">, </span><span style="color: #001080">token</span><span style="color: #000000">);</span>
    915. 

  915. </code></pre>
    916. 

  916. 									</dd>
    917. 

  917. 								</dl>
    918. 

  918. 							</div>
    919. 

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

  920. 							<ul class="tsd-parameters">
    921. 

  921. 								<li>
    922. 

  922. 									<h5>appId: <span class="tsd-signature-type">string</span></h5>
    923. 

  923. 									<div class="tsd-comment tsd-typography">
    924. 

  924. 										<p>应用 ID，可在控制台查看</p>
    925. 

  925. 									</div>
    926. 

  926. 								</li>
    927. 

  927. 								<li>
    928. 

  928. 									<h5>appKey: <span class="tsd-signature-type">string</span></h5>
    929. 

  929. 									<div class="tsd-comment tsd-typography">
    930. 

  930. 										<p>应用密钥，可在控制台查看</p>
    931. 

  931. 									</div>
    932. 

  932. 								</li>
    933. 

  933. 								<li>
    934. 

  934. 									<h5>roomId: <span class="tsd-signature-type">string</span></h5>
    935. 

  935. 									<div class="tsd-comment tsd-typography">
    936. 

  936. 										<p>房间 ID</p>
    937. 

  937. 									</div>
    938. 

  938. 								</li>
    939. 

  939. 								<li>
    940. 

  940. 									<h5>userId: <span class="tsd-signature-type">string</span></h5>
    941. 

  941. 									<div class="tsd-comment tsd-typography">
    942. 

  942. 										<p>用户 ID</p>
    943. 

  943. 									</div>
    944. 

  944. 								</li>
    945. 

  945. 							</ul>
    946. 

  946. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
    947. 

  947. 						</li>
    948. 

  948. 					</ul>
    949. 

  949. 				</section>
    950. 

  950. 				<section class="tsd-panel tsd-member tsd-kind-function">
    951. 

  951. 					<a name="getcameras" class="tsd-anchor"></a>
    952. 

  952. 					<h3>get<wbr>Cameras</h3>
    953. 

  953. 					<ul class="tsd-signatures tsd-kind-function">
    954. 

  954. 						<li class="tsd-signature tsd-kind-icon">get<wbr>Cameras<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
    955. 

  955. 					</ul>
    956. 

  956. 					<ul class="tsd-descriptions">
    957. 

  957. 						<li class="tsd-description">
    958. 

  958. 							<aside class="tsd-sources">
    959. 

  959. 							</aside>
    960. 

  960. 							<div class="tsd-comment tsd-typography">
    961. 

  961. 								<div class="lead">
    962. 

  962. 									<p>获取摄像头设备列表，点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
    963. 

  963. 								</div>
    964. 

  964. 								<dl class="tsd-comment-tags">
    965. 

  965. 									<dt>example</dt>
    966. 

  966. 									<dd><pre><code class="language-js"><span style="color: #795E26">getCameras</span><span style="color: #000000">()</span>
    967. 

  967. <span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(</span><span style="color: #001080">devices</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    968. 

  968. <span style="color: #000000">   </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`获取设备列表成功：`</span><span style="color: #000000">, </span><span style="color: #001080">devices</span><span style="color: #000000">);</span>
    969. 

  969. <span style="color: #000000"> })</span>
    970. 

  970. <span style="color: #000000"> .</span><span style="color: #795E26">catch</span><span style="color: #000000">(</span><span style="color: #001080">err</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    971. 

  971. <span style="color: #000000">   </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`获取设备列表失败：</span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    972. 

  972. <span style="color: #000000"> });</span>
    973. 

  973. </code></pre>
    974. 

  974. 									</dd>
    975. 

  975. 									<dt>reject</dt>
    976. 

  976. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    977. 

  977. 									</dd>
    978. 

  978. 								</dl>
    979. 

  979. 							</div>
    980. 

  980. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
    981. 

  981. 						</li>
    982. 

  982. 					</ul>
    983. 

  983. 				</section>
    984. 

  984. 				<section class="tsd-panel tsd-member tsd-kind-function">
    985. 

  985. 					<a name="getdevices" class="tsd-anchor"></a>
    986. 

  986. 					<h3>get<wbr>Devices</h3>
    987. 

  987. 					<ul class="tsd-signatures tsd-kind-function">
    988. 

  988. 						<li class="tsd-signature tsd-kind-icon">get<wbr>Devices<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
    989. 

  989. 					</ul>
    990. 

  990. 					<ul class="tsd-descriptions">
    991. 

  991. 						<li class="tsd-description">
    992. 

  992. 							<aside class="tsd-sources">
    993. 

  993. 							</aside>
    994. 

  994. 							<div class="tsd-comment tsd-typography">
    995. 

  995. 								<div class="lead">
    996. 

  996. 									<p>获取音视频输入/输出设备列表，点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
    997. 

  997. 								</div>
    998. 

  998. 								<dl class="tsd-comment-tags">
    999. 

  999. 									<dt>example</dt>
    1000. 

  1000. 									<dd><pre><code class="language-js"><span style="color: #795E26">getDevices</span><span style="color: #000000">()</span>
    1001. 

  1001. <span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(</span><span style="color: #001080">devices</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    1002. 

  1002. <span style="color: #000000">   </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`获取设备列表成功：`</span><span style="color: #000000">, </span><span style="color: #001080">devices</span><span style="color: #000000">);</span>
    1003. 

  1003. <span style="color: #000000"> })</span>
    1004. 

  1004. <span style="color: #000000"> .</span><span style="color: #795E26">catch</span><span style="color: #000000">(</span><span style="color: #001080">err</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    1005. 

  1005. <span style="color: #000000">   </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`获取设备列表失败：</span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    1006. 

  1006. <span style="color: #000000"> });</span>
    1007. 

  1007. </code></pre>
    1008. 

  1008. 									</dd>
    1009. 

  1009. 									<dt>reject</dt>
    1010. 

  1010. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    1011. 

  1011. 									</dd>
    1012. 

  1012. 								</dl>
    1013. 

  1013. 							</div>
    1014. 

  1014. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
    1015. 

  1015. 						</li>
    1016. 

  1016. 					</ul>
    1017. 

  1017. 				</section>
    1018. 

  1018. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1019. 

  1019. 					<a name="getloudspeakers" class="tsd-anchor"></a>
    1020. 

  1020. 					<h3>get<wbr>Loudspeakers</h3>
    1021. 

  1021. 					<ul class="tsd-signatures tsd-kind-function">
    1022. 

  1022. 						<li class="tsd-signature tsd-kind-icon">get<wbr>Loudspeakers<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
    1023. 

  1023. 					</ul>
    1024. 

  1024. 					<ul class="tsd-descriptions">
    1025. 

  1025. 						<li class="tsd-description">
    1026. 

  1026. 							<aside class="tsd-sources">
    1027. 

  1027. 							</aside>
    1028. 

  1028. 							<div class="tsd-comment tsd-typography">
    1029. 

  1029. 								<div class="lead">
    1030. 

  1030. 									<p>获取扬声器设备列表，点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
    1031. 

  1031. 								</div>
    1032. 

  1032. 								<dl class="tsd-comment-tags">
    1033. 

  1033. 									<dt>example</dt>
    1034. 

  1034. 									<dd><pre><code class="language-js"><span style="color: #795E26">getLoudspeakers</span><span style="color: #000000">()</span>
    1035. 

  1035. <span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(</span><span style="color: #001080">devices</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    1036. 

  1036. <span style="color: #000000">   </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`获取设备列表成功：`</span><span style="color: #000000">, </span><span style="color: #001080">devices</span><span style="color: #000000">);</span>
    1037. 

  1037. <span style="color: #000000"> })</span>
    1038. 

  1038. <span style="color: #000000"> .</span><span style="color: #795E26">catch</span><span style="color: #000000">(</span><span style="color: #001080">err</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    1039. 

  1039. <span style="color: #000000">   </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`获取设备列表失败：</span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    1040. 

  1040. <span style="color: #000000"> });</span>
    1041. 

  1041. </code></pre>
    1042. 

  1042. 									</dd>
    1043. 

  1043. 									<dt>reject</dt>
    1044. 

  1044. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    1045. 

  1045. 									</dd>
    1046. 

  1046. 								</dl>
    1047. 

  1047. 							</div>
    1048. 

  1048. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
    1049. 

  1049. 						</li>
    1050. 

  1050. 					</ul>
    1051. 

  1051. 				</section>
    1052. 

  1052. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1053. 

  1053. 					<a name="getmicrophones" class="tsd-anchor"></a>
    1054. 

  1054. 					<h3>get<wbr>Microphones</h3>
    1055. 

  1055. 					<ul class="tsd-signatures tsd-kind-function">
    1056. 

  1056. 						<li class="tsd-signature tsd-kind-icon">get<wbr>Microphones<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
    1057. 

  1057. 					</ul>
    1058. 

  1058. 					<ul class="tsd-descriptions">
    1059. 

  1059. 						<li class="tsd-description">
    1060. 

  1060. 							<aside class="tsd-sources">
    1061. 

  1061. 							</aside>
    1062. 

  1062. 							<div class="tsd-comment tsd-typography">
    1063. 

  1063. 								<div class="lead">
    1064. 

  1064. 									<p>获取麦克风设备列表，点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
    1065. 

  1065. 								</div>
    1066. 

  1066. 								<dl class="tsd-comment-tags">
    1067. 

  1067. 									<dt>example</dt>
    1068. 

  1068. 									<dd><pre><code class="language-js"><span style="color: #795E26">getMicrophones</span><span style="color: #000000">()</span>
    1069. 

  1069. <span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(</span><span style="color: #001080">devices</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    1070. 

  1070. <span style="color: #000000">   </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`获取设备列表成功：`</span><span style="color: #000000">, </span><span style="color: #001080">devices</span><span style="color: #000000">);</span>
    1071. 

  1071. <span style="color: #000000"> })</span>
    1072. 

  1072. <span style="color: #000000"> .</span><span style="color: #795E26">catch</span><span style="color: #000000">(</span><span style="color: #001080">err</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    1073. 

  1073. <span style="color: #000000">   </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`获取设备列表失败：</span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    1074. 

  1074. <span style="color: #000000"> });</span>
    1075. 

  1075. </code></pre>
    1076. 

  1076. 									</dd>
    1077. 

  1077. 									<dt>reject</dt>
    1078. 

  1078. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    1079. 

  1079. 									</dd>
    1080. 

  1080. 								</dl>
    1081. 

  1081. 							</div>
    1082. 

  1082. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
    1083. 

  1083. 						</li>
    1084. 

  1084. 					</ul>
    1085. 

  1085. 				</section>
    1086. 

  1086. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1087. 

  1087. 					<a name="getsupportedcodec" class="tsd-anchor"></a>
    1088. 

  1088. 					<h3>get<wbr>Supported<wbr>Codec</h3>
    1089. 

  1089. 					<ul class="tsd-signatures tsd-kind-function">
    1090. 

  1090. 						<li class="tsd-signature tsd-kind-icon">get<wbr>Supported<wbr>Codec<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/codecs.html" class="tsd-signature-type" data-tsd-kind="Interface">Codecs</a><span class="tsd-signature-symbol">&gt;</span></li>
    1091. 

  1091. 					</ul>
    1092. 

  1092. 					<ul class="tsd-descriptions">
    1093. 

  1093. 						<li class="tsd-description">
    1094. 

  1094. 							<aside class="tsd-sources">
    1095. 

  1095. 							</aside>
    1096. 

  1096. 							<div class="tsd-comment tsd-typography">
    1097. 

  1097. 								<div class="lead">
    1098. 

  1098. 									<p>检测浏览器支持的音视频编解码格式</p>
    1099. 

  1099. 								</div>
    1100. 

  1100. 								<dl class="tsd-comment-tags">
    1101. 

  1101. 									<dt>example</dt>
    1102. 

  1102. 									<dd><pre><code class="language-js"><span style="color: #795E26">getSupportedCodec</span><span style="color: #000000">()</span>
    1103. 

  1103. <span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">((</span><span style="color: #001080">codecs</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    1104. 

  1104. <span style="color: #000000">   </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`浏览器支持的音频编解码格式有 </span><span style="color: #0000FF">${</span><span style="color: #001080">codecs</span><span style="color: #000000FF">.</span><span style="color: #001080">audio</span><span style="color: #0000FF">}</span><span style="color: #A31515">，视频编解码格式有 </span><span style="color: #0000FF">${</span><span style="color: #001080">codecs</span><span style="color: #000000FF">.</span><span style="color: #001080">video</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    1105. 

  1105. <span style="color: #000000"> })</span>
    1106. 

  1106. <span style="color: #000000"> .</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    1107. 

  1107. <span style="color: #000000">   </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`浏览器获取音视频编解码格式失败，</span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    1108. 

  1108. <span style="color: #000000"> });</span>
    1109. 

  1109. </code></pre>
    1110. 

  1110. 									</dd>
    1111. 

  1111. 								</dl>
    1112. 

  1112. 							</div>
    1113. 

  1113. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/codecs.html" class="tsd-signature-type" data-tsd-kind="Interface">Codecs</a><span class="tsd-signature-symbol">&gt;</span></h4>
    1114. 

  1114. 						</li>
    1115. 

  1115. 					</ul>
    1116. 

  1116. 				</section>
    1117. 

  1117. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1118. 

  1118. 					<a name="issupportscreenshare" class="tsd-anchor"></a>
    1119. 

  1119. 					<h3>is<wbr>Support<wbr>Screen<wbr>Share</h3>
    1120. 

  1120. 					<ul class="tsd-signatures tsd-kind-function">
    1121. 

  1121. 						<li class="tsd-signature tsd-kind-icon">is<wbr>Support<wbr>Screen<wbr>Share<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
    1122. 

  1122. 					</ul>
    1123. 

  1123. 					<ul class="tsd-descriptions">
    1124. 

  1124. 						<li class="tsd-description">
    1125. 

  1125. 							<aside class="tsd-sources">
    1126. 

  1126. 							</aside>
    1127. 

  1127. 							<div class="tsd-comment tsd-typography">
    1128. 

  1128. 								<div class="lead">
    1129. 

  1129. 									<p>检测浏览器是否支持屏幕共享</p>
    1130. 

  1130. 								</div>
    1131. 

  1131. 								<dl class="tsd-comment-tags">
    1132. 

  1132. 									<dt>example</dt>
    1133. 

  1133. 									<dd><pre><code class="language-js"><span style="color: #AF00DB">if</span><span style="color: #000000"> (!</span><span style="color: #795E26">isSupportScreenShare</span><span style="color: #000000">()) {</span>
    1134. 

  1134. <span style="color: #000000">  </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`当前浏览器不支持屏幕共享`</span><span style="color: #000000">);</span>
    1135. 

  1135. <span style="color: #000000">}</span>
    1136. 

  1136. </code></pre>
    1137. 

  1137. 									</dd>
    1138. 

  1138. 								</dl>
    1139. 

  1139. 							</div>
    1140. 

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

  1141. 						</li>
    1142. 

  1142. 					</ul>
    1143. 

  1143. 				</section>
    1144. 

  1144. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1145. 

  1145. 					<a name="issupportwebrtc" class="tsd-anchor"></a>
    1146. 

  1146. 					<h3>is<wbr>Support<wbr>WebRTC</h3>
    1147. 

  1147. 					<ul class="tsd-signatures tsd-kind-function">
    1148. 

  1148. 						<li class="tsd-signature tsd-kind-icon">is<wbr>Support<wbr>WebRTC<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
    1149. 

  1149. 					</ul>
    1150. 

  1150. 					<ul class="tsd-descriptions">
    1151. 

  1151. 						<li class="tsd-description">
    1152. 

  1152. 							<aside class="tsd-sources">
    1153. 

  1153. 							</aside>
    1154. 

  1154. 							<div class="tsd-comment tsd-typography">
    1155. 

  1155. 								<div class="lead">
    1156. 

  1156. 									<p>检测浏览器是否完全（可访问本地音视频设备）支持 WebRTC。</p>
    1157. 

  1157. 								</div>
    1158. 

  1158. 								<dl class="tsd-comment-tags">
    1159. 

  1159. 									<dt>example</dt>
    1160. 

  1160. 									<dd><pre><code class="language-js"><span style="color: #AF00DB">if</span><span style="color: #000000"> (!</span><span style="color: #795E26">isSupportWebRTC</span><span style="color: #000000">()) {</span>
    1161. 

  1161. <span style="color: #000000">  </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`当前浏览器不完全支持 WebRTC，建议使用 Chrome 浏览器，iOS 系统建议使用 Safari 浏览器`</span><span style="color: #000000">);</span>
    1162. 

  1162. <span style="color: #000000">}</span>
    1163. 

  1163. </code></pre>
    1164. 

  1164. 									</dd>
    1165. 

  1165. 								</dl>
    1166. 

  1166. 							</div>
    1167. 

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

  1168. 						</li>
    1169. 

  1169. 					</ul>
    1170. 

  1170. 				</section>
    1171. 

  1171. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1172. 

  1172. 					<a name="setloglevel" class="tsd-anchor"></a>
    1173. 

  1173. 					<h3>set<wbr>Log<wbr>Level</h3>
    1174. 

  1174. 					<ul class="tsd-signatures tsd-kind-function">
    1175. 

  1175. 						<li class="tsd-signature tsd-kind-icon">set<wbr>Log<wbr>Level<span class="tsd-signature-symbol">(</span>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LogLevel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
    1176. 

  1176. 					</ul>
    1177. 

  1177. 					<ul class="tsd-descriptions">
    1178. 

  1178. 						<li class="tsd-description">
    1179. 

  1179. 							<aside class="tsd-sources">
    1180. 

  1180. 							</aside>
    1181. 

  1181. 							<div class="tsd-comment tsd-typography">
    1182. 

  1182. 								<div class="lead">
    1183. 

  1183. 									<p>设置日志打印级别，用于打印出更多日志来调试或定位问题，默认 warn 级别</p>
    1184. 

  1184. 								</div>
    1185. 

  1185. 								<dl class="tsd-comment-tags">
    1186. 

  1186. 									<dt>example</dt>
    1187. 

  1187. 									<dd><pre><code class="language-js"><span style="color: #795E26">setLogLevel</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;info&#039;</span><span style="color: #000000">);</span>
    1188. 

  1188. </code></pre>
    1189. 

  1189. 									</dd>
    1190. 

  1190. 								</dl>
    1191. 

  1191. 							</div>
    1192. 

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

  1193. 							<ul class="tsd-parameters">
    1194. 

  1194. 								<li>
    1195. 

  1195. 									<h5>level: <span class="tsd-signature-type">LogLevel</span></h5>
    1196. 

  1196. 									<div class="tsd-comment tsd-typography">
    1197. 

  1197. 										<p>日志级别，有 &#39;debug&#39;, &#39;info&#39;, &#39;warn&#39;, &#39;error&#39; 级别;</p>
    1198. 

  1198. 									</div>
    1199. 

  1199. 								</li>
    1200. 

  1200. 							</ul>
    1201. 

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

  1202. 						</li>
    1203. 

  1203. 					</ul>
    1204. 

  1204. 				</section>
    1205. 

  1205. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1206. 

  1206. 					<a name="setservers" class="tsd-anchor"></a>
    1207. 

  1207. 					<h3>set<wbr>Servers</h3>
    1208. 

  1208. 					<ul class="tsd-signatures tsd-kind-function">
    1209. 

  1209. 						<li class="tsd-signature tsd-kind-icon">set<wbr>Servers<span class="tsd-signature-symbol">(</span>conf<span class="tsd-signature-symbol">: </span><a href="interfaces/serverconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
    1210. 

  1210. 					</ul>
    1211. 

  1211. 					<ul class="tsd-descriptions">
    1212. 

  1212. 						<li class="tsd-description">
    1213. 

  1213. 							<aside class="tsd-sources">
    1214. 

  1214. 							</aside>
    1215. 

  1215. 							<div class="tsd-comment tsd-typography">
    1216. 

  1216. 								<div class="lead">
    1217. 

  1217. 									<p>用于私有化部署时，指定部署的服务器地址</p>
    1218. 

  1218. 								</div>
    1219. 

  1219. 								<dl class="tsd-comment-tags">
    1220. 

  1220. 									<dt>example</dt>
    1221. 

  1221. 									<dd><pre><code class="language-js"><span style="color: #795E26">setServers</span><span style="color: #000000">({</span>
    1222. 

  1222. <span style="color: #000000"> </span><span style="color: #001080">gateway:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;https://my-rtc.com&#039;</span><span style="color: #000000">, </span><span style="color: #008000">// 指定网关</span>
    1223. 

  1223. <span style="color: #000000"> </span><span style="color: #001080">log:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;https://log.my-rtc.com&#039;</span><span style="color: #000000">, </span><span style="color: #008000">// 指定日志服务器</span>
    1224. 

  1224. <span style="color: #000000">});</span>
    1225. 

  1225. </code></pre>
    1226. 

  1226. 										<p><strong>特别地，单信令服务器时，不需要网关进行分配信令服务器，可以直接指定信令服务器</strong></p>
    1227. 

  1227. 										<pre><code class="language-js"><span style="color: #795E26">setServers</span><span style="color: #000000">({</span>
    1228. 

  1228. <span style="color: #000000"> </span><span style="color: #001080">signal:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;wss://my-rtc.com:5005&#039;</span><span style="color: #000000">, </span><span style="color: #008000">// 直接指定信令服务器</span>
    1229. 

  1229. <span style="color: #000000"> </span><span style="color: #001080">log:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;https://log.my-rtc.com&#039;</span><span style="color: #000000">, </span><span style="color: #008000">// 指定日志服务器</span>
    1230. 

  1230. <span style="color: #000000">});</span>
    1231. 

  1231. </code></pre>
    1232. 

  1232. 									</dd>
    1233. 

  1233. 									<dt>throws</dt>
    1234. 

  1234. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    1235. 

  1235. 									</dd>
    1236. 

  1236. 								</dl>
    1237. 

  1237. 							</div>
    1238. 

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

  1239. 							<ul class="tsd-parameters">
    1240. 

  1240. 								<li>
    1241. 

  1241. 									<h5>conf: <a href="interfaces/serverconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerConfig</a></h5>
    1242. 

  1242. 									<div class="tsd-comment tsd-typography">
    1243. 

  1243. 										<p>服务器配置，具体描述参见 ServerConfig 的说明</p>
    1244. 

  1244. 									</div>
    1245. 

  1245. 								</li>
    1246. 

  1246. 							</ul>
    1247. 

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

  1248. 						</li>
    1249. 

  1249. 					</ul>
    1250. 

  1250. 				</section>
    1251. 

  1251. 			</section>
    1252. 

  1252. 		</div>
    1253. 

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

  1254. 			<nav class="tsd-navigation primary">
    1255. 

  1255. 				<ul>
    1256. 

  1256. 					<li class="current ">
    1257. 

  1257. 						<a href="index.html">Exports</a>
    1258. 

  1258. 					</li>
    1259. 

  1259. 				</ul>
    1260. 

  1260. 			</nav>
    1261. 

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

  1262. 				<ul class="before-current">
    1263. 

  1263. 					<li class=" tsd-kind-class">
    1264. 

  1264. 						<a href="classes/client.html" class="tsd-kind-icon">Client</a>
    1265. 

  1265. 					</li>
    1266. 

  1266. 					<li class=" tsd-kind-class">
    1267. 

  1267. 						<a href="classes/localstream.html" class="tsd-kind-icon">Local<wbr>Stream</a>
    1268. 

  1268. 					</li>
    1269. 

  1269. 					<li class=" tsd-kind-class">
    1270. 

  1270. 						<a href="classes/remotestream.html" class="tsd-kind-icon">Remote<wbr>Stream</a>
    1271. 

  1271. 					</li>
    1272. 

  1272. 					<li class=" tsd-kind-class">
    1273. 

  1273. 						<a href="classes/rtcerror.html" class="tsd-kind-icon">Rtc<wbr>Error</a>
    1274. 

  1274. 					</li>
    1275. 

  1275. 					<li class=" tsd-kind-class">
    1276. 

  1276. 						<a href="classes/stream.html" class="tsd-kind-icon">Stream</a>
    1277. 

  1277. 					</li>
    1278. 

  1278. 					<li class=" tsd-kind-class">
    1279. 

  1279. 						<a href="classes/user.html" class="tsd-kind-icon">User</a>
    1280. 

  1280. 					</li>
    1281. 

  1281. 					<li class=" tsd-kind-interface">
    1282. 

  1282. 						<a href="interfaces/audiostats.html" class="tsd-kind-icon">Audio<wbr>Stats</a>
    1283. 

  1283. 					</li>
    1284. 

  1284. 					<li class=" tsd-kind-interface">
    1285. 

  1285. 						<a href="interfaces/clientoptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
    1286. 

  1286. 					</li>
    1287. 

  1287. 					<li class=" tsd-kind-interface">
    1288. 

  1288. 						<a href="interfaces/clientplugin.html" class="tsd-kind-icon">Client<wbr>Plugin</a>
    1289. 

  1289. 					</li>
    1290. 

  1290. 					<li class=" tsd-kind-interface">
    1291. 

  1291. 						<a href="interfaces/codecs.html" class="tsd-kind-icon">Codecs</a>
    1292. 

  1292. 					</li>
    1293. 

  1293. 					<li class=" tsd-kind-interface">
    1294. 

  1294. 						<a href="interfaces/devicedetectionoptions.html" class="tsd-kind-icon">Device<wbr>Detection<wbr>Options</a>
    1295. 

  1295. 					</li>
    1296. 

  1296. 					<li class=" tsd-kind-interface">
    1297. 

  1297. 						<a href="interfaces/joinoptions.html" class="tsd-kind-icon">Join<wbr>Options</a>
    1298. 

  1298. 					</li>
    1299. 

  1299. 					<li class=" tsd-kind-interface">
    1300. 

  1300. 						<a href="interfaces/localstreamoptions.html" class="tsd-kind-icon">Local<wbr>Stream<wbr>Options</a>
    1301. 

  1301. 					</li>
    1302. 

  1302. 					<li class=" tsd-kind-interface">
    1303. 

  1303. 						<a href="interfaces/networkstats.html" class="tsd-kind-icon">Network<wbr>Stats</a>
    1304. 

  1304. 					</li>
    1305. 

  1305. 					<li class=" tsd-kind-interface">
    1306. 

  1306. 						<a href="interfaces/playoptions.html" class="tsd-kind-icon">Play<wbr>Options</a>
    1307. 

  1307. 					</li>
    1308. 

  1308. 					<li class=" tsd-kind-interface tsd-has-type-parameter">
    1309. 

  1309. 						<a href="interfaces/rtcevent.html" class="tsd-kind-icon">Rtc<wbr>Event</a>
    1310. 

  1310. 					</li>
    1311. 

  1311. 					<li class=" tsd-kind-interface">
    1312. 

  1312. 						<a href="interfaces/serverconfig.html" class="tsd-kind-icon">Server<wbr>Config</a>
    1313. 

  1313. 					</li>
    1314. 

  1314. 					<li class=" tsd-kind-interface">
    1315. 

  1315. 						<a href="interfaces/snapshotoptions.html" class="tsd-kind-icon">Snapshot<wbr>Options</a>
    1316. 

  1316. 					</li>
    1317. 

  1317. 					<li class=" tsd-kind-interface">
    1318. 

  1318. 						<a href="interfaces/streamplugin.html" class="tsd-kind-icon">Stream<wbr>Plugin</a>
    1319. 

  1319. 					</li>
    1320. 

  1320. 					<li class=" tsd-kind-interface">
    1321. 

  1321. 						<a href="interfaces/streamstats.html" class="tsd-kind-icon">Stream<wbr>Stats</a>
    1322. 

  1322. 					</li>
    1323. 

  1323. 					<li class=" tsd-kind-interface">
    1324. 

  1324. 						<a href="interfaces/videostats.html" class="tsd-kind-icon">Video<wbr>Stats</a>
    1325. 

  1325. 					</li>
    1326. 

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

  1327. 						<a href="index.html#audiocodec" class="tsd-kind-icon">Audio<wbr>Codec</a>
    1328. 

  1328. 					</li>
    1329. 

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

  1330. 						<a href="index.html#errorcode" class="tsd-kind-icon">Error<wbr>Code</a>
    1331. 

  1331. 					</li>
    1332. 

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

  1333. 						<a href="index.html#mediatype" class="tsd-kind-icon">Media<wbr>Type</a>
    1334. 

  1334. 					</li>
    1335. 

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

  1336. 						<a href="index.html#playcontrolstype" class="tsd-kind-icon">Play<wbr>Controls<wbr>Type</a>
    1337. 

  1337. 					</li>
    1338. 

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

  1339. 						<a href="index.html#playervideofittype" class="tsd-kind-icon">Player<wbr>Video<wbr>Fit<wbr>Type</a>
    1340. 

  1340. 					</li>
    1341. 

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

  1342. 						<a href="index.html#roletype" class="tsd-kind-icon">Role<wbr>Type</a>
    1343. 

  1343. 					</li>
    1344. 

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

  1345. 						<a href="index.html#roomtype" class="tsd-kind-icon">Room<wbr>Type</a>
    1346. 

  1346. 					</li>
    1347. 

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

  1348. 						<a href="index.html#rtcconnectionevent" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>Event</a>
    1349. 

  1349. 					</li>
    1350. 

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

  1351. 						<a href="index.html#rtcconnectioneventtype" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>Event<wbr>Type</a>
    1352. 

  1352. 					</li>
    1353. 

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

  1354. 						<a href="index.html#rtceventtype" class="tsd-kind-icon">Rtc<wbr>Event<wbr>Type</a>
    1355. 

  1355. 					</li>
    1356. 

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

  1357. 						<a href="index.html#rtcplayerevent" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event</a>
    1358. 

  1358. 					</li>
    1359. 

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

  1360. 						<a href="index.html#rtcplayereventtype" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event<wbr>Type</a>
    1361. 

  1361. 					</li>
    1362. 

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

  1363. 						<a href="index.html#rtcstreamevent" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event</a>
    1364. 

  1364. 					</li>
    1365. 

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

  1366. 						<a href="index.html#rtcstreameventtype" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event<wbr>Type</a>
    1367. 

  1367. 					</li>
    1368. 

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

  1369. 						<a href="index.html#rtcuserevent" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event</a>
    1370. 

  1370. 					</li>
    1371. 

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

  1372. 						<a href="index.html#rtcusereventtype" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event<wbr>Type</a>
    1373. 

  1373. 					</li>
    1374. 

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

  1375. 						<a href="index.html#screenprofile" class="tsd-kind-icon">Screen<wbr>Profile</a>
    1376. 

  1376. 					</li>
    1377. 

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

  1378. 						<a href="index.html#switchdevicetype" class="tsd-kind-icon">Switch<wbr>Device<wbr>Type</a>
    1379. 

  1379. 					</li>
    1380. 

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

  1381. 						<a href="index.html#videocodec" class="tsd-kind-icon">Video<wbr>Codec</a>
    1382. 

  1382. 					</li>
    1383. 

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

  1384. 						<a href="index.html#videoprofile" class="tsd-kind-icon">Video<wbr>Profile</a>
    1385. 

  1385. 					</li>
    1386. 

  1386. 					<li class=" tsd-kind-variable">
    1387. 

  1387. 						<a href="index.html#version" class="tsd-kind-icon">version</a>
    1388. 

  1388. 					</li>
    1389. 

  1389. 					<li class=" tsd-kind-function">
    1390. 

  1390. 						<a href="index.html#createclient" class="tsd-kind-icon">create<wbr>Client</a>
    1391. 

  1391. 					</li>
    1392. 

  1392. 					<li class=" tsd-kind-function">
    1393. 

  1393. 						<a href="index.html#createstream" class="tsd-kind-icon">create<wbr>Stream</a>
    1394. 

  1394. 					</li>
    1395. 

  1395. 					<li class=" tsd-kind-function">
    1396. 

  1396. 						<a href="index.html#devicedetection" class="tsd-kind-icon">device<wbr>Detection</a>
    1397. 

  1397. 					</li>
    1398. 

  1398. 					<li class=" tsd-kind-function">
    1399. 

  1399. 						<a href="index.html#disableuploadlog" class="tsd-kind-icon">disable<wbr>Upload<wbr>Log</a>
    1400. 

  1400. 					</li>
    1401. 

  1401. 					<li class=" tsd-kind-function">
    1402. 

  1402. 						<a href="index.html#enableuploadlog" class="tsd-kind-icon">enable<wbr>Upload<wbr>Log</a>
    1403. 

  1403. 					</li>
    1404. 

  1404. 					<li class=" tsd-kind-function">
    1405. 

  1405. 						<a href="index.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a>
    1406. 

  1406. 					</li>
    1407. 

  1407. 					<li class=" tsd-kind-function">
    1408. 

  1408. 						<a href="index.html#getcameras" class="tsd-kind-icon">get<wbr>Cameras</a>
    1409. 

  1409. 					</li>
    1410. 

  1410. 					<li class=" tsd-kind-function">
    1411. 

  1411. 						<a href="index.html#getdevices" class="tsd-kind-icon">get<wbr>Devices</a>
    1412. 

  1412. 					</li>
    1413. 

  1413. 					<li class=" tsd-kind-function">
    1414. 

  1414. 						<a href="index.html#getloudspeakers" class="tsd-kind-icon">get<wbr>Loudspeakers</a>
    1415. 

  1415. 					</li>
    1416. 

  1416. 					<li class=" tsd-kind-function">
    1417. 

  1417. 						<a href="index.html#getmicrophones" class="tsd-kind-icon">get<wbr>Microphones</a>
    1418. 

  1418. 					</li>
    1419. 

  1419. 					<li class=" tsd-kind-function">
    1420. 

  1420. 						<a href="index.html#getsupportedcodec" class="tsd-kind-icon">get<wbr>Supported<wbr>Codec</a>
    1421. 

  1421. 					</li>
    1422. 

  1422. 					<li class=" tsd-kind-function">
    1423. 

  1423. 						<a href="index.html#issupportscreenshare" class="tsd-kind-icon">is<wbr>Support<wbr>Screen<wbr>Share</a>
    1424. 

  1424. 					</li>
    1425. 

  1425. 					<li class=" tsd-kind-function">
    1426. 

  1426. 						<a href="index.html#issupportwebrtc" class="tsd-kind-icon">is<wbr>Support<wbr>WebRTC</a>
    1427. 

  1427. 					</li>
    1428. 

  1428. 					<li class=" tsd-kind-function">
    1429. 

  1429. 						<a href="index.html#setloglevel" class="tsd-kind-icon">set<wbr>Log<wbr>Level</a>
    1430. 

  1430. 					</li>
    1431. 

  1431. 					<li class=" tsd-kind-function">
    1432. 

  1432. 						<a href="index.html#setservers" class="tsd-kind-icon">set<wbr>Servers</a>
    1433. 

  1433. 					</li>
    1434. 

  1434. 				</ul>
    1435. 

  1435. 			</nav>
    1436. 

  1436. 		</div>
    1437. 

  1437. 	</div>
    1438. 

  1438. </div>
    1439. 

  1439. <footer class="with-border-bottom">
    1440. 

  1440. 	<div class="container">
    1441. 

  1441. 		<h2>Legend</h2>
    1442. 

  1442. 		<div class="tsd-legend-group">
    1443. 

  1443. 			<ul class="tsd-legend">
    1444. 

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

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

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

  1447. 			</ul>
    1448. 

  1448. 			<ul class="tsd-legend">
    1449. 

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

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

  1451. 			</ul>
    1452. 

  1452. 			<ul class="tsd-legend">
    1453. 

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

  1454. 				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
    1455. 

  1455. 			</ul>
    1456. 

  1456. 			<ul class="tsd-legend">
    1457. 

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

  1458. 			</ul>
    1459. 

  1459. 		</div>
    1460. 

  1460. 	</div>
    1461. 

  1461. </footer>
    1462. 

  1462. <div class="container tsd-generator">
    1463. 

  1463. 	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
    1464. 

  1464. </div>
    1465. 

  1465. <div class="overlay"></div>
    1466. 

  1466. <script src="assets/js/main.js"></script>
    1467. 

  1467. </body>
    1468. 

  1468. </html>
    1469.