Home Explore Help
Sign In
githab
/
urtc-sdk-web
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 8e7aadd61f
Branches Tags
urtc-sdk-web
/
docs
/
index.html

index.html 117 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694 
  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/connectionstates.html" class="tsd-kind-icon">Connection<wbr>States</a></li>
    83. 

  83. 								<li class="tsd-kind-interface"><a href="interfaces/devicechangedeventdata.html" class="tsd-kind-icon">Device<wbr>Changed<wbr>Event<wbr>Data</a></li>
    84. 

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

  85. 								<li class="tsd-kind-interface"><a href="interfaces/getdevicesoptions.html" class="tsd-kind-icon">Get<wbr>Devices<wbr>Options</a></li>
    86. 

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

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

  88. 								<li class="tsd-kind-interface"><a href="interfaces/networkqualities.html" class="tsd-kind-icon">Network<wbr>Qualities</a></li>
    89. 

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

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

  91. 								<li class="tsd-kind-interface"><a href="interfaces/playereventdata.html" class="tsd-kind-icon">Player<wbr>Event<wbr>Data</a></li>
    92. 

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

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

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

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

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

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

  98. 							</ul>
    99. 

  99. 						</section>
    100. 

  100. 						<section class="tsd-index-section ">
    101. 

  101. 							<h3>Type aliases</h3>
    102. 

  102. 							<ul class="tsd-index-list">
    103. 

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

  104. 								<li class="tsd-kind-type-alias"><a href="index.html#connectionstate" class="tsd-kind-icon">Connection<wbr>State</a></li>
    105. 

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

  106. 								<li class="tsd-kind-type-alias"><a href="index.html#facingmode" class="tsd-kind-icon">Facing<wbr>Mode</a></li>
    107. 

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

  108. 								<li class="tsd-kind-type-alias"><a href="index.html#networkquality" class="tsd-kind-icon">Network<wbr>Quality</a></li>
    109. 

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

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

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

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

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

  114. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcconnectionstateeventtype" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>State<wbr>Event<wbr>Type</a></li>
    115. 

  115. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcdevicechangedevent" class="tsd-kind-icon">Rtc<wbr>Device<wbr>Changed<wbr>Event</a></li>
    116. 

  116. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcdevicechangedeventtype" class="tsd-kind-icon">Rtc<wbr>Device<wbr>Changed<wbr>Event<wbr>Type</a></li>
    117. 

  117. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcerrorevent" class="tsd-kind-icon">Rtc<wbr>Error<wbr>Event</a></li>
    118. 

  118. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcerroreventtype" class="tsd-kind-icon">Rtc<wbr>Error<wbr>Event<wbr>Type</a></li>
    119. 

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

  120. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcnetworkqualityevent" class="tsd-kind-icon">Rtc<wbr>Network<wbr>Quality<wbr>Event</a></li>
    121. 

  121. 								<li class="tsd-kind-type-alias"><a href="index.html#rtcnetworkqualityeventtype" class="tsd-kind-icon">Rtc<wbr>Network<wbr>Quality<wbr>Event<wbr>Type</a></li>
    122. 

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

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

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

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

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

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

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

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

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

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

  132. 							</ul>
    133. 

  133. 						</section>
    134. 

  134. 						<section class="tsd-index-section ">
    135. 

  135. 							<h3>Variables</h3>
    136. 

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

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

  138. 							</ul>
    139. 

  139. 						</section>
    140. 

  140. 						<section class="tsd-index-section ">
    141. 

  141. 							<h3>Functions</h3>
    142. 

  142. 							<ul class="tsd-index-list">
    143. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  158. 							</ul>
    159. 

  159. 						</section>
    160. 

  160. 					</div>
    161. 

  161. 				</section>
    162. 

  162. 			</section>
    163. 

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

  164. 				<h2>Type aliases</h2>
    165. 

  165. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    166. 

  166. 					<a name="audiocodec" class="tsd-anchor"></a>
    167. 

  167. 					<h3>Audio<wbr>Codec</h3>
    168. 

  168. 					<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>
    169. 

  169. 					<aside class="tsd-sources">
    170. 

  170. 					</aside>
    171. 

  171. 					<div class="tsd-comment tsd-typography">
    172. 

  172. 						<div class="lead">
    173. 

  173. 							<p>音频编解码格式</p>
    174. 

  174. 						</div>
    175. 

  175. 					</div>
    176. 

  176. 				</section>
    177. 

  177. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    178. 

  178. 					<a name="connectionstate" class="tsd-anchor"></a>
    179. 

  179. 					<h3>Connection<wbr>State</h3>
    180. 

  180. 					<div class="tsd-signature tsd-kind-icon">Connection<wbr>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;OPEN&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;CONNECTING&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;CLOSING&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;RECONNECTING&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;CLOSED&quot;</span></div>
    181. 

  181. 					<aside class="tsd-sources">
    182. 

  182. 					</aside>
    183. 

  183. 					<div class="tsd-comment tsd-typography">
    184. 

  184. 						<div class="lead">
    185. 

  185. 							<p>连接状态类型：</p>
    186. 

  186. 							<ul>
    187. 

  187. 								<li>OPEN - 已连接</li>
    188. 

  188. 								<li>CONNECTING - 连接中</li>
    189. 

  189. 								<li>CLOSING - 断开中</li>
    190. 

  190. 								<li>RECONNECTING - 重连中</li>
    191. 

  191. 								<li>CLOSED - 已断开</li>
    192. 

  192. 							</ul>
    193. 

  193. 						</div>
    194. 

  194. 					</div>
    195. 

  195. 				</section>
    196. 

  196. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    197. 

  197. 					<a name="errorcode" class="tsd-anchor"></a>
    198. 

  198. 					<h3>Error<wbr>Code</h3>
    199. 

  199. 					<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>
    200. 

  200. 					<aside class="tsd-sources">
    201. 

  201. 					</aside>
    202. 

  202. 					<div class="tsd-comment tsd-typography">
    203. 

  203. 						<div class="lead">
    204. 

  204. 							<p>RTC 错误代码</p>
    205. 

  205. 						</div>
    206. 

  206. 						<p>通用错误及代码</p>
    207. 

  207. 						<ul>
    208. 

  208. 							<li>1000 - 非法参数</li>
    209. 

  209. 							<li>1001 - 非法操作</li>
    210. 

  210. 							<li>1002 - 不支持</li>
    211. 

  211. 							<li>1003 - 不存在</li>
    212. 

  212. 							<li>1004 - 请求失败</li>
    213. 

  213. 							<li>1999 - 其他错误</li>
    214. 

  214. 						</ul>
    215. 

  215. 						<p>房间相关错误及代码</p>
    216. 

  216. 						<ul>
    217. 

  217. 							<li>2000 - 网关不可达</li>
    218. 

  218. 							<li>2001 - 获取 Access Token 失败</li>
    219. 

  219. 							<li>2002 - Access Token 非法</li>
    220. 

  220. 							<li>2003 - Websocket 连接失败</li>
    221. 

  221. 							<li>2004 - 加入房间失败</li>
    222. 

  222. 							<li>2005 - 未加入房间</li>
    223. 

  223. 							<li>2006 - 正在加入房间</li>
    224. 

  224. 							<li>2007 - 正在离开房间</li>
    225. 

  225. 							<li>2008 - 角色类型不匹配</li>
    226. 

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

  227. 						</ul>
    228. 

  228. 						<p>流相关错误及代码</p>
    229. 

  229. 						<ul>
    230. 

  230. 							<li>3000 - 流不存在</li>
    231. 

  231. 							<li>3001 - 同类型的流已存在</li>
    232. 

  232. 							<li>3002 - 音频不存在</li>
    233. 

  233. 							<li>3003 - 视频不存在</li>
    234. 

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

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

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

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

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

  239. 							<li>3009 - 流连接失败</li>
    240. 

  240. 							<li>3010 - 流正在重连</li>
    241. 

  241. 							<li>3011 - 流尚未发布</li>
    242. 

  242. 							<li>3012 - 流正在发布</li>
    243. 

  243. 							<li>3013 - 流正在取消发布</li>
    244. 

  244. 							<li>3014 - 流已经发布</li>
    245. 

  245. 							<li>3015 - 流尚未订阅</li>
    246. 

  246. 							<li>3016 - 流正在订阅</li>
    247. 

  247. 							<li>3017 - 流正在取消订阅</li>
    248. 

  248. 							<li>3018 - 流已经订阅</li>
    249. 

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

  250. 							<li>3020 - 音视频数据异常，未成功播放（一般为网络原因导致，拉流时音视频数据加载过慢）</li>
    251. 

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

  252. 							<li>3024 - ICE 建连失败</li>
    253. 

  253. 						</ul>
    254. 

  254. 					</div>
    255. 

  255. 				</section>
    256. 

  256. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    257. 

  257. 					<a name="facingmode" class="tsd-anchor"></a>
    258. 

  258. 					<h3>Facing<wbr>Mode</h3>
    259. 

  259. 					<div class="tsd-signature tsd-kind-icon">Facing<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;user&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;environment&quot;</span></div>
    260. 

  260. 					<aside class="tsd-sources">
    261. 

  261. 					</aside>
    262. 

  262. 					<div class="tsd-comment tsd-typography">
    263. 

  263. 						<div class="lead">
    264. 

  264. 							<p>指定使用前置或后置摄像头，&#39;user&#39;（前置摄像头）或 &#39;environment&#39;（后置摄像头）</p>
    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="mediatype" class="tsd-anchor"></a>
    270. 

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

  271. 					<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>
    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>流的媒体类型, camera - 主视频流，screen - 辅助视频流，通常是一个屏幕分享流</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="networkquality" class="tsd-anchor"></a>
    282. 

  282. 					<h3>Network<wbr>Quality</h3>
    283. 

  283. 					<div class="tsd-signature tsd-kind-icon">Network<wbr>Quality<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;0&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;3&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;4&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;5&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;6&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>流的网络质量评分，有 &#39;0&#39; | &#39;1&#39; | &#39;2&#39; | &#39;3&#39; | &#39;4&#39; | &#39;5&#39; | &#39;6&#39;</p>
    289. 

  289. 							<ul>
    290. 

  290. 								<li>&#39;0&#39;: 网络质量未知</li>
    291. 

  291. 								<li>&#39;1&#39;: 网络质量优秀</li>
    292. 

  292. 								<li>&#39;2&#39;: 网络质量良好</li>
    293. 

  293. 								<li>&#39;3&#39;: 网络质量一般</li>
    294. 

  294. 								<li>&#39;4&#39;: 网络质量较差</li>
    295. 

  295. 								<li>&#39;5&#39;: 网络质量糟糕</li>
    296. 

  296. 								<li>&#39;6&#39;: 网络连接断开</li>
    297. 

  297. 							</ul>
    298. 

  298. 						</div>
    299. 

  299. 					</div>
    300. 

  300. 				</section>
    301. 

  301. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    302. 

  302. 					<a name="playcontrolstype" class="tsd-anchor"></a>
    303. 

  303. 					<h3>Play<wbr>Controls<wbr>Type</h3>
    304. 

  304. 					<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>
    305. 

  305. 					<aside class="tsd-sources">
    306. 

  306. 					</aside>
    307. 

  307. 					<div class="tsd-comment tsd-typography">
    308. 

  308. 						<div class="lead">
    309. 

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

  310. 							<ul>
    311. 

  311. 								<li>show 模式：一直显示</li>
    312. 

  312. 								<li>hide 模式：一直隐藏</li>
    313. 

  313. 								<li>auto 模式：自动判断</li>
    314. 

  314. 							</ul>
    315. 

  315. 						</div>
    316. 

  316. 					</div>
    317. 

  317. 				</section>
    318. 

  318. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    319. 

  319. 					<a name="playervideofittype" class="tsd-anchor"></a>
    320. 

  320. 					<h3>Player<wbr>Video<wbr>Fit<wbr>Type</h3>
    321. 

  321. 					<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>
    322. 

  322. 					<aside class="tsd-sources">
    323. 

  323. 					</aside>
    324. 

  324. 					<div class="tsd-comment tsd-typography">
    325. 

  325. 						<div class="lead">
    326. 

  326. 							<p>视频播放时的显示模式</p>
    327. 

  327. 							<ul>
    328. 

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

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

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

  331. 							</ul>
    332. 

  332. 						</div>
    333. 

  333. 					</div>
    334. 

  334. 				</section>
    335. 

  335. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    336. 

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

  337. 					<h3>Role<wbr>Type</h3>
    338. 

  338. 					<div class="tsd-signature tsd-kind-icon">Role<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;audience&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;speaker&quot;</span></div>
    339. 

  339. 					<aside class="tsd-sources">
    340. 

  340. 					</aside>
    341. 

  341. 					<div class="tsd-comment tsd-typography">
    342. 

  342. 						<div class="lead">
    343. 

  343. 							<p>用户角色，&#39;audience&#39; | &#39;speaker&#39; 分别为观众，主讲。</p>
    344. 

  344. 						</div>
    345. 

  345. 					</div>
    346. 

  346. 				</section>
    347. 

  347. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    348. 

  348. 					<a name="roomtype" class="tsd-anchor"></a>
    349. 

  349. 					<h3>Room<wbr>Type</h3>
    350. 

  350. 					<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>
    351. 

  351. 					<aside class="tsd-sources">
    352. 

  352. 					</aside>
    353. 

  353. 					<div class="tsd-comment tsd-typography">
    354. 

  354. 						<div class="lead">
    355. 

  355. 							<p>房间类型：&#39;conference&#39; | &#39;live&#39;，分别对应会议模式 | 直播模式。
    356. 

  356. 								注：
    357. 

  357. 								会议模式：房间内用户数较少，各用户均会推流，并拉其他用户的流。
    358. 

  358. 							直播模式：房间内用户数较多，个别用户会推流，大部分用户只拉流观看。</p>
    359. 

  359. 						</div>
    360. 

  360. 					</div>
    361. 

  361. 				</section>
    362. 

  362. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    363. 

  363. 					<a name="rtcconnectionstateevent" class="tsd-anchor"></a>
    364. 

  364. 					<h3>Rtc<wbr>Connection<wbr>State<wbr>Event</h3>
    365. 

  365. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Connection<wbr>State<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#rtcconnectionstateeventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcConnectionStateEventType</a><span class="tsd-signature-symbol">, </span><a href="interfaces/connectionstates.html" class="tsd-signature-type" data-tsd-kind="Interface">ConnectionStates</a><span class="tsd-signature-symbol">&gt;</span></div>
    366. 

  366. 					<aside class="tsd-sources">
    367. 

  367. 					</aside>
    368. 

  368. 					<div class="tsd-comment tsd-typography">
    369. 

  369. 						<div class="lead">
    370. 

  370. 							<p>Rtc 连接状态事件，事件类型参见 <a href="index.html#rtcconnectionstateeventtype">RtcConnectionStateEventType</a></p>
    371. 

  371. 						</div>
    372. 

  372. 					</div>
    373. 

  373. 				</section>
    374. 

  374. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    375. 

  375. 					<a name="rtcconnectionstateeventtype" class="tsd-anchor"></a>
    376. 

  376. 					<h3>Rtc<wbr>Connection<wbr>State<wbr>Event<wbr>Type</h3>
    377. 

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

  378. 					<aside class="tsd-sources">
    379. 

  379. 					</aside>
    380. 

  380. 					<div class="tsd-comment tsd-typography">
    381. 

  381. 						<div class="lead">
    382. 

  382. 							<p>Rtc 客户端连接状态事件类型：</p>
    383. 

  383. 						</div>
    384. 

  384. 						<p><a href="index.html#rtcconnectionstateevent">连接状态事件</a></p>
    385. 

  385. 						<ul>
    386. 

  386. 							<li>connection-state-changed - 连接状态改变</li>
    387. 

  387. 						</ul>
    388. 

  388. 						<dl class="tsd-comment-tags">
    389. 

  389. 							<dt>example</dt>
    390. 

  390. 							<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>
    391. 

  391. <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>
    392. 

  392. <span style="color: #000000">});</span>
    393. 

  393. </code></pre>
    394. 

  394. 							</dd>
    395. 

  395. 						</dl>
    396. 

  396. 					</div>
    397. 

  397. 				</section>
    398. 

  398. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    399. 

  399. 					<a name="rtcdevicechangedevent" class="tsd-anchor"></a>
    400. 

  400. 					<h3>Rtc<wbr>Device<wbr>Changed<wbr>Event</h3>
    401. 

  401. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Device<wbr>Changed<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#rtcdevicechangedeventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcDeviceChangedEventType</a><span class="tsd-signature-symbol">, </span><a href="interfaces/devicechangedeventdata.html" class="tsd-signature-type" data-tsd-kind="Interface">DeviceChangedEventData</a><span class="tsd-signature-symbol">&gt;</span></div>
    402. 

  402. 					<aside class="tsd-sources">
    403. 

  403. 					</aside>
    404. 

  404. 					<div class="tsd-comment tsd-typography">
    405. 

  405. 						<div class="lead">
    406. 

  406. 							<p>Rtc 设备列表变化事件，事件类型参见 {@link RtcDeviceChangeEventType}</p>
    407. 

  407. 						</div>
    408. 

  408. 					</div>
    409. 

  409. 				</section>
    410. 

  410. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    411. 

  411. 					<a name="rtcdevicechangedeventtype" class="tsd-anchor"></a>
    412. 

  412. 					<h3>Rtc<wbr>Device<wbr>Changed<wbr>Event<wbr>Type</h3>
    413. 

  413. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Device<wbr>Changed<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;device-changed&quot;</span></div>
    414. 

  414. 					<aside class="tsd-sources">
    415. 

  415. 					</aside>
    416. 

  416. 					<div class="tsd-comment tsd-typography">
    417. 

  417. 						<div class="lead">
    418. 

  418. 							<p>设备变化事件</p>
    419. 

  419. 							<ul>
    420. 

  420. 								<li>device-changed - 设备变化(新增或移除)</li>
    421. 

  421. 							</ul>
    422. 

  422. 						</div>
    423. 

  423. 						<dl class="tsd-comment-tags">
    424. 

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

  425. 							<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;device-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>
    426. 

  426. <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">type</span><span style="color: #0000FF">}</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">status</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    427. 

  427. <span style="color: #000000">});</span>
    428. 

  428. </code></pre>
    429. 

  429. 							</dd>
    430. 

  430. 						</dl>
    431. 

  431. 					</div>
    432. 

  432. 				</section>
    433. 

  433. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    434. 

  434. 					<a name="rtcerrorevent" class="tsd-anchor"></a>
    435. 

  435. 					<h3>Rtc<wbr>Error<wbr>Event</h3>
    436. 

  436. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Error<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#rtcerroreventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcErrorEventType</a><span class="tsd-signature-symbol">, </span><a href="classes/rtcerror.html" class="tsd-signature-type" data-tsd-kind="Class">RtcError</a><span class="tsd-signature-symbol">&gt;</span></div>
    437. 

  437. 					<aside class="tsd-sources">
    438. 

  438. 					</aside>
    439. 

  439. 					<div class="tsd-comment tsd-typography">
    440. 

  440. 						<div class="lead">
    441. 

  441. 							<p>Rtc 错误事件，事件类型参见 <a href="index.html#rtcerroreventtype">RtcErrorEventType</a></p>
    442. 

  442. 						</div>
    443. 

  443. 					</div>
    444. 

  444. 				</section>
    445. 

  445. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    446. 

  446. 					<a name="rtcerroreventtype" class="tsd-anchor"></a>
    447. 

  447. 					<h3>Rtc<wbr>Error<wbr>Event<wbr>Type</h3>
    448. 

  448. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Error<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;error&quot;</span></div>
    449. 

  449. 					<aside class="tsd-sources">
    450. 

  450. 					</aside>
    451. 

  451. 					<div class="tsd-comment tsd-typography">
    452. 

  452. 						<div class="lead">
    453. 

  453. 							<p>错误事件</p>
    454. 

  454. 							<ul>
    455. 

  455. 								<li>error - 错误事件，当出现不可恢复错误后，会抛出此事件</li>
    456. 

  456. 							</ul>
    457. 

  457. 						</div>
    458. 

  458. 						<dl class="tsd-comment-tags">
    459. 

  459. 							<dt>example</dt>
    460. 

  460. 							<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;error&#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>
    461. 

  461. <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">code</span><span style="color: #0000FF">}</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">message</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    462. 

  462. <span style="color: #000000">});</span>
    463. 

  463. </code></pre>
    464. 

  464. 							</dd>
    465. 

  465. 						</dl>
    466. 

  466. 					</div>
    467. 

  467. 				</section>
    468. 

  468. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    469. 

  469. 					<a name="rtceventtype" class="tsd-anchor"></a>
    470. 

  470. 					<h3>Rtc<wbr>Event<wbr>Type</h3>
    471. 

  471. 					<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#rtcconnectionstateeventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcConnectionStateEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcnetworkqualityeventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcNetworkQualityEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcplayereventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcPlayerEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcdevicechangedeventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcDeviceChangedEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcerroreventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcErrorEventType</a></div>
    472. 

  472. 					<aside class="tsd-sources">
    473. 

  473. 					</aside>
    474. 

  474. 					<div class="tsd-comment tsd-typography">
    475. 

  475. 						<div class="lead">
    476. 

  476. 							<p>Rtc 事件类型</p>
    477. 

  477. 						</div>
    478. 

  478. 					</div>
    479. 

  479. 				</section>
    480. 

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

  481. 					<a name="rtcnetworkqualityevent" class="tsd-anchor"></a>
    482. 

  482. 					<h3>Rtc<wbr>Network<wbr>Quality<wbr>Event</h3>
    483. 

  483. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Network<wbr>Quality<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#rtcnetworkqualityeventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcNetworkQualityEventType</a><span class="tsd-signature-symbol">, </span><a href="interfaces/networkqualities.html" class="tsd-signature-type" data-tsd-kind="Interface">NetworkQualities</a><span class="tsd-signature-symbol">&gt;</span></div>
    484. 

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

  485. 					</aside>
    486. 

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

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

  488. 							<p>Rtc 网络连接质量事件，事件类型参见 <a href="index.html#rtcnetworkqualityeventtype">RtcNetworkQualityEventType</a></p>
    489. 

  489. 						</div>
    490. 

  490. 					</div>
    491. 

  491. 				</section>
    492. 

  492. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    493. 

  493. 					<a name="rtcnetworkqualityeventtype" class="tsd-anchor"></a>
    494. 

  494. 					<h3>Rtc<wbr>Network<wbr>Quality<wbr>Event<wbr>Type</h3>
    495. 

  495. 					<div class="tsd-signature tsd-kind-icon">Rtc<wbr>Network<wbr>Quality<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;network-quality&quot;</span></div>
    496. 

  496. 					<aside class="tsd-sources">
    497. 

  497. 					</aside>
    498. 

  498. 					<div class="tsd-comment tsd-typography">
    499. 

  499. 						<div class="lead">
    500. 

  500. 							<p>Rtc 网络连接质量类型：</p>
    501. 

  501. 						</div>
    502. 

  502. 						<p><a href="index.html#rtcnetworkqualityevent">网络连接质量事件</a></p>
    503. 

  503. 						<ul>
    504. 

  504. 							<li>network-quality - 上/下行网络质量</li>
    505. 

  505. 						</ul>
    506. 

  506. 						<dl class="tsd-comment-tags">
    507. 

  507. 							<dt>example</dt>
    508. 

  508. 							<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;network-quality&#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>
    509. 

  509. <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">uplink</span><span style="color: #0000FF">}</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">downlink</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    510. 

  510. <span style="color: #000000">});</span>
    511. 

  511. </code></pre>
    512. 

  512. 							</dd>
    513. 

  513. 						</dl>
    514. 

  514. 					</div>
    515. 

  515. 				</section>
    516. 

  516. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    517. 

  517. 					<a name="rtcplayerevent" class="tsd-anchor"></a>
    518. 

  518. 					<h3>Rtc<wbr>Player<wbr>Event</h3>
    519. 

  519. 					<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><a href="interfaces/playereventdata.html" class="tsd-signature-type" data-tsd-kind="Interface">PlayerEventData</a><span class="tsd-signature-symbol">&gt;</span></div>
    520. 

  520. 					<aside class="tsd-sources">
    521. 

  521. 					</aside>
    522. 

  522. 					<div class="tsd-comment tsd-typography">
    523. 

  523. 						<div class="lead">
    524. 

  524. 							<p>Rtc 播放器事件，事件类型参见 <a href="index.html#rtcplayereventtype">RtcPlayerEventType</a></p>
    525. 

  525. 						</div>
    526. 

  526. 					</div>
    527. 

  527. 				</section>
    528. 

  528. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    529. 

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

  530. 					<h3>Rtc<wbr>Player<wbr>Event<wbr>Type</h3>
    531. 

  531. 					<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>
    532. 

  532. 					<aside class="tsd-sources">
    533. 

  533. 					</aside>
    534. 

  534. 					<div class="tsd-comment tsd-typography">
    535. 

  535. 						<div class="lead">
    536. 

  536. 							<p>Rtc 播放器事件类型：</p>
    537. 

  537. 						</div>
    538. 

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

  539. 						<ul>
    540. 

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

  541. 						</ul>
    542. 

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

  543. 						<dl class="tsd-comment-tags">
    544. 

  544. 							<dt>example</dt>
    545. 

  545. 							<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>
    546. 

  546. <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>
    547. 

  547. <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>
    548. 

  548. <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>
    549. 

  549. <span style="color: #000000">});</span>
    550. 

  550. </code></pre>
    551. 

  551. 							</dd>
    552. 

  552. 						</dl>
    553. 

  553. 					</div>
    554. 

  554. 				</section>
    555. 

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

  556. 					<a name="rtcstreamevent" class="tsd-anchor"></a>
    557. 

  557. 					<h3>Rtc<wbr>Stream<wbr>Event</h3>
    558. 

  558. 					<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>
    559. 

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

  560. 					</aside>
    561. 

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

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

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

  564. 						</div>
    565. 

  565. 					</div>
    566. 

  566. 				</section>
    567. 

  567. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    568. 

  568. 					<a name="rtcstreameventtype" class="tsd-anchor"></a>
    569. 

  569. 					<h3>Rtc<wbr>Stream<wbr>Event<wbr>Type</h3>
    570. 

  570. 					<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;stream-reconnecting&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;stream-reconnected&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;audio-track-ended&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;screen-sharing-stopped&quot;</span></div>
    571. 

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

  572. 					</aside>
    573. 

  573. 					<div class="tsd-comment tsd-typography">
    574. 

  574. 						<div class="lead">
    575. 

  575. 							<p>Rtc 流事件类型：</p>
    576. 

  576. 						</div>
    577. 

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

  578. 						<ul>
    579. 

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

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

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

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

  583. 							<li>stream-reconnecting - 流正在重连（本地流重新发布/远端流重新订阅），此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流或 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
    584. 

  584. 							<li>stream-reconnected - 流已重连（本地流已重新发布/远端流已重新订阅），此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流或 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
    585. 

  585. 							<li>mute-audio - 流的音频被 mute</li>
    586. 

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

  587. 							<li>mute-video - 流的视频被 mute</li>
    588. 

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

  589. 						</ul>
    590. 

  590. 						<dl class="tsd-comment-tags">
    591. 

  591. 							<dt>example</dt>
    592. 

  592. 							<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>
    593. 

  593. <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>
    594. 

  594. <span style="color: #000000">});</span>
    595. 

  595. </code></pre>
    596. 

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

  597. 								<ul>
    598. 

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

  599. 									<li>audio-track-ended - 音频被中止，此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流</li>
    600. 

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

  601. 								</ul>
    602. 

  602. 							</dd>
    603. 

  603. 							<dt>example</dt>
    604. 

  604. 							<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;screen-sharing-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>
    605. 

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

  606. <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>
    607. 

  607. <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>
    608. 

  608. <span style="color: #000000">});</span>
    609. 

  609. </code></pre>
    610. 

  610. 							</dd>
    611. 

  611. 							<dt>example</dt>
    612. 

  612. 							<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>
    613. 

  613. <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>
    614. 

  614. <span style="color: #000000">});</span>
    615. 

  615. </code></pre>
    616. 

  616. 							</dd>
    617. 

  617. 						</dl>
    618. 

  618. 					</div>
    619. 

  619. 				</section>
    620. 

  620. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    621. 

  621. 					<a name="rtcuserevent" class="tsd-anchor"></a>
    622. 

  622. 					<h3>Rtc<wbr>User<wbr>Event</h3>
    623. 

  623. 					<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>
    624. 

  624. 					<aside class="tsd-sources">
    625. 

  625. 					</aside>
    626. 

  626. 					<div class="tsd-comment tsd-typography">
    627. 

  627. 						<div class="lead">
    628. 

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

  629. 						</div>
    630. 

  630. 					</div>
    631. 

  631. 				</section>
    632. 

  632. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    633. 

  633. 					<a name="rtcusereventtype" class="tsd-anchor"></a>
    634. 

  634. 					<h3>Rtc<wbr>User<wbr>Event<wbr>Type</h3>
    635. 

  635. 					<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>
    636. 

  636. 					<aside class="tsd-sources">
    637. 

  637. 					</aside>
    638. 

  638. 					<div class="tsd-comment tsd-typography">
    639. 

  639. 						<div class="lead">
    640. 

  640. 							<p>Rtc 用户事件类型：</p>
    641. 

  641. 						</div>
    642. 

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

  643. 						<ul>
    644. 

  644. 							<li>user-joined - 有用户加入房间</li>
    645. 

  645. 							<li>user-left - 有用户离开房间</li>
    646. 

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

  647. 						</ul>
    648. 

  648. 						<dl class="tsd-comment-tags">
    649. 

  649. 							<dt>example</dt>
    650. 

  650. 							<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>
    651. 

  651. <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>
    652. 

  652. <span style="color: #000000">});</span>
    653. 

  653. </code></pre>
    654. 

  654. 							</dd>
    655. 

  655. 						</dl>
    656. 

  656. 					</div>
    657. 

  657. 				</section>
    658. 

  658. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    659. 

  659. 					<a name="screenprofile" class="tsd-anchor"></a>
    660. 

  660. 					<h3>Screen<wbr>Profile</h3>
    661. 

  661. 					<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>
    662. 

  662. 					<aside class="tsd-sources">
    663. 

  663. 					</aside>
    664. 

  664. 					<div class="tsd-comment tsd-typography">
    665. 

  665. 						<div class="lead">
    666. 

  666. 							<p>预设的屏幕共享视频 Profile</p>
    667. 

  667. 						</div>
    668. 

  668. 						<table>
    669. 

  669. 							<thead>
    670. 

  670. 								<tr>
    671. 

  671. 									<th align="center">名称</th>
    672. 

  672. 									<th align="center">视频宽</th>
    673. 

  673. 									<th align="center">视频高</th>
    674. 

  674. 									<th align="center">帧率 (fps)</th>
    675. 

  675. 									<th align="center">码率 (kbps)</th>
    676. 

  676. 								</tr>
    677. 

  677. 							</thead>
    678. 

  678. 							<tbody><tr>
    679. 

  679. 									<td align="center">480p</td>
    680. 

  680. 									<td align="center">640</td>
    681. 

  681. 									<td align="center">480</td>
    682. 

  682. 									<td align="center">5</td>
    683. 

  683. 									<td align="center">600</td>
    684. 

  684. 								</tr>
    685. 

  685. 								<tr>
    686. 

  686. 									<td align="center">480p_2</td>
    687. 

  687. 									<td align="center">640</td>
    688. 

  688. 									<td align="center">480</td>
    689. 

  689. 									<td align="center">30</td>
    690. 

  690. 									<td align="center">1000</td>
    691. 

  691. 								</tr>
    692. 

  692. 								<tr>
    693. 

  693. 									<td align="center">720p</td>
    694. 

  694. 									<td align="center">1280</td>
    695. 

  695. 									<td align="center">720</td>
    696. 

  696. 									<td align="center">5</td>
    697. 

  697. 									<td align="center">1000</td>
    698. 

  698. 								</tr>
    699. 

  699. 								<tr>
    700. 

  700. 									<td align="center">720p_2</td>
    701. 

  701. 									<td align="center">1280</td>
    702. 

  702. 									<td align="center">720</td>
    703. 

  703. 									<td align="center">30</td>
    704. 

  704. 									<td align="center">2000</td>
    705. 

  705. 								</tr>
    706. 

  706. 								<tr>
    707. 

  707. 									<td align="center">1080p</td>
    708. 

  708. 									<td align="center">1920</td>
    709. 

  709. 									<td align="center">1080</td>
    710. 

  710. 									<td align="center">5</td>
    711. 

  711. 									<td align="center">1500</td>
    712. 

  712. 								</tr>
    713. 

  713. 								<tr>
    714. 

  714. 									<td align="center">1080p_2</td>
    715. 

  715. 									<td align="center">1920</td>
    716. 

  716. 									<td align="center">1080</td>
    717. 

  717. 									<td align="center">30</td>
    718. 

  718. 									<td align="center">2500</td>
    719. 

  719. 								</tr>
    720. 

  720. 						</tbody></table>
    721. 

  721. 					</div>
    722. 

  722. 				</section>
    723. 

  723. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    724. 

  724. 					<a name="switchdevicetype" class="tsd-anchor"></a>
    725. 

  725. 					<h3>Switch<wbr>Device<wbr>Type</h3>
    726. 

  726. 					<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>
    727. 

  727. 					<aside class="tsd-sources">
    728. 

  728. 					</aside>
    729. 

  729. 					<div class="tsd-comment tsd-typography">
    730. 

  730. 						<div class="lead">
    731. 

  731. 							<p>切换设备的类型</p>
    732. 

  732. 						</div>
    733. 

  733. 					</div>
    734. 

  734. 				</section>
    735. 

  735. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    736. 

  736. 					<a name="videocodec" class="tsd-anchor"></a>
    737. 

  737. 					<h3>Video<wbr>Codec</h3>
    738. 

  738. 					<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>
    739. 

  739. 					<aside class="tsd-sources">
    740. 

  740. 					</aside>
    741. 

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

  742. 						<div class="lead">
    743. 

  743. 							<p>视频编解码格式</p>
    744. 

  744. 						</div>
    745. 

  745. 						<dl class="tsd-comment-tags">
    746. 

  746. 							<dt>note</dt>
    747. 

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

  748. 							</dd>
    749. 

  749. 						</dl>
    750. 

  750. 					</div>
    751. 

  751. 				</section>
    752. 

  752. 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
    753. 

  753. 					<a name="videoprofile" class="tsd-anchor"></a>
    754. 

  754. 					<h3>Video<wbr>Profile</h3>
    755. 

  755. 					<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>
    756. 

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

  757. 					</aside>
    758. 

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

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

  760. 							<p>预设的视频 Profile</p>
    761. 

  761. 						</div>
    762. 

  762. 						<table>
    763. 

  763. 							<thead>
    764. 

  764. 								<tr>
    765. 

  765. 									<th align="center">名称</th>
    766. 

  766. 									<th align="center">视频宽</th>
    767. 

  767. 									<th align="center">视频高</th>
    768. 

  768. 									<th align="center">帧率 (fps)</th>
    769. 

  769. 									<th align="center">码率 (kbps)</th>
    770. 

  770. 								</tr>
    771. 

  771. 							</thead>
    772. 

  772. 							<tbody><tr>
    773. 

  773. 									<td align="center">180p</td>
    774. 

  774. 									<td align="center">240</td>
    775. 

  775. 									<td align="center">180</td>
    776. 

  776. 									<td align="center">15</td>
    777. 

  777. 									<td align="center">200</td>
    778. 

  778. 								</tr>
    779. 

  779. 								<tr>
    780. 

  780. 									<td align="center">180p_2</td>
    781. 

  781. 									<td align="center">320</td>
    782. 

  782. 									<td align="center">180</td>
    783. 

  783. 									<td align="center">15</td>
    784. 

  784. 									<td align="center">300</td>
    785. 

  785. 								</tr>
    786. 

  786. 								<tr>
    787. 

  787. 									<td align="center">240p</td>
    788. 

  788. 									<td align="center">320</td>
    789. 

  789. 									<td align="center">240</td>
    790. 

  790. 									<td align="center">15</td>
    791. 

  791. 									<td align="center">400</td>
    792. 

  792. 								</tr>
    793. 

  793. 								<tr>
    794. 

  794. 									<td align="center">360p</td>
    795. 

  795. 									<td align="center">480</td>
    796. 

  796. 									<td align="center">360</td>
    797. 

  797. 									<td align="center">15</td>
    798. 

  798. 									<td align="center">400</td>
    799. 

  799. 								</tr>
    800. 

  800. 								<tr>
    801. 

  801. 									<td align="center">360p_2</td>
    802. 

  802. 									<td align="center">640</td>
    803. 

  803. 									<td align="center">360</td>
    804. 

  804. 									<td align="center">15</td>
    805. 

  805. 									<td align="center">500</td>
    806. 

  806. 								</tr>
    807. 

  807. 								<tr>
    808. 

  808. 									<td align="center">480p</td>
    809. 

  809. 									<td align="center">640</td>
    810. 

  810. 									<td align="center">480</td>
    811. 

  811. 									<td align="center">15</td>
    812. 

  812. 									<td align="center">600</td>
    813. 

  813. 								</tr>
    814. 

  814. 								<tr>
    815. 

  815. 									<td align="center">720p</td>
    816. 

  816. 									<td align="center">1280</td>
    817. 

  817. 									<td align="center">720</td>
    818. 

  818. 									<td align="center">15</td>
    819. 

  819. 									<td align="center">1000</td>
    820. 

  820. 								</tr>
    821. 

  821. 								<tr>
    822. 

  822. 									<td align="center">720p_2</td>
    823. 

  823. 									<td align="center">1280</td>
    824. 

  824. 									<td align="center">720</td>
    825. 

  825. 									<td align="center">15</td>
    826. 

  826. 									<td align="center">1500</td>
    827. 

  827. 								</tr>
    828. 

  828. 								<tr>
    829. 

  829. 									<td align="center">720p_3</td>
    830. 

  830. 									<td align="center">1280</td>
    831. 

  831. 									<td align="center">720</td>
    832. 

  832. 									<td align="center">30</td>
    833. 

  833. 									<td align="center">2000</td>
    834. 

  834. 								</tr>
    835. 

  835. 								<tr>
    836. 

  836. 									<td align="center">1080p</td>
    837. 

  837. 									<td align="center">1920</td>
    838. 

  838. 									<td align="center">1080</td>
    839. 

  839. 									<td align="center">15</td>
    840. 

  840. 									<td align="center">1500</td>
    841. 

  841. 								</tr>
    842. 

  842. 								<tr>
    843. 

  843. 									<td align="center">1080p_2</td>
    844. 

  844. 									<td align="center">1920</td>
    845. 

  845. 									<td align="center">1080</td>
    846. 

  846. 									<td align="center">15</td>
    847. 

  847. 									<td align="center">2000</td>
    848. 

  848. 								</tr>
    849. 

  849. 								<tr>
    850. 

  850. 									<td align="center">1080p_3</td>
    851. 

  851. 									<td align="center">1920</td>
    852. 

  852. 									<td align="center">1080</td>
    853. 

  853. 									<td align="center">30</td>
    854. 

  854. 									<td align="center">2500</td>
    855. 

  855. 								</tr>
    856. 

  856. 						</tbody></table>
    857. 

  857. 					</div>
    858. 

  858. 				</section>
    859. 

  859. 			</section>
    860. 

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

  861. 				<h2>Variables</h2>
    862. 

  862. 				<section class="tsd-panel tsd-member tsd-kind-variable">
    863. 

  863. 					<a name="version" class="tsd-anchor"></a>
    864. 

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

  865. 					<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>
    866. 

  866. 					<aside class="tsd-sources">
    867. 

  867. 					</aside>
    868. 

  868. 					<div class="tsd-comment tsd-typography">
    869. 

  869. 						<div class="lead">
    870. 

  870. 							<p>当前 sdk 的版本号</p>
    871. 

  871. 						</div>
    872. 

  872. 					</div>
    873. 

  873. 				</section>
    874. 

  874. 			</section>
    875. 

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

  876. 				<h2>Functions</h2>
    877. 

  877. 				<section class="tsd-panel tsd-member tsd-kind-function">
    878. 

  878. 					<a name="createclient" class="tsd-anchor"></a>
    879. 

  879. 					<h3>create<wbr>Client</h3>
    880. 

  880. 					<ul class="tsd-signatures tsd-kind-function">
    881. 

  881. 						<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>
    882. 

  882. 					</ul>
    883. 

  883. 					<ul class="tsd-descriptions">
    884. 

  884. 						<li class="tsd-description">
    885. 

  885. 							<aside class="tsd-sources">
    886. 

  886. 							</aside>
    887. 

  887. 							<div class="tsd-comment tsd-typography">
    888. 

  888. 								<div class="lead">
    889. 

  889. 									<p>创建客户端</p>
    890. 

  890. 								</div>
    891. 

  891. 								<dl class="tsd-comment-tags">
    892. 

  892. 									<dt>example</dt>
    893. 

  893. 									<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>
    894. 

  894. <span style="color: #001080">client</span>
    895. 

  895. <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>
    896. 

  896. <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>
    897. 

  897. <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>
    898. 

  898. <span style="color: #000000">  })</span>
    899. 

  899. <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>
    900. 

  900. <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>
    901. 

  901. <span style="color: #000000">  });</span>
    902. 

  902. </code></pre>
    903. 

  903. 									</dd>
    904. 

  904. 									<dt>throws</dt>
    905. 

  905. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    906. 

  906. 									</dd>
    907. 

  907. 								</dl>
    908. 

  908. 							</div>
    909. 

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

  910. 							<ul class="tsd-parameters">
    911. 

  911. 								<li>
    912. 

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

  913. 									<div class="tsd-comment tsd-typography">
    914. 

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

  915. 									</div>
    916. 

  916. 								</li>
    917. 

  917. 								<li>
    918. 

  918. 									<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>
    919. 

  919. 									<div class="tsd-comment tsd-typography">
    920. 

  920. 										<p>定义客户端的属性</p>
    921. 

  921. 									</div>
    922. 

  922. 								</li>
    923. 

  923. 							</ul>
    924. 

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

  925. 						</li>
    926. 

  926. 					</ul>
    927. 

  927. 				</section>
    928. 

  928. 				<section class="tsd-panel tsd-member tsd-kind-function">
    929. 

  929. 					<a name="createstream" class="tsd-anchor"></a>
    930. 

  930. 					<h3>create<wbr>Stream</h3>
    931. 

  931. 					<ul class="tsd-signatures tsd-kind-function">
    932. 

  932. 						<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>
    933. 

  933. 					</ul>
    934. 

  934. 					<ul class="tsd-descriptions">
    935. 

  935. 						<li class="tsd-description">
    936. 

  936. 							<aside class="tsd-sources">
    937. 

  937. 							</aside>
    938. 

  938. 							<div class="tsd-comment tsd-typography">
    939. 

  939. 								<div class="lead">
    940. 

  940. 									<p>创建本地流</p>
    941. 

  941. 								</div>
    942. 

  942. 								<dl class="tsd-comment-tags">
    943. 

  943. 									<dt>example</dt>
    944. 

  944. 									<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>
    945. 

  945. <span style="color: #001080">localStream</span>
    946. 

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

  947. <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>
    948. 

  948. <span style="color: #000000">    </span><span style="color: #001080">localStream</span>
    949. 

  949. <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>
    950. 

  950. <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>
    951. 

  951. <span style="color: #000000">  })</span>
    952. 

  952. <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>
    953. 

  953. <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>
    954. 

  954. <span style="color: #000000">  });</span>
    955. 

  955. </code></pre>
    956. 

  956. 									</dd>
    957. 

  957. 									<dt>throws</dt>
    958. 

  958. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    959. 

  959. 									</dd>
    960. 

  960. 								</dl>
    961. 

  961. 							</div>
    962. 

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

  963. 							<ul class="tsd-parameters">
    964. 

  964. 								<li>
    965. 

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

  966. 									<div class="tsd-comment tsd-typography">
    967. 

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

  968. 										注：</p>
    969. 

  969. 										<ol>
    970. 

  970. 											<li>video, screen 不可同时为 true</li>
    971. 

  971. 											<li>audio, video, screen 不可同时为 false</li>
    972. 

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

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

  974. 										</ol>
    975. 

  975. 									</div>
    976. 

  976. 								</li>
    977. 

  977. 							</ul>
    978. 

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

  979. 						</li>
    980. 

  980. 					</ul>
    981. 

  981. 				</section>
    982. 

  982. 				<section class="tsd-panel tsd-member tsd-kind-function">
    983. 

  983. 					<a name="devicedetection" class="tsd-anchor"></a>
    984. 

  984. 					<h3>device<wbr>Detection</h3>
    985. 

  985. 					<ul class="tsd-signatures tsd-kind-function">
    986. 

  986. 						<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>
    987. 

  987. 					</ul>
    988. 

  988. 					<ul class="tsd-descriptions">
    989. 

  989. 						<li class="tsd-description">
    990. 

  990. 							<aside class="tsd-sources">
    991. 

  991. 							</aside>
    992. 

  992. 							<div class="tsd-comment tsd-typography">
    993. 

  993. 								<div class="lead">
    994. 

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

  995. 								</div>
    996. 

  996. 								<dl class="tsd-comment-tags">
    997. 

  997. 									<dt>example</dt>
    998. 

  998. 									<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>
    999. 

  999. <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>
    1000. 

  1000. <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>
    1001. 

  1001. <span style="color: #000000">  })</span>
    1002. 

  1002. <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>
    1003. 

  1003. <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>
    1004. 

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

  1005. </code></pre>
    1006. 

  1006. 									</dd>
    1007. 

  1007. 									<dt>reject</dt>
    1008. 

  1008. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    1009. 

  1009. 									</dd>
    1010. 

  1010. 								</dl>
    1011. 

  1011. 							</div>
    1012. 

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

  1013. 							<ul class="tsd-parameters">
    1014. 

  1014. 								<li>
    1015. 

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

  1016. 									<div class="tsd-comment tsd-typography">
    1017. 

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

  1018. 									</div>
    1019. 

  1019. 								</li>
    1020. 

  1020. 							</ul>
    1021. 

  1021. 							<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>
    1022. 

  1022. 						</li>
    1023. 

  1023. 					</ul>
    1024. 

  1024. 				</section>
    1025. 

  1025. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1026. 

  1026. 					<a name="disableuploadlog" class="tsd-anchor"></a>
    1027. 

  1027. 					<h3>disable<wbr>Upload<wbr>Log</h3>
    1028. 

  1028. 					<ul class="tsd-signatures tsd-kind-function">
    1029. 

  1029. 						<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>
    1030. 

  1030. 					</ul>
    1031. 

  1031. 					<ul class="tsd-descriptions">
    1032. 

  1032. 						<li class="tsd-description">
    1033. 

  1033. 							<aside class="tsd-sources">
    1034. 

  1034. 							</aside>
    1035. 

  1035. 							<div class="tsd-comment tsd-typography">
    1036. 

  1036. 								<div class="lead">
    1037. 

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

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

  1039. 								</div>
    1040. 

  1040. 								<dl class="tsd-comment-tags">
    1041. 

  1041. 									<dt>example</dt>
    1042. 

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

  1043. </code></pre>
    1044. 

  1044. 									</dd>
    1045. 

  1045. 								</dl>
    1046. 

  1046. 							</div>
    1047. 

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

  1048. 						</li>
    1049. 

  1049. 					</ul>
    1050. 

  1050. 				</section>
    1051. 

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

  1052. 					<a name="enableuploadlog" class="tsd-anchor"></a>
    1053. 

  1053. 					<h3>enable<wbr>Upload<wbr>Log</h3>
    1054. 

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

  1055. 						<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>
    1056. 

  1056. 					</ul>
    1057. 

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

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

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

  1060. 							</aside>
    1061. 

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

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

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

  1064. 								</div>
    1065. 

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

  1066. 									<dt>example</dt>
    1067. 

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

  1068. </code></pre>
    1069. 

  1069. 									</dd>
    1070. 

  1070. 								</dl>
    1071. 

  1071. 							</div>
    1072. 

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

  1073. 						</li>
    1074. 

  1074. 					</ul>
    1075. 

  1075. 				</section>
    1076. 

  1076. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1077. 

  1077. 					<a name="generatetoken" class="tsd-anchor"></a>
    1078. 

  1078. 					<h3>generate<wbr>Token</h3>
    1079. 

  1079. 					<ul class="tsd-signatures tsd-kind-function">
    1080. 

  1080. 						<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>
    1081. 

  1081. 					</ul>
    1082. 

  1082. 					<ul class="tsd-descriptions">
    1083. 

  1083. 						<li class="tsd-description">
    1084. 

  1084. 							<aside class="tsd-sources">
    1085. 

  1085. 							</aside>
    1086. 

  1086. 							<div class="tsd-comment tsd-typography">
    1087. 

  1087. 								<div class="lead">
    1088. 

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

  1089. 								</div>
    1090. 

  1090. 								<dl class="tsd-comment-tags">
    1091. 

  1091. 									<dt>example</dt>
    1092. 

  1092. 									<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>
    1093. 

  1093. <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>
    1094. 

  1094. </code></pre>
    1095. 

  1095. 									</dd>
    1096. 

  1096. 								</dl>
    1097. 

  1097. 							</div>
    1098. 

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

  1099. 							<ul class="tsd-parameters">
    1100. 

  1100. 								<li>
    1101. 

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

  1102. 									<div class="tsd-comment tsd-typography">
    1103. 

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

  1104. 									</div>
    1105. 

  1105. 								</li>
    1106. 

  1106. 								<li>
    1107. 

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

  1108. 									<div class="tsd-comment tsd-typography">
    1109. 

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

  1110. 									</div>
    1111. 

  1111. 								</li>
    1112. 

  1112. 								<li>
    1113. 

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

  1114. 									<div class="tsd-comment tsd-typography">
    1115. 

  1115. 										<p>房间 ID</p>
    1116. 

  1116. 									</div>
    1117. 

  1117. 								</li>
    1118. 

  1118. 								<li>
    1119. 

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

  1120. 									<div class="tsd-comment tsd-typography">
    1121. 

  1121. 										<p>用户 ID</p>
    1122. 

  1122. 									</div>
    1123. 

  1123. 								</li>
    1124. 

  1124. 							</ul>
    1125. 

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

  1126. 						</li>
    1127. 

  1127. 					</ul>
    1128. 

  1128. 				</section>
    1129. 

  1129. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1130. 

  1130. 					<a name="getcameras" class="tsd-anchor"></a>
    1131. 

  1131. 					<h3>get<wbr>Cameras</h3>
    1132. 

  1132. 					<ul class="tsd-signatures tsd-kind-function">
    1133. 

  1133. 						<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>
    1134. 

  1134. 					</ul>
    1135. 

  1135. 					<ul class="tsd-descriptions">
    1136. 

  1136. 						<li class="tsd-description">
    1137. 

  1137. 							<aside class="tsd-sources">
    1138. 

  1138. 							</aside>
    1139. 

  1139. 							<div class="tsd-comment tsd-typography">
    1140. 

  1140. 								<div class="lead">
    1141. 

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

  1142. 								</div>
    1143. 

  1143. 								<dl class="tsd-comment-tags">
    1144. 

  1144. 									<dt>example</dt>
    1145. 

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

  1146. <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>
    1147. 

  1147. <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>
    1148. 

  1148. <span style="color: #000000"> })</span>
    1149. 

  1149. <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>
    1150. 

  1150. <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>
    1151. 

  1151. <span style="color: #000000"> });</span>
    1152. 

  1152. </code></pre>
    1153. 

  1153. 									</dd>
    1154. 

  1154. 									<dt>reject</dt>
    1155. 

  1155. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    1156. 

  1156. 									</dd>
    1157. 

  1157. 								</dl>
    1158. 

  1158. 							</div>
    1159. 

  1159. 							<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>
    1160. 

  1160. 						</li>
    1161. 

  1161. 					</ul>
    1162. 

  1162. 				</section>
    1163. 

  1163. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1164. 

  1164. 					<a name="getdevices" class="tsd-anchor"></a>
    1165. 

  1165. 					<h3>get<wbr>Devices</h3>
    1166. 

  1166. 					<ul class="tsd-signatures tsd-kind-function">
    1167. 

  1167. 						<li class="tsd-signature tsd-kind-icon">get<wbr>Devices<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">?: </span><a href="interfaces/getdevicesoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetDevicesOptions</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">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
    1168. 

  1168. 					</ul>
    1169. 

  1169. 					<ul class="tsd-descriptions">
    1170. 

  1170. 						<li class="tsd-description">
    1171. 

  1171. 							<aside class="tsd-sources">
    1172. 

  1172. 							</aside>
    1173. 

  1173. 							<div class="tsd-comment tsd-typography">
    1174. 

  1174. 								<div class="lead">
    1175. 

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

  1176. 								</div>
    1177. 

  1177. 								<dl class="tsd-comment-tags">
    1178. 

  1178. 									<dt>example</dt>
    1179. 

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

  1180. <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>
    1181. 

  1181. <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>
    1182. 

  1182. <span style="color: #000000"> })</span>
    1183. 

  1183. <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>
    1184. 

  1184. <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>
    1185. 

  1185. <span style="color: #000000"> });</span>
    1186. 

  1186. </code></pre>
    1187. 

  1187. 									</dd>
    1188. 

  1188. 									<dt>reject</dt>
    1189. 

  1189. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    1190. 

  1190. 									</dd>
    1191. 

  1191. 								</dl>
    1192. 

  1192. 							</div>
    1193. 

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

  1194. 							<ul class="tsd-parameters">
    1195. 

  1195. 								<li>
    1196. 

  1196. 									<h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="interfaces/getdevicesoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetDevicesOptions</a></h5>
    1197. 

  1197. 								</li>
    1198. 

  1198. 							</ul>
    1199. 

  1199. 							<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>
    1200. 

  1200. 						</li>
    1201. 

  1201. 					</ul>
    1202. 

  1202. 				</section>
    1203. 

  1203. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1204. 

  1204. 					<a name="getloudspeakers" class="tsd-anchor"></a>
    1205. 

  1205. 					<h3>get<wbr>Loudspeakers</h3>
    1206. 

  1206. 					<ul class="tsd-signatures tsd-kind-function">
    1207. 

  1207. 						<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>
    1208. 

  1208. 					</ul>
    1209. 

  1209. 					<ul class="tsd-descriptions">
    1210. 

  1210. 						<li class="tsd-description">
    1211. 

  1211. 							<aside class="tsd-sources">
    1212. 

  1212. 							</aside>
    1213. 

  1213. 							<div class="tsd-comment tsd-typography">
    1214. 

  1214. 								<div class="lead">
    1215. 

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

  1216. 								</div>
    1217. 

  1217. 								<dl class="tsd-comment-tags">
    1218. 

  1218. 									<dt>example</dt>
    1219. 

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

  1220. <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>
    1221. 

  1221. <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>
    1222. 

  1222. <span style="color: #000000"> })</span>
    1223. 

  1223. <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>
    1224. 

  1224. <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>
    1225. 

  1225. <span style="color: #000000"> });</span>
    1226. 

  1226. </code></pre>
    1227. 

  1227. 									</dd>
    1228. 

  1228. 									<dt>reject</dt>
    1229. 

  1229. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    1230. 

  1230. 									</dd>
    1231. 

  1231. 								</dl>
    1232. 

  1232. 							</div>
    1233. 

  1233. 							<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>
    1234. 

  1234. 						</li>
    1235. 

  1235. 					</ul>
    1236. 

  1236. 				</section>
    1237. 

  1237. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1238. 

  1238. 					<a name="getmicrophones" class="tsd-anchor"></a>
    1239. 

  1239. 					<h3>get<wbr>Microphones</h3>
    1240. 

  1240. 					<ul class="tsd-signatures tsd-kind-function">
    1241. 

  1241. 						<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>
    1242. 

  1242. 					</ul>
    1243. 

  1243. 					<ul class="tsd-descriptions">
    1244. 

  1244. 						<li class="tsd-description">
    1245. 

  1245. 							<aside class="tsd-sources">
    1246. 

  1246. 							</aside>
    1247. 

  1247. 							<div class="tsd-comment tsd-typography">
    1248. 

  1248. 								<div class="lead">
    1249. 

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

  1250. 								</div>
    1251. 

  1251. 								<dl class="tsd-comment-tags">
    1252. 

  1252. 									<dt>example</dt>
    1253. 

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

  1254. <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>
    1255. 

  1255. <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>
    1256. 

  1256. <span style="color: #000000"> })</span>
    1257. 

  1257. <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>
    1258. 

  1258. <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>
    1259. 

  1259. <span style="color: #000000"> });</span>
    1260. 

  1260. </code></pre>
    1261. 

  1261. 									</dd>
    1262. 

  1262. 									<dt>reject</dt>
    1263. 

  1263. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    1264. 

  1264. 									</dd>
    1265. 

  1265. 								</dl>
    1266. 

  1266. 							</div>
    1267. 

  1267. 							<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>
    1268. 

  1268. 						</li>
    1269. 

  1269. 					</ul>
    1270. 

  1270. 				</section>
    1271. 

  1271. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1272. 

  1272. 					<a name="getsupportedcodec" class="tsd-anchor"></a>
    1273. 

  1273. 					<h3>get<wbr>Supported<wbr>Codec</h3>
    1274. 

  1274. 					<ul class="tsd-signatures tsd-kind-function">
    1275. 

  1275. 						<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>
    1276. 

  1276. 					</ul>
    1277. 

  1277. 					<ul class="tsd-descriptions">
    1278. 

  1278. 						<li class="tsd-description">
    1279. 

  1279. 							<aside class="tsd-sources">
    1280. 

  1280. 							</aside>
    1281. 

  1281. 							<div class="tsd-comment tsd-typography">
    1282. 

  1282. 								<div class="lead">
    1283. 

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

  1284. 								</div>
    1285. 

  1285. 								<dl class="tsd-comment-tags">
    1286. 

  1286. 									<dt>example</dt>
    1287. 

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

  1288. <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>
    1289. 

  1289. <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>
    1290. 

  1290. <span style="color: #000000"> })</span>
    1291. 

  1291. <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>
    1292. 

  1292. <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>
    1293. 

  1293. <span style="color: #000000"> });</span>
    1294. 

  1294. </code></pre>
    1295. 

  1295. 									</dd>
    1296. 

  1296. 								</dl>
    1297. 

  1297. 							</div>
    1298. 

  1298. 							<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>
    1299. 

  1299. 						</li>
    1300. 

  1300. 					</ul>
    1301. 

  1301. 				</section>
    1302. 

  1302. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1303. 

  1303. 					<a name="issupportscreenshare" class="tsd-anchor"></a>
    1304. 

  1304. 					<h3>is<wbr>Support<wbr>Screen<wbr>Share</h3>
    1305. 

  1305. 					<ul class="tsd-signatures tsd-kind-function">
    1306. 

  1306. 						<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>
    1307. 

  1307. 					</ul>
    1308. 

  1308. 					<ul class="tsd-descriptions">
    1309. 

  1309. 						<li class="tsd-description">
    1310. 

  1310. 							<aside class="tsd-sources">
    1311. 

  1311. 							</aside>
    1312. 

  1312. 							<div class="tsd-comment tsd-typography">
    1313. 

  1313. 								<div class="lead">
    1314. 

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

  1315. 								</div>
    1316. 

  1316. 								<dl class="tsd-comment-tags">
    1317. 

  1317. 									<dt>example</dt>
    1318. 

  1318. 									<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>
    1319. 

  1319. <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>
    1320. 

  1320. <span style="color: #000000">}</span>
    1321. 

  1321. </code></pre>
    1322. 

  1322. 									</dd>
    1323. 

  1323. 								</dl>
    1324. 

  1324. 							</div>
    1325. 

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

  1326. 						</li>
    1327. 

  1327. 					</ul>
    1328. 

  1328. 				</section>
    1329. 

  1329. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1330. 

  1330. 					<a name="issupportwebrtc" class="tsd-anchor"></a>
    1331. 

  1331. 					<h3>is<wbr>Support<wbr>WebRTC</h3>
    1332. 

  1332. 					<ul class="tsd-signatures tsd-kind-function">
    1333. 

  1333. 						<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>
    1334. 

  1334. 					</ul>
    1335. 

  1335. 					<ul class="tsd-descriptions">
    1336. 

  1336. 						<li class="tsd-description">
    1337. 

  1337. 							<aside class="tsd-sources">
    1338. 

  1338. 							</aside>
    1339. 

  1339. 							<div class="tsd-comment tsd-typography">
    1340. 

  1340. 								<div class="lead">
    1341. 

  1341. 									<p>检测浏览器是否完全（可访问本地音视频设备）支持 WebRTC。</p>
    1342. 

  1342. 								</div>
    1343. 

  1343. 								<dl class="tsd-comment-tags">
    1344. 

  1344. 									<dt>example</dt>
    1345. 

  1345. 									<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>
    1346. 

  1346. <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>
    1347. 

  1347. <span style="color: #000000">}</span>
    1348. 

  1348. </code></pre>
    1349. 

  1349. 									</dd>
    1350. 

  1350. 								</dl>
    1351. 

  1351. 							</div>
    1352. 

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

  1353. 						</li>
    1354. 

  1354. 					</ul>
    1355. 

  1355. 				</section>
    1356. 

  1356. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1357. 

  1357. 					<a name="setloglevel" class="tsd-anchor"></a>
    1358. 

  1358. 					<h3>set<wbr>Log<wbr>Level</h3>
    1359. 

  1359. 					<ul class="tsd-signatures tsd-kind-function">
    1360. 

  1360. 						<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>
    1361. 

  1361. 					</ul>
    1362. 

  1362. 					<ul class="tsd-descriptions">
    1363. 

  1363. 						<li class="tsd-description">
    1364. 

  1364. 							<aside class="tsd-sources">
    1365. 

  1365. 							</aside>
    1366. 

  1366. 							<div class="tsd-comment tsd-typography">
    1367. 

  1367. 								<div class="lead">
    1368. 

  1368. 									<p>设置日志打印级别，用于打印出更多日志来调试或定位问题，默认 warn 级别</p>
    1369. 

  1369. 								</div>
    1370. 

  1370. 								<dl class="tsd-comment-tags">
    1371. 

  1371. 									<dt>example</dt>
    1372. 

  1372. 									<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>
    1373. 

  1373. </code></pre>
    1374. 

  1374. 									</dd>
    1375. 

  1375. 								</dl>
    1376. 

  1376. 							</div>
    1377. 

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

  1378. 							<ul class="tsd-parameters">
    1379. 

  1379. 								<li>
    1380. 

  1380. 									<h5>level: <span class="tsd-signature-type">LogLevel</span></h5>
    1381. 

  1381. 									<div class="tsd-comment tsd-typography">
    1382. 

  1382. 										<p>日志级别，有 &#39;debug&#39;, &#39;info&#39;, &#39;warn&#39;, &#39;error&#39; 级别;</p>
    1383. 

  1383. 									</div>
    1384. 

  1384. 								</li>
    1385. 

  1385. 							</ul>
    1386. 

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

  1387. 						</li>
    1388. 

  1388. 					</ul>
    1389. 

  1389. 				</section>
    1390. 

  1390. 				<section class="tsd-panel tsd-member tsd-kind-function">
    1391. 

  1391. 					<a name="setservers" class="tsd-anchor"></a>
    1392. 

  1392. 					<h3>set<wbr>Servers</h3>
    1393. 

  1393. 					<ul class="tsd-signatures tsd-kind-function">
    1394. 

  1394. 						<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>
    1395. 

  1395. 					</ul>
    1396. 

  1396. 					<ul class="tsd-descriptions">
    1397. 

  1397. 						<li class="tsd-description">
    1398. 

  1398. 							<aside class="tsd-sources">
    1399. 

  1399. 							</aside>
    1400. 

  1400. 							<div class="tsd-comment tsd-typography">
    1401. 

  1401. 								<div class="lead">
    1402. 

  1402. 									<p>用于私有化部署时，指定部署的服务器地址</p>
    1403. 

  1403. 								</div>
    1404. 

  1404. 								<dl class="tsd-comment-tags">
    1405. 

  1405. 									<dt>example</dt>
    1406. 

  1406. 									<dd><pre><code class="language-js"><span style="color: #795E26">setServers</span><span style="color: #000000">({</span>
    1407. 

  1407. <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>
    1408. 

  1408. <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>
    1409. 

  1409. <span style="color: #000000">});</span>
    1410. 

  1410. </code></pre>
    1411. 

  1411. 										<p><strong>特别地，单信令服务器时，不需要网关进行分配信令服务器，可以直接指定信令服务器</strong></p>
    1412. 

  1412. 										<pre><code class="language-js"><span style="color: #795E26">setServers</span><span style="color: #000000">({</span>
    1413. 

  1413. <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>
    1414. 

  1414. <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>
    1415. 

  1415. <span style="color: #000000">});</span>
    1416. 

  1416. </code></pre>
    1417. 

  1417. 									</dd>
    1418. 

  1418. 									<dt>throws</dt>
    1419. 

  1419. 									<dd><p><a href="classes/rtcerror.html">RtcError</a></p>
    1420. 

  1420. 									</dd>
    1421. 

  1421. 								</dl>
    1422. 

  1422. 							</div>
    1423. 

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

  1424. 							<ul class="tsd-parameters">
    1425. 

  1425. 								<li>
    1426. 

  1426. 									<h5>conf: <a href="interfaces/serverconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerConfig</a></h5>
    1427. 

  1427. 									<div class="tsd-comment tsd-typography">
    1428. 

  1428. 										<p>服务器配置，具体描述参见 ServerConfig 的说明</p>
    1429. 

  1429. 									</div>
    1430. 

  1430. 								</li>
    1431. 

  1431. 							</ul>
    1432. 

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

  1433. 						</li>
    1434. 

  1434. 					</ul>
    1435. 

  1435. 				</section>
    1436. 

  1436. 			</section>
    1437. 

  1437. 		</div>
    1438. 

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

  1439. 			<nav class="tsd-navigation primary">
    1440. 

  1440. 				<ul>
    1441. 

  1441. 					<li class="current ">
    1442. 

  1442. 						<a href="index.html">Exports</a>
    1443. 

  1443. 					</li>
    1444. 

  1444. 				</ul>
    1445. 

  1445. 			</nav>
    1446. 

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

  1447. 				<ul class="before-current">
    1448. 

  1448. 					<li class=" tsd-kind-class">
    1449. 

  1449. 						<a href="classes/client.html" class="tsd-kind-icon">Client</a>
    1450. 

  1450. 					</li>
    1451. 

  1451. 					<li class=" tsd-kind-class">
    1452. 

  1452. 						<a href="classes/localstream.html" class="tsd-kind-icon">Local<wbr>Stream</a>
    1453. 

  1453. 					</li>
    1454. 

  1454. 					<li class=" tsd-kind-class">
    1455. 

  1455. 						<a href="classes/remotestream.html" class="tsd-kind-icon">Remote<wbr>Stream</a>
    1456. 

  1456. 					</li>
    1457. 

  1457. 					<li class=" tsd-kind-class">
    1458. 

  1458. 						<a href="classes/rtcerror.html" class="tsd-kind-icon">Rtc<wbr>Error</a>
    1459. 

  1459. 					</li>
    1460. 

  1460. 					<li class=" tsd-kind-class">
    1461. 

  1461. 						<a href="classes/stream.html" class="tsd-kind-icon">Stream</a>
    1462. 

  1462. 					</li>
    1463. 

  1463. 					<li class=" tsd-kind-class">
    1464. 

  1464. 						<a href="classes/user.html" class="tsd-kind-icon">User</a>
    1465. 

  1465. 					</li>
    1466. 

  1466. 					<li class=" tsd-kind-interface">
    1467. 

  1467. 						<a href="interfaces/audiostats.html" class="tsd-kind-icon">Audio<wbr>Stats</a>
    1468. 

  1468. 					</li>
    1469. 

  1469. 					<li class=" tsd-kind-interface">
    1470. 

  1470. 						<a href="interfaces/clientoptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
    1471. 

  1471. 					</li>
    1472. 

  1472. 					<li class=" tsd-kind-interface">
    1473. 

  1473. 						<a href="interfaces/clientplugin.html" class="tsd-kind-icon">Client<wbr>Plugin</a>
    1474. 

  1474. 					</li>
    1475. 

  1475. 					<li class=" tsd-kind-interface">
    1476. 

  1476. 						<a href="interfaces/codecs.html" class="tsd-kind-icon">Codecs</a>
    1477. 

  1477. 					</li>
    1478. 

  1478. 					<li class=" tsd-kind-interface">
    1479. 

  1479. 						<a href="interfaces/connectionstates.html" class="tsd-kind-icon">Connection<wbr>States</a>
    1480. 

  1480. 					</li>
    1481. 

  1481. 					<li class=" tsd-kind-interface">
    1482. 

  1482. 						<a href="interfaces/devicechangedeventdata.html" class="tsd-kind-icon">Device<wbr>Changed<wbr>Event<wbr>Data</a>
    1483. 

  1483. 					</li>
    1484. 

  1484. 					<li class=" tsd-kind-interface">
    1485. 

  1485. 						<a href="interfaces/devicedetectionoptions.html" class="tsd-kind-icon">Device<wbr>Detection<wbr>Options</a>
    1486. 

  1486. 					</li>
    1487. 

  1487. 					<li class=" tsd-kind-interface">
    1488. 

  1488. 						<a href="interfaces/getdevicesoptions.html" class="tsd-kind-icon">Get<wbr>Devices<wbr>Options</a>
    1489. 

  1489. 					</li>
    1490. 

  1490. 					<li class=" tsd-kind-interface">
    1491. 

  1491. 						<a href="interfaces/joinoptions.html" class="tsd-kind-icon">Join<wbr>Options</a>
    1492. 

  1492. 					</li>
    1493. 

  1493. 					<li class=" tsd-kind-interface">
    1494. 

  1494. 						<a href="interfaces/localstreamoptions.html" class="tsd-kind-icon">Local<wbr>Stream<wbr>Options</a>
    1495. 

  1495. 					</li>
    1496. 

  1496. 					<li class=" tsd-kind-interface">
    1497. 

  1497. 						<a href="interfaces/networkqualities.html" class="tsd-kind-icon">Network<wbr>Qualities</a>
    1498. 

  1498. 					</li>
    1499. 

  1499. 					<li class=" tsd-kind-interface">
    1500. 

  1500. 						<a href="interfaces/networkstats.html" class="tsd-kind-icon">Network<wbr>Stats</a>
    1501. 

  1501. 					</li>
    1502. 

  1502. 					<li class=" tsd-kind-interface">
    1503. 

  1503. 						<a href="interfaces/playoptions.html" class="tsd-kind-icon">Play<wbr>Options</a>
    1504. 

  1504. 					</li>
    1505. 

  1505. 					<li class=" tsd-kind-interface">
    1506. 

  1506. 						<a href="interfaces/playereventdata.html" class="tsd-kind-icon">Player<wbr>Event<wbr>Data</a>
    1507. 

  1507. 					</li>
    1508. 

  1508. 					<li class=" tsd-kind-interface tsd-has-type-parameter">
    1509. 

  1509. 						<a href="interfaces/rtcevent.html" class="tsd-kind-icon">Rtc<wbr>Event</a>
    1510. 

  1510. 					</li>
    1511. 

  1511. 					<li class=" tsd-kind-interface">
    1512. 

  1512. 						<a href="interfaces/serverconfig.html" class="tsd-kind-icon">Server<wbr>Config</a>
    1513. 

  1513. 					</li>
    1514. 

  1514. 					<li class=" tsd-kind-interface">
    1515. 

  1515. 						<a href="interfaces/snapshotoptions.html" class="tsd-kind-icon">Snapshot<wbr>Options</a>
    1516. 

  1516. 					</li>
    1517. 

  1517. 					<li class=" tsd-kind-interface">
    1518. 

  1518. 						<a href="interfaces/streamplugin.html" class="tsd-kind-icon">Stream<wbr>Plugin</a>
    1519. 

  1519. 					</li>
    1520. 

  1520. 					<li class=" tsd-kind-interface">
    1521. 

  1521. 						<a href="interfaces/streamstats.html" class="tsd-kind-icon">Stream<wbr>Stats</a>
    1522. 

  1522. 					</li>
    1523. 

  1523. 					<li class=" tsd-kind-interface">
    1524. 

  1524. 						<a href="interfaces/videostats.html" class="tsd-kind-icon">Video<wbr>Stats</a>
    1525. 

  1525. 					</li>
    1526. 

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

  1527. 						<a href="index.html#audiocodec" class="tsd-kind-icon">Audio<wbr>Codec</a>
    1528. 

  1528. 					</li>
    1529. 

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

  1530. 						<a href="index.html#connectionstate" class="tsd-kind-icon">Connection<wbr>State</a>
    1531. 

  1531. 					</li>
    1532. 

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

  1533. 						<a href="index.html#errorcode" class="tsd-kind-icon">Error<wbr>Code</a>
    1534. 

  1534. 					</li>
    1535. 

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

  1536. 						<a href="index.html#facingmode" class="tsd-kind-icon">Facing<wbr>Mode</a>
    1537. 

  1537. 					</li>
    1538. 

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

  1539. 						<a href="index.html#mediatype" class="tsd-kind-icon">Media<wbr>Type</a>
    1540. 

  1540. 					</li>
    1541. 

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

  1542. 						<a href="index.html#networkquality" class="tsd-kind-icon">Network<wbr>Quality</a>
    1543. 

  1543. 					</li>
    1544. 

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

  1545. 						<a href="index.html#playcontrolstype" class="tsd-kind-icon">Play<wbr>Controls<wbr>Type</a>
    1546. 

  1546. 					</li>
    1547. 

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

  1548. 						<a href="index.html#playervideofittype" class="tsd-kind-icon">Player<wbr>Video<wbr>Fit<wbr>Type</a>
    1549. 

  1549. 					</li>
    1550. 

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

  1551. 						<a href="index.html#roletype" class="tsd-kind-icon">Role<wbr>Type</a>
    1552. 

  1552. 					</li>
    1553. 

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

  1554. 						<a href="index.html#roomtype" class="tsd-kind-icon">Room<wbr>Type</a>
    1555. 

  1555. 					</li>
    1556. 

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

  1557. 						<a href="index.html#rtcconnectionstateevent" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>State<wbr>Event</a>
    1558. 

  1558. 					</li>
    1559. 

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

  1560. 						<a href="index.html#rtcconnectionstateeventtype" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>State<wbr>Event<wbr>Type</a>
    1561. 

  1561. 					</li>
    1562. 

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

  1563. 						<a href="index.html#rtcdevicechangedevent" class="tsd-kind-icon">Rtc<wbr>Device<wbr>Changed<wbr>Event</a>
    1564. 

  1564. 					</li>
    1565. 

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

  1566. 						<a href="index.html#rtcdevicechangedeventtype" class="tsd-kind-icon">Rtc<wbr>Device<wbr>Changed<wbr>Event<wbr>Type</a>
    1567. 

  1567. 					</li>
    1568. 

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

  1569. 						<a href="index.html#rtcerrorevent" class="tsd-kind-icon">Rtc<wbr>Error<wbr>Event</a>
    1570. 

  1570. 					</li>
    1571. 

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

  1572. 						<a href="index.html#rtcerroreventtype" class="tsd-kind-icon">Rtc<wbr>Error<wbr>Event<wbr>Type</a>
    1573. 

  1573. 					</li>
    1574. 

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

  1575. 						<a href="index.html#rtceventtype" class="tsd-kind-icon">Rtc<wbr>Event<wbr>Type</a>
    1576. 

  1576. 					</li>
    1577. 

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

  1578. 						<a href="index.html#rtcnetworkqualityevent" class="tsd-kind-icon">Rtc<wbr>Network<wbr>Quality<wbr>Event</a>
    1579. 

  1579. 					</li>
    1580. 

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

  1581. 						<a href="index.html#rtcnetworkqualityeventtype" class="tsd-kind-icon">Rtc<wbr>Network<wbr>Quality<wbr>Event<wbr>Type</a>
    1582. 

  1582. 					</li>
    1583. 

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

  1584. 						<a href="index.html#rtcplayerevent" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event</a>
    1585. 

  1585. 					</li>
    1586. 

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

  1587. 						<a href="index.html#rtcplayereventtype" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event<wbr>Type</a>
    1588. 

  1588. 					</li>
    1589. 

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

  1590. 						<a href="index.html#rtcstreamevent" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event</a>
    1591. 

  1591. 					</li>
    1592. 

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

  1593. 						<a href="index.html#rtcstreameventtype" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event<wbr>Type</a>
    1594. 

  1594. 					</li>
    1595. 

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

  1596. 						<a href="index.html#rtcuserevent" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event</a>
    1597. 

  1597. 					</li>
    1598. 

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

  1599. 						<a href="index.html#rtcusereventtype" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event<wbr>Type</a>
    1600. 

  1600. 					</li>
    1601. 

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

  1602. 						<a href="index.html#screenprofile" class="tsd-kind-icon">Screen<wbr>Profile</a>
    1603. 

  1603. 					</li>
    1604. 

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

  1605. 						<a href="index.html#switchdevicetype" class="tsd-kind-icon">Switch<wbr>Device<wbr>Type</a>
    1606. 

  1606. 					</li>
    1607. 

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

  1608. 						<a href="index.html#videocodec" class="tsd-kind-icon">Video<wbr>Codec</a>
    1609. 

  1609. 					</li>
    1610. 

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

  1611. 						<a href="index.html#videoprofile" class="tsd-kind-icon">Video<wbr>Profile</a>
    1612. 

  1612. 					</li>
    1613. 

  1613. 					<li class=" tsd-kind-variable">
    1614. 

  1614. 						<a href="index.html#version" class="tsd-kind-icon">version</a>
    1615. 

  1615. 					</li>
    1616. 

  1616. 					<li class=" tsd-kind-function">
    1617. 

  1617. 						<a href="index.html#createclient" class="tsd-kind-icon">create<wbr>Client</a>
    1618. 

  1618. 					</li>
    1619. 

  1619. 					<li class=" tsd-kind-function">
    1620. 

  1620. 						<a href="index.html#createstream" class="tsd-kind-icon">create<wbr>Stream</a>
    1621. 

  1621. 					</li>
    1622. 

  1622. 					<li class=" tsd-kind-function">
    1623. 

  1623. 						<a href="index.html#devicedetection" class="tsd-kind-icon">device<wbr>Detection</a>
    1624. 

  1624. 					</li>
    1625. 

  1625. 					<li class=" tsd-kind-function">
    1626. 

  1626. 						<a href="index.html#disableuploadlog" class="tsd-kind-icon">disable<wbr>Upload<wbr>Log</a>
    1627. 

  1627. 					</li>
    1628. 

  1628. 					<li class=" tsd-kind-function">
    1629. 

  1629. 						<a href="index.html#enableuploadlog" class="tsd-kind-icon">enable<wbr>Upload<wbr>Log</a>
    1630. 

  1630. 					</li>
    1631. 

  1631. 					<li class=" tsd-kind-function">
    1632. 

  1632. 						<a href="index.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a>
    1633. 

  1633. 					</li>
    1634. 

  1634. 					<li class=" tsd-kind-function">
    1635. 

  1635. 						<a href="index.html#getcameras" class="tsd-kind-icon">get<wbr>Cameras</a>
    1636. 

  1636. 					</li>
    1637. 

  1637. 					<li class=" tsd-kind-function">
    1638. 

  1638. 						<a href="index.html#getdevices" class="tsd-kind-icon">get<wbr>Devices</a>
    1639. 

  1639. 					</li>
    1640. 

  1640. 					<li class=" tsd-kind-function">
    1641. 

  1641. 						<a href="index.html#getloudspeakers" class="tsd-kind-icon">get<wbr>Loudspeakers</a>
    1642. 

  1642. 					</li>
    1643. 

  1643. 					<li class=" tsd-kind-function">
    1644. 

  1644. 						<a href="index.html#getmicrophones" class="tsd-kind-icon">get<wbr>Microphones</a>
    1645. 

  1645. 					</li>
    1646. 

  1646. 					<li class=" tsd-kind-function">
    1647. 

  1647. 						<a href="index.html#getsupportedcodec" class="tsd-kind-icon">get<wbr>Supported<wbr>Codec</a>
    1648. 

  1648. 					</li>
    1649. 

  1649. 					<li class=" tsd-kind-function">
    1650. 

  1650. 						<a href="index.html#issupportscreenshare" class="tsd-kind-icon">is<wbr>Support<wbr>Screen<wbr>Share</a>
    1651. 

  1651. 					</li>
    1652. 

  1652. 					<li class=" tsd-kind-function">
    1653. 

  1653. 						<a href="index.html#issupportwebrtc" class="tsd-kind-icon">is<wbr>Support<wbr>WebRTC</a>
    1654. 

  1654. 					</li>
    1655. 

  1655. 					<li class=" tsd-kind-function">
    1656. 

  1656. 						<a href="index.html#setloglevel" class="tsd-kind-icon">set<wbr>Log<wbr>Level</a>
    1657. 

  1657. 					</li>
    1658. 

  1658. 					<li class=" tsd-kind-function">
    1659. 

  1659. 						<a href="index.html#setservers" class="tsd-kind-icon">set<wbr>Servers</a>
    1660. 

  1660. 					</li>
    1661. 

  1661. 				</ul>
    1662. 

  1662. 			</nav>
    1663. 

  1663. 		</div>
    1664. 

  1664. 	</div>
    1665. 

  1665. </div>
    1666. 

  1666. <footer class="with-border-bottom">
    1667. 

  1667. 	<div class="container">
    1668. 

  1668. 		<h2>Legend</h2>
    1669. 

  1669. 		<div class="tsd-legend-group">
    1670. 

  1670. 			<ul class="tsd-legend">
    1671. 

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

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

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

  1674. 			</ul>
    1675. 

  1675. 			<ul class="tsd-legend">
    1676. 

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

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

  1678. 			</ul>
    1679. 

  1679. 			<ul class="tsd-legend">
    1680. 

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

  1681. 			</ul>
    1682. 

  1682. 			<ul class="tsd-legend">
    1683. 

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

  1684. 			</ul>
    1685. 

  1685. 		</div>
    1686. 

  1686. 	</div>
    1687. 

  1687. </footer>
    1688. 

  1688. <div class="container tsd-generator">
    1689. 

  1689. 	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
    1690. 

  1690. </div>
    1691. 

  1691. <div class="overlay"></div>
    1692. 

  1692. <script src="assets/js/main.js"></script>
    1693. 

  1693. </body>
    1694. 

  1694. </html>
    1695.