index.html 71 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280
  1. <!doctype html>
  2. <html class="default no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <title>@urtc/sdk-web</title>
  7. <meta name="description" content="Documentation for @urtc/sdk-web">
  8. <meta name="viewport" content="width=device-width, initial-scale=1">
  9. <link rel="stylesheet" href="assets/css/main.css">
  10. </head>
  11. <body>
  12. <header>
  13. <div class="tsd-page-toolbar">
  14. <div class="container">
  15. <div class="table-wrap">
  16. <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
  17. <div class="field">
  18. <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
  19. <input id="tsd-search-field" type="text" />
  20. </div>
  21. <ul class="results">
  22. <li class="state loading">Preparing search index...</li>
  23. <li class="state failure">The search index is not available</li>
  24. </ul>
  25. <a href="index.html" class="title">@urtc/sdk-web</a>
  26. </div>
  27. <div class="table-cell" id="tsd-widgets">
  28. <div id="tsd-filter">
  29. <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
  30. <div class="tsd-filter-group">
  31. <div class="tsd-select" id="tsd-filter-visibility">
  32. <span class="tsd-select-label">All</span>
  33. <ul class="tsd-select-list">
  34. <li data-value="public">Public</li>
  35. <li data-value="protected">Public/Protected</li>
  36. <li data-value="private" class="selected">All</li>
  37. </ul>
  38. </div>
  39. <input type="checkbox" id="tsd-filter-inherited" checked />
  40. <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
  41. <input type="checkbox" id="tsd-filter-externals" checked />
  42. <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
  43. </div>
  44. </div>
  45. <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
  46. </div>
  47. </div>
  48. </div>
  49. </div>
  50. <div class="tsd-page-title">
  51. <div class="container">
  52. <ul class="tsd-breadcrumb">
  53. <li>
  54. <a href="index.html">Globals</a>
  55. </li>
  56. </ul>
  57. <h1>@urtc/sdk-web</h1>
  58. </div>
  59. </div>
  60. </header>
  61. <div class="container container-main">
  62. <div class="row">
  63. <div class="col-8 col-content">
  64. <section class="tsd-panel-group tsd-index-group">
  65. <h2>Index</h2>
  66. <section class="tsd-panel tsd-index-panel">
  67. <div class="tsd-index-content">
  68. <section class="tsd-index-section tsd-is-external">
  69. <h3>Classes</h3>
  70. <ul class="tsd-index-list">
  71. <li class="tsd-kind-class tsd-is-external"><a href="classes/client.html" class="tsd-kind-icon">Client</a></li>
  72. <li class="tsd-kind-class tsd-is-external"><a href="classes/localstream.html" class="tsd-kind-icon">Local<wbr>Stream</a></li>
  73. <li class="tsd-kind-class tsd-is-external"><a href="classes/remotestream.html" class="tsd-kind-icon">Remote<wbr>Stream</a></li>
  74. <li class="tsd-kind-class tsd-is-external"><a href="classes/rtcerror.html" class="tsd-kind-icon">Rtc<wbr>Error</a></li>
  75. <li class="tsd-kind-class tsd-is-external"><a href="classes/stream.html" class="tsd-kind-icon">Stream</a></li>
  76. <li class="tsd-kind-class tsd-is-external"><a href="classes/user.html" class="tsd-kind-icon">User</a></li>
  77. </ul>
  78. </section>
  79. <section class="tsd-index-section tsd-is-external">
  80. <h3>Interfaces</h3>
  81. <ul class="tsd-index-list">
  82. <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/audiostats.html" class="tsd-kind-icon">Audio<wbr>Stats</a></li>
  83. <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/clientoptions.html" class="tsd-kind-icon">Client<wbr>Options</a></li>
  84. <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/connectionstates.html" class="tsd-kind-icon">Connection<wbr>States</a></li>
  85. <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/customvideoprofile.html" class="tsd-kind-icon">Custom<wbr>Video<wbr>Profile</a></li>
  86. <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/devicedetectionoptions.html" class="tsd-kind-icon">Device<wbr>Detection<wbr>Options</a></li>
  87. <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/joinoptions.html" class="tsd-kind-icon">Join<wbr>Options</a></li>
  88. <li class="tsd-kind-interface tsd-has-type-parameter tsd-is-external"><a href="interfaces/listener.html" class="tsd-kind-icon">Listener</a></li>
  89. <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/localstreamoptions.html" class="tsd-kind-icon">Local<wbr>Stream<wbr>Options</a></li>
  90. <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/networkstats.html" class="tsd-kind-icon">Network<wbr>Stats</a></li>
  91. <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/playoptions.html" class="tsd-kind-icon">Play<wbr>Options</a></li>
  92. <li class="tsd-kind-interface tsd-has-type-parameter tsd-is-external"><a href="interfaces/rtcevent.html" class="tsd-kind-icon">Rtc<wbr>Event</a></li>
  93. <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/serverconfig.html" class="tsd-kind-icon">Server<wbr>Config</a></li>
  94. <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/streamplugin.html" class="tsd-kind-icon">Stream<wbr>Plugin</a></li>
  95. <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/streamstats.html" class="tsd-kind-icon">Stream<wbr>Stats</a></li>
  96. <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/videostats.html" class="tsd-kind-icon">Video<wbr>Stats</a></li>
  97. </ul>
  98. </section>
  99. <section class="tsd-index-section tsd-is-external">
  100. <h3>Type aliases</h3>
  101. <ul class="tsd-index-list">
  102. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#audiocodec" class="tsd-kind-icon">Audio<wbr>Codec</a></li>
  103. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#connectionstate" class="tsd-kind-icon">Connection<wbr>State</a></li>
  104. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#loglevel" class="tsd-kind-icon">Log<wbr>Level</a></li>
  105. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#mediatype" class="tsd-kind-icon">Media<wbr>Type</a></li>
  106. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#playervideofittype" class="tsd-kind-icon">Player<wbr>Video<wbr>Fit<wbr>Type</a></li>
  107. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#roletype" class="tsd-kind-icon">Role<wbr>Type</a></li>
  108. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#roomtype" class="tsd-kind-icon">Room<wbr>Type</a></li>
  109. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#rtcconnectionevent" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>Event</a></li>
  110. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#rtcconnectioneventtype" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>Event<wbr>Type</a></li>
  111. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#rtceventtype" class="tsd-kind-icon">Rtc<wbr>Event<wbr>Type</a></li>
  112. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#rtcstreamevent" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event</a></li>
  113. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#rtcstreameventtype" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event<wbr>Type</a></li>
  114. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#rtcuserevent" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event</a></li>
  115. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#rtcusereventtype" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event<wbr>Type</a></li>
  116. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#screenprofile" class="tsd-kind-icon">Screen<wbr>Profile</a></li>
  117. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#switchdevicetype" class="tsd-kind-icon">Switch<wbr>Device<wbr>Type</a></li>
  118. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#videocodec" class="tsd-kind-icon">Video<wbr>Codec</a></li>
  119. <li class="tsd-kind-type-alias tsd-is-external"><a href="index.html#videoprofile" class="tsd-kind-icon">Video<wbr>Profile</a></li>
  120. </ul>
  121. </section>
  122. <section class="tsd-index-section tsd-is-external">
  123. <h3>Variables</h3>
  124. <ul class="tsd-index-list">
  125. <li class="tsd-kind-variable tsd-is-external"><a href="index.html#version" class="tsd-kind-icon">version</a></li>
  126. </ul>
  127. </section>
  128. <section class="tsd-index-section ">
  129. <h3>Functions</h3>
  130. <ul class="tsd-index-list">
  131. <li class="tsd-kind-function"><a href="index.html#createclient" class="tsd-kind-icon">create<wbr>Client</a></li>
  132. <li class="tsd-kind-function"><a href="index.html#createstream" class="tsd-kind-icon">create<wbr>Stream</a></li>
  133. <li class="tsd-kind-function tsd-is-external"><a href="index.html#devicedetection" class="tsd-kind-icon">device<wbr>Detection</a></li>
  134. <li class="tsd-kind-function tsd-is-external"><a href="index.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a></li>
  135. <li class="tsd-kind-function tsd-is-external"><a href="index.html#getcameras" class="tsd-kind-icon">get<wbr>Cameras</a></li>
  136. <li class="tsd-kind-function tsd-is-external"><a href="index.html#getdevices" class="tsd-kind-icon">get<wbr>Devices</a></li>
  137. <li class="tsd-kind-function tsd-is-external"><a href="index.html#getloudspeakers" class="tsd-kind-icon">get<wbr>Loudspeakers</a></li>
  138. <li class="tsd-kind-function tsd-is-external"><a href="index.html#getmicrophones" class="tsd-kind-icon">get<wbr>Microphones</a></li>
  139. <li class="tsd-kind-function tsd-is-external"><a href="index.html#issupportscreenshare" class="tsd-kind-icon">is<wbr>Support<wbr>Screen<wbr>Share</a></li>
  140. <li class="tsd-kind-function tsd-is-external"><a href="index.html#issupportwebrtc" class="tsd-kind-icon">is<wbr>Support<wbr>WebRTC</a></li>
  141. <li class="tsd-kind-function"><a href="index.html#reportlog" class="tsd-kind-icon">report<wbr>Log</a></li>
  142. <li class="tsd-kind-function"><a href="index.html#setloglevel" class="tsd-kind-icon">set<wbr>Log<wbr>Level</a></li>
  143. <li class="tsd-kind-function tsd-is-external"><a href="index.html#setservers" class="tsd-kind-icon">set<wbr>Servers</a></li>
  144. </ul>
  145. </section>
  146. </div>
  147. </section>
  148. </section>
  149. <section class="tsd-panel-group tsd-member-group tsd-is-external">
  150. <h2>Type aliases</h2>
  151. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  152. <a name="audiocodec" class="tsd-anchor"></a>
  153. <h3>Audio<wbr>Codec</h3>
  154. <div class="tsd-signature tsd-kind-icon">Audio<wbr>Codec<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"opus"</span></div>
  155. <aside class="tsd-sources">
  156. </aside>
  157. <div class="tsd-comment tsd-typography">
  158. <div class="lead">
  159. <p>音频编解码格式</p>
  160. </div>
  161. </div>
  162. </section>
  163. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  164. <a name="connectionstate" class="tsd-anchor"></a>
  165. <h3>Connection<wbr>State</h3>
  166. <div class="tsd-signature tsd-kind-icon">Connection<wbr>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"OPEN"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"CONNECTING"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"CLOSING"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"RECONNECTING"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"CLOSED"</span></div>
  167. <aside class="tsd-sources">
  168. </aside>
  169. <div class="tsd-comment tsd-typography">
  170. <div class="lead">
  171. <p>连接状态类型:</p>
  172. <ul>
  173. <li>OPEN - 已连接</li>
  174. <li>CONNECTING - 连接中</li>
  175. <li>CLOSING - 断开中</li>
  176. <li>RECONNECTING- 开始重连</li>
  177. <li>CLOSED - 已断开</li>
  178. </ul>
  179. </div>
  180. </div>
  181. </section>
  182. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  183. <a name="loglevel" class="tsd-anchor"></a>
  184. <h3>Log<wbr>Level</h3>
  185. <div class="tsd-signature tsd-kind-icon">Log<wbr>Level<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"debug"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"info"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"warn"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"error"</span></div>
  186. <aside class="tsd-sources">
  187. </aside>
  188. <div class="tsd-comment tsd-typography">
  189. <div class="lead">
  190. <p>日志级别</p>
  191. </div>
  192. </div>
  193. </section>
  194. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  195. <a name="mediatype" class="tsd-anchor"></a>
  196. <h3>Media<wbr>Type</h3>
  197. <div class="tsd-signature tsd-kind-icon">Media<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"main"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"auxiliary"</span></div>
  198. <aside class="tsd-sources">
  199. </aside>
  200. <div class="tsd-comment tsd-typography">
  201. <div class="lead">
  202. <p>流的媒体类型, main - 主视频流,auxiliary - 辅助视频流,通常是一个屏幕分享流</p>
  203. </div>
  204. </div>
  205. </section>
  206. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  207. <a name="playervideofittype" class="tsd-anchor"></a>
  208. <h3>Player<wbr>Video<wbr>Fit<wbr>Type</h3>
  209. <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">"cover"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"contain"</span></div>
  210. <aside class="tsd-sources">
  211. </aside>
  212. <div class="tsd-comment tsd-typography">
  213. <div class="lead">
  214. <p>视频播放时的显示模式</p>
  215. <ul>
  216. <li>cover 模式:优先保证视窗被填满。</li>
  217. <li>contain 模式:优先保证视频内容全部显示。
  218. 播放摄像头视频流默认使用 cover 模式,屏幕共享视频流默认使用 contain 模式。</li>
  219. </ul>
  220. </div>
  221. </div>
  222. </section>
  223. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  224. <a name="roletype" class="tsd-anchor"></a>
  225. <h3>Role<wbr>Type</h3>
  226. <div class="tsd-signature tsd-kind-icon">Role<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"pull"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"push"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"push-and-pull"</span></div>
  227. <aside class="tsd-sources">
  228. </aside>
  229. <div class="tsd-comment tsd-typography">
  230. <div class="lead">
  231. <p>用户角色</p>
  232. </div>
  233. </div>
  234. </section>
  235. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  236. <a name="roomtype" class="tsd-anchor"></a>
  237. <h3>Room<wbr>Type</h3>
  238. <div class="tsd-signature tsd-kind-icon">Room<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"rtc"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"live"</span></div>
  239. <aside class="tsd-sources">
  240. </aside>
  241. <div class="tsd-comment tsd-typography">
  242. <div class="lead">
  243. <p>房间类型</p>
  244. </div>
  245. </div>
  246. </section>
  247. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  248. <a name="rtcconnectionevent" class="tsd-anchor"></a>
  249. <h3>Rtc<wbr>Connection<wbr>Event</h3>
  250. <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Connection<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type">RtcEvent</a><span class="tsd-signature-symbol">&lt;</span><a href="index.html#rtcconnectioneventtype" class="tsd-signature-type">RtcConnectionEventType</a><span class="tsd-signature-symbol">, </span><a href="interfaces/connectionstates.html" class="tsd-signature-type">ConnectionStates</a><span class="tsd-signature-symbol">&gt;</span></div>
  251. <aside class="tsd-sources">
  252. </aside>
  253. <div class="tsd-comment tsd-typography">
  254. <div class="lead">
  255. <p>Rtc 连接事件,事件类型参见 <a href="index.html#rtcconnectioneventtype">RtcConnectionEventType</a></p>
  256. </div>
  257. </div>
  258. </section>
  259. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  260. <a name="rtcconnectioneventtype" class="tsd-anchor"></a>
  261. <h3>Rtc<wbr>Connection<wbr>Event<wbr>Type</h3>
  262. <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Connection<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"connection-state-changed"</span></div>
  263. <aside class="tsd-sources">
  264. </aside>
  265. <div class="tsd-comment tsd-typography">
  266. <div class="lead">
  267. <p>Rtc 客户端连接事件类型:</p>
  268. </div>
  269. <p><a href="index.html#rtcconnectionevent">连接事件</a></p>
  270. <ul>
  271. <li>connection-state-changed - 连接状态改变</li>
  272. </ul>
  273. <dl class="tsd-comment-tags">
  274. <dt>example</dt>
  275. <dd><pre><code class="language-js">client.on(<span class="hljs-string">&#x27;connection-state-changed&#x27;</span>, <span class="hljs-function">(<span class="hljs-params">event</span>) =&gt;</span> {
  276. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`连接状态:<span class="hljs-subst">${event.data.previous}</span> =&gt; <span class="hljs-subst">${event.data.current}</span>`</span>);
  277. });</code></pre>
  278. </dd>
  279. </dl>
  280. </div>
  281. </section>
  282. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  283. <a name="rtceventtype" class="tsd-anchor"></a>
  284. <h3>Rtc<wbr>Event<wbr>Type</h3>
  285. <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">RtcUserEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcstreameventtype" class="tsd-signature-type">RtcStreamEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcconnectioneventtype" class="tsd-signature-type">RtcConnectionEventType</a></div>
  286. <aside class="tsd-sources">
  287. </aside>
  288. <div class="tsd-comment tsd-typography">
  289. <div class="lead">
  290. <p>Rtc 事件类型</p>
  291. </div>
  292. </div>
  293. </section>
  294. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  295. <a name="rtcstreamevent" class="tsd-anchor"></a>
  296. <h3>Rtc<wbr>Stream<wbr>Event</h3>
  297. <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">RtcEvent</a><span class="tsd-signature-symbol">&lt;</span><a href="index.html#rtcstreameventtype" class="tsd-signature-type">RtcStreamEventType</a><span class="tsd-signature-symbol">, </span><a href="classes/stream.html" class="tsd-signature-type">Stream</a><span class="tsd-signature-symbol"> | </span><a href="classes/localstream.html" class="tsd-signature-type">LocalStream</a><span class="tsd-signature-symbol"> | </span><a href="classes/remotestream.html" class="tsd-signature-type">RemoteStream</a><span class="tsd-signature-symbol">&gt;</span></div>
  298. <aside class="tsd-sources">
  299. </aside>
  300. <div class="tsd-comment tsd-typography">
  301. <div class="lead">
  302. <p>Rtc 流事件,事件类型参见 <a href="index.html#rtcstreameventtype">RtcStreamEventType</a></p>
  303. </div>
  304. </div>
  305. </section>
  306. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  307. <a name="rtcstreameventtype" class="tsd-anchor"></a>
  308. <h3>Rtc<wbr>Stream<wbr>Event<wbr>Type</h3>
  309. <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">"stream-added"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stream-removed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stream-subscribed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stream-published"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mute-audio"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"unmute-audio"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mute-video"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"unmute-video"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"first-key-frame"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"screenshare-stopped"</span></div>
  310. <aside class="tsd-sources">
  311. </aside>
  312. <div class="tsd-comment tsd-typography">
  313. <div class="lead">
  314. <p>Rtc 流事件类型:</p>
  315. </div>
  316. <p><a href="index.html#rtcstreamevent">流事件</a></p>
  317. <ul>
  318. <li>stream-added - 有远端流加入,此时事件中的 data 为 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
  319. <li>stream-removed - 有远端流移除,此时事件中的 data 为 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
  320. <li>stream-subscribed - 远端流订阅完成,此时事件中的 data 为 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
  321. <li>stream-published - 本地流发布完成,此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流</li>
  322. <li>mute-audio - 流的音频被 mute</li>
  323. <li>unmute-audio - 流的音频被取消 mute</li>
  324. <li>mute-video - 流的视频被 mute</li>
  325. <li>unmute-video - 流的视频被取消 mute</li>
  326. <li>first-key-frame - 接收到远端流的首帧</li>
  327. </ul>
  328. <dl class="tsd-comment-tags">
  329. <dt>example</dt>
  330. <dd><pre><code class="language-js">client.on(<span class="hljs-string">&#x27;stream-add&#x27;</span>, <span class="hljs-function">(<span class="hljs-params">event</span>) =&gt;</span> {
  331. client.subscribe(event.data);
  332. });</code></pre>
  333. <p><strong>特别地,以下事件需在单条流上进行监听</strong></p>
  334. <ul>
  335. <li>screenshare-stopped - 屏幕共享流被中止,此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流</li>
  336. </ul>
  337. </dd>
  338. <dt>example</dt>
  339. <dd><pre><code class="language-js">localStream.on(<span class="hljs-string">&#x27;screenshare-stopped&#x27;</span>, <span class="hljs-function">(<span class="hljs-params">event</span>) =&gt;</span> {
  340. client.unpublish(event.data);
  341. event.data.destroy();
  342. });</code></pre>
  343. </dd>
  344. </dl>
  345. </div>
  346. </section>
  347. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  348. <a name="rtcuserevent" class="tsd-anchor"></a>
  349. <h3>Rtc<wbr>User<wbr>Event</h3>
  350. <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">RtcEvent</a><span class="tsd-signature-symbol">&lt;</span><a href="index.html#rtcusereventtype" class="tsd-signature-type">RtcUserEventType</a><span class="tsd-signature-symbol">, </span><a href="classes/user.html" class="tsd-signature-type">User</a><span class="tsd-signature-symbol">&gt;</span></div>
  351. <aside class="tsd-sources">
  352. </aside>
  353. <div class="tsd-comment tsd-typography">
  354. <div class="lead">
  355. <p>Rtc 用户事件,事件类型参见 <a href="index.html#rtcusereventtype">RtcUserEventType</a></p>
  356. </div>
  357. </div>
  358. </section>
  359. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  360. <a name="rtcusereventtype" class="tsd-anchor"></a>
  361. <h3>Rtc<wbr>User<wbr>Event<wbr>Type</h3>
  362. <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">"user-joined"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"user-left"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"kick-off"</span></div>
  363. <aside class="tsd-sources">
  364. </aside>
  365. <div class="tsd-comment tsd-typography">
  366. <div class="lead">
  367. <p>Rtc 用户事件类型:</p>
  368. </div>
  369. <p><a href="index.html#rtcuserevent">用户事件</a></p>
  370. <ul>
  371. <li>user-joined - 有用户加入房间</li>
  372. <li>user-left - 有用户离开房间</li>
  373. <li>kick-off - 当前用户被踢出房间</li>
  374. </ul>
  375. <dl class="tsd-comment-tags">
  376. <dt>example</dt>
  377. <dd><pre><code class="language-js">client.on(<span class="hljs-string">&#x27;user-joined&#x27;</span>, <span class="hljs-function">(<span class="hljs-params">event</span>) =&gt;</span> {
  378. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`用户 <span class="hljs-subst">${event.data.id}</span> 加入`</span>);
  379. });</code></pre>
  380. </dd>
  381. </dl>
  382. </div>
  383. </section>
  384. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  385. <a name="screenprofile" class="tsd-anchor"></a>
  386. <h3>Screen<wbr>Profile</h3>
  387. <div class="tsd-signature tsd-kind-icon">Screen<wbr>Profile<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"480p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"480p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p_2"</span></div>
  388. <aside class="tsd-sources">
  389. </aside>
  390. <div class="tsd-comment tsd-typography">
  391. <div class="lead">
  392. <p>预设的屏幕共享视频 Profile</p>
  393. </div>
  394. <table>
  395. <thead>
  396. <tr>
  397. <th align="center">名称</th>
  398. <th align="center">视频宽</th>
  399. <th align="center">视频高</th>
  400. <th align="center">帧率 (fps)</th>
  401. <th align="center">码率 (kbps)</th>
  402. </tr>
  403. </thead>
  404. <tbody><tr>
  405. <td align="center">480p</td>
  406. <td align="center">640</td>
  407. <td align="center">480</td>
  408. <td align="center">5</td>
  409. <td align="center">600</td>
  410. </tr>
  411. <tr>
  412. <td align="center">480p_2</td>
  413. <td align="center">640</td>
  414. <td align="center">480</td>
  415. <td align="center">30</td>
  416. <td align="center">1000</td>
  417. </tr>
  418. <tr>
  419. <td align="center">720p</td>
  420. <td align="center">1280</td>
  421. <td align="center">720</td>
  422. <td align="center">5</td>
  423. <td align="center">1000</td>
  424. </tr>
  425. <tr>
  426. <td align="center">720p_2</td>
  427. <td align="center">1280</td>
  428. <td align="center">720</td>
  429. <td align="center">30</td>
  430. <td align="center">2000</td>
  431. </tr>
  432. <tr>
  433. <td align="center">1080p</td>
  434. <td align="center">1920</td>
  435. <td align="center">1080</td>
  436. <td align="center">5</td>
  437. <td align="center">1500</td>
  438. </tr>
  439. <tr>
  440. <td align="center">1080p_2</td>
  441. <td align="center">1920</td>
  442. <td align="center">1080</td>
  443. <td align="center">30</td>
  444. <td align="center">2500</td>
  445. </tr>
  446. </tbody></table>
  447. </div>
  448. </section>
  449. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  450. <a name="switchdevicetype" class="tsd-anchor"></a>
  451. <h3>Switch<wbr>Device<wbr>Type</h3>
  452. <div class="tsd-signature tsd-kind-icon">Switch<wbr>Device<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"audio"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"video"</span></div>
  453. <aside class="tsd-sources">
  454. </aside>
  455. <div class="tsd-comment tsd-typography">
  456. <div class="lead">
  457. <p>切换设备的类型</p>
  458. </div>
  459. </div>
  460. </section>
  461. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  462. <a name="videocodec" class="tsd-anchor"></a>
  463. <h3>Video<wbr>Codec</h3>
  464. <div class="tsd-signature tsd-kind-icon">Video<wbr>Codec<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"vp8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"h264"</span></div>
  465. <aside class="tsd-sources">
  466. </aside>
  467. <div class="tsd-comment tsd-typography">
  468. <div class="lead">
  469. <p>视频编解码格式</p>
  470. </div>
  471. </div>
  472. </section>
  473. <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external">
  474. <a name="videoprofile" class="tsd-anchor"></a>
  475. <h3>Video<wbr>Profile</h3>
  476. <div class="tsd-signature tsd-kind-icon">Video<wbr>Profile<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"180p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"180p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"240p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"360p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"360p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"480p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p_3"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p_3"</span></div>
  477. <aside class="tsd-sources">
  478. </aside>
  479. <div class="tsd-comment tsd-typography">
  480. <div class="lead">
  481. <p>预设的视频 Profile</p>
  482. </div>
  483. <table>
  484. <thead>
  485. <tr>
  486. <th align="center">名称</th>
  487. <th align="center">视频宽</th>
  488. <th align="center">视频高</th>
  489. <th align="center">帧率 (fps)</th>
  490. <th align="center">码率 (kbps)</th>
  491. </tr>
  492. </thead>
  493. <tbody><tr>
  494. <td align="center">180p</td>
  495. <td align="center">240</td>
  496. <td align="center">180</td>
  497. <td align="center">15</td>
  498. <td align="center">200</td>
  499. </tr>
  500. <tr>
  501. <td align="center">180p_2</td>
  502. <td align="center">320</td>
  503. <td align="center">180</td>
  504. <td align="center">15</td>
  505. <td align="center">300</td>
  506. </tr>
  507. <tr>
  508. <td align="center">240p</td>
  509. <td align="center">320</td>
  510. <td align="center">240</td>
  511. <td align="center">15</td>
  512. <td align="center">400</td>
  513. </tr>
  514. <tr>
  515. <td align="center">360p</td>
  516. <td align="center">480</td>
  517. <td align="center">360</td>
  518. <td align="center">15</td>
  519. <td align="center">400</td>
  520. </tr>
  521. <tr>
  522. <td align="center">360p_2</td>
  523. <td align="center">640</td>
  524. <td align="center">360</td>
  525. <td align="center">15</td>
  526. <td align="center">500</td>
  527. </tr>
  528. <tr>
  529. <td align="center">480p</td>
  530. <td align="center">640</td>
  531. <td align="center">480</td>
  532. <td align="center">15</td>
  533. <td align="center">600</td>
  534. </tr>
  535. <tr>
  536. <td align="center">720p</td>
  537. <td align="center">1280</td>
  538. <td align="center">720</td>
  539. <td align="center">15</td>
  540. <td align="center">1000</td>
  541. </tr>
  542. <tr>
  543. <td align="center">720p_2</td>
  544. <td align="center">1280</td>
  545. <td align="center">720</td>
  546. <td align="center">15</td>
  547. <td align="center">1500</td>
  548. </tr>
  549. <tr>
  550. <td align="center">720p_3</td>
  551. <td align="center">1280</td>
  552. <td align="center">720</td>
  553. <td align="center">30</td>
  554. <td align="center">2000</td>
  555. </tr>
  556. <tr>
  557. <td align="center">1080p</td>
  558. <td align="center">1920</td>
  559. <td align="center">1080</td>
  560. <td align="center">15</td>
  561. <td align="center">1500</td>
  562. </tr>
  563. <tr>
  564. <td align="center">1080p_2</td>
  565. <td align="center">1920</td>
  566. <td align="center">1080</td>
  567. <td align="center">15</td>
  568. <td align="center">2000</td>
  569. </tr>
  570. <tr>
  571. <td align="center">1080p_3</td>
  572. <td align="center">1920</td>
  573. <td align="center">1080</td>
  574. <td align="center">30</td>
  575. <td align="center">2500</td>
  576. </tr>
  577. </tbody></table>
  578. </div>
  579. </section>
  580. </section>
  581. <section class="tsd-panel-group tsd-member-group tsd-is-external">
  582. <h2>Variables</h2>
  583. <section class="tsd-panel tsd-member tsd-kind-variable tsd-is-external">
  584. <a name="version" class="tsd-anchor"></a>
  585. <h3><span class="tsd-flag ts-flagConst">Const</span> version</h3>
  586. <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"> = __VERSION__</span></div>
  587. <aside class="tsd-sources">
  588. </aside>
  589. <div class="tsd-comment tsd-typography">
  590. <div class="lead">
  591. <p>当前 sdk 的版本</p>
  592. </div>
  593. </div>
  594. </section>
  595. </section>
  596. <section class="tsd-panel-group tsd-member-group ">
  597. <h2>Functions</h2>
  598. <section class="tsd-panel tsd-member tsd-kind-function">
  599. <a name="createclient" class="tsd-anchor"></a>
  600. <h3>create<wbr>Client</h3>
  601. <ul class="tsd-signatures tsd-kind-function">
  602. <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">ClientOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/client.html" class="tsd-signature-type">Client</a></li>
  603. </ul>
  604. <ul class="tsd-descriptions">
  605. <li class="tsd-description">
  606. <aside class="tsd-sources">
  607. </aside>
  608. <div class="tsd-comment tsd-typography">
  609. <div class="lead">
  610. <p>创建客户端</p>
  611. </div>
  612. <dl class="tsd-comment-tags">
  613. <dt>example</dt>
  614. <dd><pre><code class="language-js"><span class="hljs-keyword">const</span> client = createClient(<span class="hljs-string">&#x27;AppID&#x27;</span>);
  615. client
  616. .join(<span class="hljs-string">&#x27;roomId&#x27;</span>, <span class="hljs-string">&#x27;userId&#x27;</span>, <span class="hljs-string">&#x27;token&#x27;</span>)
  617. .then(<span class="hljs-function">() =&gt;</span> {
  618. client.publish(localStream);
  619. })
  620. .catch(<span class="hljs-function">(<span class="hljs-params">err</span>) =&gt;</span> {
  621. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`加入房间失败 <span class="hljs-subst">${err}</span>`</span>);
  622. });</code></pre>
  623. </dd>
  624. <dt>throws</dt>
  625. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  626. </dd>
  627. </dl>
  628. </div>
  629. <h4 class="tsd-parameters-title">Parameters</h4>
  630. <ul class="tsd-parameters">
  631. <li>
  632. <h5>appId: <span class="tsd-signature-type">string</span></h5>
  633. <div class="tsd-comment tsd-typography">
  634. <p>应用 ID,可在控制台查看</p>
  635. </div>
  636. </li>
  637. <li>
  638. <h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="interfaces/clientoptions.html" class="tsd-signature-type">ClientOptions</a></h5>
  639. <div class="tsd-comment tsd-typography">
  640. <p>定义客户端的属性</p>
  641. </div>
  642. </li>
  643. </ul>
  644. <h4 class="tsd-returns-title">Returns <a href="classes/client.html" class="tsd-signature-type">Client</a></h4>
  645. </li>
  646. </ul>
  647. </section>
  648. <section class="tsd-panel tsd-member tsd-kind-function">
  649. <a name="createstream" class="tsd-anchor"></a>
  650. <h3>create<wbr>Stream</h3>
  651. <ul class="tsd-signatures tsd-kind-function">
  652. <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">LocalStreamOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/localstream.html" class="tsd-signature-type">LocalStream</a></li>
  653. </ul>
  654. <ul class="tsd-descriptions">
  655. <li class="tsd-description">
  656. <aside class="tsd-sources">
  657. </aside>
  658. <div class="tsd-comment tsd-typography">
  659. <div class="lead">
  660. <p>创建并返回本地音视频流对象</p>
  661. </div>
  662. <dl class="tsd-comment-tags">
  663. <dt>example</dt>
  664. <dd><pre><code class="language-js"><span class="hljs-keyword">const</span> localStream = createStream({ <span class="hljs-attr">audio</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">video</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">screen</span>: <span class="hljs-literal">false</span> });
  665. localStream
  666. .init()
  667. .then(<span class="hljs-function">() =&gt;</span> {
  668. localStream
  669. .play(container)
  670. .catch(<span class="hljs-function">(<span class="hljs-params">err</span>) =&gt;</span> {<span class="hljs-built_in">console</span>.log(<span class="hljs-string">`播放失败: <span class="hljs-subst">${err}</span>`</span>)});
  671. })
  672. .catch(<span class="hljs-function">(<span class="hljs-params">err</span>) =&gt;</span> {
  673. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`本地流初始化失败 <span class="hljs-subst">${err}</span>`</span>);
  674. });</code></pre>
  675. </dd>
  676. <dt>throws</dt>
  677. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  678. </dd>
  679. </dl>
  680. </div>
  681. <h4 class="tsd-parameters-title">Parameters</h4>
  682. <ul class="tsd-parameters">
  683. <li>
  684. <h5>opts: <a href="interfaces/localstreamoptions.html" class="tsd-signature-type">LocalStreamOptions</a></h5>
  685. <div class="tsd-comment tsd-typography">
  686. <p>定义本地音视频流的属性</p>
  687. <blockquote>
  688. <p>注:</p>
  689. <ol>
  690. <li>video, screen 不可同时为 true</li>
  691. <li>audio, video, screen 不可同时为 false</li>
  692. <li>若指定了 file,则 init 时将优先使用 file 来创建初始化本地流的视频</li>
  693. <li>screenAudio 在不同浏览器上表现不同,参见 <a href="interfaces/localstreamoptions.html">LocalStreamOptions</a></li>
  694. </ol>
  695. </blockquote>
  696. </div>
  697. </li>
  698. </ul>
  699. <h4 class="tsd-returns-title">Returns <a href="classes/localstream.html" class="tsd-signature-type">LocalStream</a></h4>
  700. </li>
  701. </ul>
  702. </section>
  703. <section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
  704. <a name="devicedetection" class="tsd-anchor"></a>
  705. <h3>device<wbr>Detection</h3>
  706. <ul class="tsd-signatures tsd-kind-function tsd-is-external">
  707. <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">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>
  708. </ul>
  709. <ul class="tsd-descriptions">
  710. <li class="tsd-description">
  711. <aside class="tsd-sources">
  712. </aside>
  713. <div class="tsd-comment tsd-typography">
  714. <div class="lead">
  715. <p>设备可用性检测 - 创建包含麦克风音频或摄像头视频的本地流时,有可能因为麦克风或摄像头设备问题(如驱动问题,或未经授权等),导致无法正确创建。此方法可用于设备检测,根据检测结果,再决定创建本地流时启用麦克风或摄像头或麦克风和摄像头</p>
  716. </div>
  717. <dl class="tsd-comment-tags">
  718. <dt>example</dt>
  719. <dd><pre><code class="language-js">deviceDetection({<span class="hljs-attr">audio</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">video</span>: <span class="hljs-literal">true</span>})
  720. .then(<span class="hljs-function">() =&gt;</span> {
  721. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;设备可用&#x27;</span>);
  722. })
  723. .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> {
  724. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`设备不可用,<span class="hljs-subst">${err}</span>`</span>);
  725. });</code></pre>
  726. </dd>
  727. <dt>reject</dt>
  728. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  729. </dd>
  730. </dl>
  731. </div>
  732. <h4 class="tsd-parameters-title">Parameters</h4>
  733. <ul class="tsd-parameters">
  734. <li>
  735. <h5>options: <a href="interfaces/devicedetectionoptions.html" class="tsd-signature-type">DeviceDetectionOptions</a></h5>
  736. <div class="tsd-comment tsd-typography">
  737. <p>需指定设备时,请传入设备 ID</p>
  738. </div>
  739. </li>
  740. </ul>
  741. <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>
  742. </li>
  743. </ul>
  744. </section>
  745. <section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
  746. <a name="generatetoken" class="tsd-anchor"></a>
  747. <h3>generate<wbr>Token</h3>
  748. <ul class="tsd-signatures tsd-kind-function tsd-is-external">
  749. <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>
  750. </ul>
  751. <ul class="tsd-descriptions">
  752. <li class="tsd-description">
  753. <aside class="tsd-sources">
  754. </aside>
  755. <div class="tsd-comment tsd-typography">
  756. <div class="lead">
  757. <p>根据 AppId,AppKey,RoomId,UserId 生成 token,用于开发阶段临时快速的加入房间并验证功能,由于 AppKey 不可暴露于公网,因此生产环境中不建议使用此方法生成 token。</p>
  758. </div>
  759. <dl class="tsd-comment-tags">
  760. <dt>example</dt>
  761. <dd><pre><code class="language-js"><span class="hljs-keyword">const</span> token = generateToken(<span class="hljs-string">&#x27;urtc-xxx&#x27;</span>, <span class="hljs-string">&#x27;yyy&#x27;</span>, <span class="hljs-string">&#x27;roomId&#x27;</span>, <span class="hljs-string">&#x27;userId&#x27;</span>);
  762. client.join(<span class="hljs-string">&#x27;roomId&#x27;</span>, <span class="hljs-string">&#x27;userId&#x27;</span>, token);</code></pre>
  763. </dd>
  764. </dl>
  765. </div>
  766. <h4 class="tsd-parameters-title">Parameters</h4>
  767. <ul class="tsd-parameters">
  768. <li>
  769. <h5>appId: <span class="tsd-signature-type">string</span></h5>
  770. <div class="tsd-comment tsd-typography">
  771. <p>应用 ID,可在控制台查看</p>
  772. </div>
  773. </li>
  774. <li>
  775. <h5>appKey: <span class="tsd-signature-type">string</span></h5>
  776. <div class="tsd-comment tsd-typography">
  777. <p>应用密钥,可在控制台查看</p>
  778. </div>
  779. </li>
  780. <li>
  781. <h5>roomId: <span class="tsd-signature-type">string</span></h5>
  782. <div class="tsd-comment tsd-typography">
  783. <p>房间 ID</p>
  784. </div>
  785. </li>
  786. <li>
  787. <h5>userId: <span class="tsd-signature-type">string</span></h5>
  788. <div class="tsd-comment tsd-typography">
  789. <p>用户 ID</p>
  790. </div>
  791. </li>
  792. </ul>
  793. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
  794. </li>
  795. </ul>
  796. </section>
  797. <section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
  798. <a name="getcameras" class="tsd-anchor"></a>
  799. <h3>get<wbr>Cameras</h3>
  800. <ul class="tsd-signatures tsd-kind-function tsd-is-external">
  801. <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>
  802. </ul>
  803. <ul class="tsd-descriptions">
  804. <li class="tsd-description">
  805. <aside class="tsd-sources">
  806. </aside>
  807. <div class="tsd-comment tsd-typography">
  808. <div class="lead">
  809. <p>获取摄像头设备列表,点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
  810. </div>
  811. <dl class="tsd-comment-tags">
  812. <dt>example</dt>
  813. <dd><pre><code class="language-js">getCameras()
  814. .then(<span class="hljs-function"><span class="hljs-params">devices</span> =&gt;</span> {
  815. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`获取设备列表成功:`</span>, devices);
  816. })
  817. .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> {
  818. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`获取设备列表失败:<span class="hljs-subst">${err}</span>`</span>);
  819. });</code></pre>
  820. </dd>
  821. <dt>reject</dt>
  822. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  823. </dd>
  824. </dl>
  825. </div>
  826. <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>
  827. </li>
  828. </ul>
  829. </section>
  830. <section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
  831. <a name="getdevices" class="tsd-anchor"></a>
  832. <h3>get<wbr>Devices</h3>
  833. <ul class="tsd-signatures tsd-kind-function tsd-is-external">
  834. <li class="tsd-signature tsd-kind-icon">get<wbr>Devices<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
  835. </ul>
  836. <ul class="tsd-descriptions">
  837. <li class="tsd-description">
  838. <aside class="tsd-sources">
  839. </aside>
  840. <div class="tsd-comment tsd-typography">
  841. <div class="lead">
  842. <p>获取音视频输入/输出设备列表,点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
  843. </div>
  844. <dl class="tsd-comment-tags">
  845. <dt>example</dt>
  846. <dd><pre><code class="language-js">getDevices()
  847. .then(<span class="hljs-function"><span class="hljs-params">devices</span> =&gt;</span> {
  848. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`获取设备列表成功:`</span>, devices);
  849. })
  850. .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> {
  851. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`获取设备列表失败:<span class="hljs-subst">${err}</span>`</span>);
  852. });</code></pre>
  853. </dd>
  854. <dt>reject</dt>
  855. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  856. </dd>
  857. </dl>
  858. </div>
  859. <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>
  860. </li>
  861. </ul>
  862. </section>
  863. <section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
  864. <a name="getloudspeakers" class="tsd-anchor"></a>
  865. <h3>get<wbr>Loudspeakers</h3>
  866. <ul class="tsd-signatures tsd-kind-function tsd-is-external">
  867. <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>
  868. </ul>
  869. <ul class="tsd-descriptions">
  870. <li class="tsd-description">
  871. <aside class="tsd-sources">
  872. </aside>
  873. <div class="tsd-comment tsd-typography">
  874. <div class="lead">
  875. <p>获取扬声器设备列表,点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
  876. </div>
  877. <dl class="tsd-comment-tags">
  878. <dt>example</dt>
  879. <dd><pre><code class="language-js">getLoudspeakers()
  880. .then(<span class="hljs-function"><span class="hljs-params">devices</span> =&gt;</span> {
  881. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`获取设备列表成功:`</span>, devices);
  882. })
  883. .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> {
  884. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`获取设备列表失败:<span class="hljs-subst">${err}</span>`</span>);
  885. });</code></pre>
  886. </dd>
  887. <dt>reject</dt>
  888. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  889. </dd>
  890. </dl>
  891. </div>
  892. <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>
  893. </li>
  894. </ul>
  895. </section>
  896. <section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
  897. <a name="getmicrophones" class="tsd-anchor"></a>
  898. <h3>get<wbr>Microphones</h3>
  899. <ul class="tsd-signatures tsd-kind-function tsd-is-external">
  900. <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>
  901. </ul>
  902. <ul class="tsd-descriptions">
  903. <li class="tsd-description">
  904. <aside class="tsd-sources">
  905. </aside>
  906. <div class="tsd-comment tsd-typography">
  907. <div class="lead">
  908. <p>获取麦克风设备列表,点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
  909. </div>
  910. <dl class="tsd-comment-tags">
  911. <dt>example</dt>
  912. <dd><pre><code class="language-js">getMicrophones()
  913. .then(<span class="hljs-function"><span class="hljs-params">devices</span> =&gt;</span> {
  914. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`获取设备列表成功:`</span>, devices);
  915. })
  916. .catch(<span class="hljs-function"><span class="hljs-params">err</span> =&gt;</span> {
  917. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`获取设备列表失败:<span class="hljs-subst">${err}</span>`</span>);
  918. });</code></pre>
  919. </dd>
  920. <dt>reject</dt>
  921. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  922. </dd>
  923. </dl>
  924. </div>
  925. <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>
  926. </li>
  927. </ul>
  928. </section>
  929. <section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
  930. <a name="issupportscreenshare" class="tsd-anchor"></a>
  931. <h3>is<wbr>Support<wbr>Screen<wbr>Share</h3>
  932. <ul class="tsd-signatures tsd-kind-function tsd-is-external">
  933. <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>
  934. </ul>
  935. <ul class="tsd-descriptions">
  936. <li class="tsd-description">
  937. <aside class="tsd-sources">
  938. </aside>
  939. <div class="tsd-comment tsd-typography">
  940. <div class="lead">
  941. <p>检测浏览器是否支持屏幕共享</p>
  942. </div>
  943. <dl class="tsd-comment-tags">
  944. <dt>example</dt>
  945. <dd><pre><code class="language-js"><span class="hljs-keyword">if</span> (!isSupportScreenShare()) {
  946. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`当前浏览器不支持屏幕共享`</span>);
  947. }</code></pre>
  948. </dd>
  949. </dl>
  950. </div>
  951. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  952. </li>
  953. </ul>
  954. </section>
  955. <section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
  956. <a name="issupportwebrtc" class="tsd-anchor"></a>
  957. <h3>is<wbr>Support<wbr>WebRTC</h3>
  958. <ul class="tsd-signatures tsd-kind-function tsd-is-external">
  959. <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>
  960. </ul>
  961. <ul class="tsd-descriptions">
  962. <li class="tsd-description">
  963. <aside class="tsd-sources">
  964. </aside>
  965. <div class="tsd-comment tsd-typography">
  966. <div class="lead">
  967. <p>检测浏览器是否完全(可访问本地音视频设备)支持 WebRTC。</p>
  968. </div>
  969. <dl class="tsd-comment-tags">
  970. <dt>example</dt>
  971. <dd><pre><code class="language-js"><span class="hljs-keyword">if</span> (!isSupportWebRTC()) {
  972. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`当前浏览器不完全支持 WebRTC,建议使用 Chrome 浏览器,iOS 系统建议使用 Safari 浏览器`</span>);
  973. }</code></pre>
  974. </dd>
  975. </dl>
  976. </div>
  977. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  978. </li>
  979. </ul>
  980. </section>
  981. <section class="tsd-panel tsd-member tsd-kind-function">
  982. <a name="reportlog" class="tsd-anchor"></a>
  983. <h3>report<wbr>Log</h3>
  984. <ul class="tsd-signatures tsd-kind-function">
  985. <li class="tsd-signature tsd-kind-icon">report<wbr>Log<span class="tsd-signature-symbol">(</span>enable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  986. </ul>
  987. <ul class="tsd-descriptions">
  988. <li class="tsd-description">
  989. <aside class="tsd-sources">
  990. </aside>
  991. <div class="tsd-comment tsd-typography">
  992. <div class="lead">
  993. <p>上报操作/错误/状态日志,未调用时,默认开启上报日志</p>
  994. </div>
  995. <dl class="tsd-comment-tags">
  996. <dt>example</dt>
  997. <dd><pre><code class="language-js">reportLog(<span class="hljs-literal">false</span>); <span class="hljs-comment">// 关闭日志上报,关闭后,在线上出现错误时,将无法根据日志进行排查</span></code></pre>
  998. </dd>
  999. </dl>
  1000. </div>
  1001. <h4 class="tsd-parameters-title">Parameters</h4>
  1002. <ul class="tsd-parameters">
  1003. <li>
  1004. <h5>enable: <span class="tsd-signature-type">boolean</span></h5>
  1005. <div class="tsd-comment tsd-typography">
  1006. <p>是否开启上报</p>
  1007. </div>
  1008. </li>
  1009. </ul>
  1010. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1011. </li>
  1012. </ul>
  1013. </section>
  1014. <section class="tsd-panel tsd-member tsd-kind-function">
  1015. <a name="setloglevel" class="tsd-anchor"></a>
  1016. <h3>set<wbr>Log<wbr>Level</h3>
  1017. <ul class="tsd-signatures tsd-kind-function">
  1018. <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><a href="index.html#loglevel" class="tsd-signature-type">LogLevel</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  1019. </ul>
  1020. <ul class="tsd-descriptions">
  1021. <li class="tsd-description">
  1022. <aside class="tsd-sources">
  1023. </aside>
  1024. <div class="tsd-comment tsd-typography">
  1025. <div class="lead">
  1026. <p>设置日志打印级别</p>
  1027. </div>
  1028. <dl class="tsd-comment-tags">
  1029. <dt>example</dt>
  1030. <dd><pre><code class="language-js">setLogLevel(<span class="hljs-string">&#x27;info&#x27;</span>);</code></pre>
  1031. </dd>
  1032. </dl>
  1033. </div>
  1034. <h4 class="tsd-parameters-title">Parameters</h4>
  1035. <ul class="tsd-parameters">
  1036. <li>
  1037. <h5>level: <a href="index.html#loglevel" class="tsd-signature-type">LogLevel</a></h5>
  1038. <div class="tsd-comment tsd-typography">
  1039. <p>日志级别,有 &#39;debug&#39;, &#39;info&#39;, &#39;warn&#39;, &#39;error&#39; 级别;</p>
  1040. </div>
  1041. </li>
  1042. </ul>
  1043. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1044. </li>
  1045. </ul>
  1046. </section>
  1047. <section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
  1048. <a name="setservers" class="tsd-anchor"></a>
  1049. <h3>set<wbr>Servers</h3>
  1050. <ul class="tsd-signatures tsd-kind-function tsd-is-external">
  1051. <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">ServerConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  1052. </ul>
  1053. <ul class="tsd-descriptions">
  1054. <li class="tsd-description">
  1055. <aside class="tsd-sources">
  1056. </aside>
  1057. <div class="tsd-comment tsd-typography">
  1058. <div class="lead">
  1059. <p>用于私有化部署时,指定部署的服务器地址</p>
  1060. </div>
  1061. <dl class="tsd-comment-tags">
  1062. <dt>example</dt>
  1063. <dd><pre><code class="language-js">setServers({
  1064. <span class="hljs-attr">gateway</span>: <span class="hljs-string">&#x27;https://private-rtc.com&#x27;</span>, <span class="hljs-comment">// 指定网关</span>
  1065. <span class="hljs-attr">log</span>: <span class="hljs-string">&#x27;https://log.private-rtc.com&#x27;</span>, <span class="hljs-comment">// 指定日志服务器</span>
  1066. });</code></pre>
  1067. <p><strong>特别地,单信令服务器时,不需要网关进行分配信令服务器,可以直接指定信令服务器</strong></p>
  1068. <pre><code class="language-js">setServers({
  1069. <span class="hljs-attr">signal</span>: <span class="hljs-string">&#x27;wss://private-rtc.com:5005&#x27;</span>, <span class="hljs-comment">// 直接指定信令服务器</span>
  1070. <span class="hljs-attr">log</span>: <span class="hljs-string">&#x27;https://log.private-rtc.com&#x27;</span>, <span class="hljs-comment">// 指定日志服务器</span>
  1071. });</code></pre>
  1072. </dd>
  1073. <dt>throws</dt>
  1074. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  1075. </dd>
  1076. </dl>
  1077. </div>
  1078. <h4 class="tsd-parameters-title">Parameters</h4>
  1079. <ul class="tsd-parameters">
  1080. <li>
  1081. <h5>conf: <a href="interfaces/serverconfig.html" class="tsd-signature-type">ServerConfig</a></h5>
  1082. <div class="tsd-comment tsd-typography">
  1083. <p>服务器配置,具体描述参见 ServerConfig 的说明</p>
  1084. </div>
  1085. </li>
  1086. </ul>
  1087. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1088. </li>
  1089. </ul>
  1090. </section>
  1091. </section>
  1092. </div>
  1093. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  1094. <nav class="tsd-navigation primary">
  1095. <ul>
  1096. <li class="globals current ">
  1097. <a href="index.html"><em>Globals</em></a>
  1098. </li>
  1099. </ul>
  1100. </nav>
  1101. <nav class="tsd-navigation secondary menu-sticky">
  1102. <ul class="before-current">
  1103. <li class=" tsd-kind-class tsd-is-external">
  1104. <a href="classes/client.html" class="tsd-kind-icon">Client</a>
  1105. </li>
  1106. <li class=" tsd-kind-class tsd-is-external">
  1107. <a href="classes/localstream.html" class="tsd-kind-icon">Local<wbr>Stream</a>
  1108. </li>
  1109. <li class=" tsd-kind-class tsd-is-external">
  1110. <a href="classes/remotestream.html" class="tsd-kind-icon">Remote<wbr>Stream</a>
  1111. </li>
  1112. <li class=" tsd-kind-class tsd-is-external">
  1113. <a href="classes/rtcerror.html" class="tsd-kind-icon">Rtc<wbr>Error</a>
  1114. </li>
  1115. <li class=" tsd-kind-class tsd-is-external">
  1116. <a href="classes/stream.html" class="tsd-kind-icon">Stream</a>
  1117. </li>
  1118. <li class=" tsd-kind-class tsd-is-external">
  1119. <a href="classes/user.html" class="tsd-kind-icon">User</a>
  1120. </li>
  1121. <li class=" tsd-kind-interface tsd-is-external">
  1122. <a href="interfaces/audiostats.html" class="tsd-kind-icon">Audio<wbr>Stats</a>
  1123. </li>
  1124. <li class=" tsd-kind-interface tsd-is-external">
  1125. <a href="interfaces/clientoptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
  1126. </li>
  1127. <li class=" tsd-kind-interface tsd-is-external">
  1128. <a href="interfaces/connectionstates.html" class="tsd-kind-icon">Connection<wbr>States</a>
  1129. </li>
  1130. <li class=" tsd-kind-interface tsd-is-external">
  1131. <a href="interfaces/customvideoprofile.html" class="tsd-kind-icon">Custom<wbr>Video<wbr>Profile</a>
  1132. </li>
  1133. <li class=" tsd-kind-interface tsd-is-external">
  1134. <a href="interfaces/devicedetectionoptions.html" class="tsd-kind-icon">Device<wbr>Detection<wbr>Options</a>
  1135. </li>
  1136. <li class=" tsd-kind-interface tsd-is-external">
  1137. <a href="interfaces/joinoptions.html" class="tsd-kind-icon">Join<wbr>Options</a>
  1138. </li>
  1139. <li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
  1140. <a href="interfaces/listener.html" class="tsd-kind-icon">Listener</a>
  1141. </li>
  1142. <li class=" tsd-kind-interface tsd-is-external">
  1143. <a href="interfaces/localstreamoptions.html" class="tsd-kind-icon">Local<wbr>Stream<wbr>Options</a>
  1144. </li>
  1145. <li class=" tsd-kind-interface tsd-is-external">
  1146. <a href="interfaces/networkstats.html" class="tsd-kind-icon">Network<wbr>Stats</a>
  1147. </li>
  1148. <li class=" tsd-kind-interface tsd-is-external">
  1149. <a href="interfaces/playoptions.html" class="tsd-kind-icon">Play<wbr>Options</a>
  1150. </li>
  1151. <li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
  1152. <a href="interfaces/rtcevent.html" class="tsd-kind-icon">Rtc<wbr>Event</a>
  1153. </li>
  1154. <li class=" tsd-kind-interface tsd-is-external">
  1155. <a href="interfaces/serverconfig.html" class="tsd-kind-icon">Server<wbr>Config</a>
  1156. </li>
  1157. <li class=" tsd-kind-interface tsd-is-external">
  1158. <a href="interfaces/streamplugin.html" class="tsd-kind-icon">Stream<wbr>Plugin</a>
  1159. </li>
  1160. <li class=" tsd-kind-interface tsd-is-external">
  1161. <a href="interfaces/streamstats.html" class="tsd-kind-icon">Stream<wbr>Stats</a>
  1162. </li>
  1163. <li class=" tsd-kind-interface tsd-is-external">
  1164. <a href="interfaces/videostats.html" class="tsd-kind-icon">Video<wbr>Stats</a>
  1165. </li>
  1166. <li class=" tsd-kind-type-alias tsd-is-external">
  1167. <a href="index.html#audiocodec" class="tsd-kind-icon">Audio<wbr>Codec</a>
  1168. </li>
  1169. <li class=" tsd-kind-type-alias tsd-is-external">
  1170. <a href="index.html#connectionstate" class="tsd-kind-icon">Connection<wbr>State</a>
  1171. </li>
  1172. <li class=" tsd-kind-type-alias tsd-is-external">
  1173. <a href="index.html#loglevel" class="tsd-kind-icon">Log<wbr>Level</a>
  1174. </li>
  1175. <li class=" tsd-kind-type-alias tsd-is-external">
  1176. <a href="index.html#mediatype" class="tsd-kind-icon">Media<wbr>Type</a>
  1177. </li>
  1178. <li class=" tsd-kind-type-alias tsd-is-external">
  1179. <a href="index.html#playervideofittype" class="tsd-kind-icon">Player<wbr>Video<wbr>Fit<wbr>Type</a>
  1180. </li>
  1181. <li class=" tsd-kind-type-alias tsd-is-external">
  1182. <a href="index.html#roletype" class="tsd-kind-icon">Role<wbr>Type</a>
  1183. </li>
  1184. <li class=" tsd-kind-type-alias tsd-is-external">
  1185. <a href="index.html#roomtype" class="tsd-kind-icon">Room<wbr>Type</a>
  1186. </li>
  1187. <li class=" tsd-kind-type-alias tsd-is-external">
  1188. <a href="index.html#rtcconnectionevent" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>Event</a>
  1189. </li>
  1190. <li class=" tsd-kind-type-alias tsd-is-external">
  1191. <a href="index.html#rtcconnectioneventtype" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>Event<wbr>Type</a>
  1192. </li>
  1193. <li class=" tsd-kind-type-alias tsd-is-external">
  1194. <a href="index.html#rtceventtype" class="tsd-kind-icon">Rtc<wbr>Event<wbr>Type</a>
  1195. </li>
  1196. <li class=" tsd-kind-type-alias tsd-is-external">
  1197. <a href="index.html#rtcstreamevent" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event</a>
  1198. </li>
  1199. <li class=" tsd-kind-type-alias tsd-is-external">
  1200. <a href="index.html#rtcstreameventtype" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event<wbr>Type</a>
  1201. </li>
  1202. <li class=" tsd-kind-type-alias tsd-is-external">
  1203. <a href="index.html#rtcuserevent" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event</a>
  1204. </li>
  1205. <li class=" tsd-kind-type-alias tsd-is-external">
  1206. <a href="index.html#rtcusereventtype" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event<wbr>Type</a>
  1207. </li>
  1208. <li class=" tsd-kind-type-alias tsd-is-external">
  1209. <a href="index.html#screenprofile" class="tsd-kind-icon">Screen<wbr>Profile</a>
  1210. </li>
  1211. <li class=" tsd-kind-type-alias tsd-is-external">
  1212. <a href="index.html#switchdevicetype" class="tsd-kind-icon">Switch<wbr>Device<wbr>Type</a>
  1213. </li>
  1214. <li class=" tsd-kind-type-alias tsd-is-external">
  1215. <a href="index.html#videocodec" class="tsd-kind-icon">Video<wbr>Codec</a>
  1216. </li>
  1217. <li class=" tsd-kind-type-alias tsd-is-external">
  1218. <a href="index.html#videoprofile" class="tsd-kind-icon">Video<wbr>Profile</a>
  1219. </li>
  1220. <li class=" tsd-kind-variable tsd-is-external">
  1221. <a href="index.html#version" class="tsd-kind-icon">version</a>
  1222. </li>
  1223. <li class=" tsd-kind-function">
  1224. <a href="index.html#createclient" class="tsd-kind-icon">create<wbr>Client</a>
  1225. </li>
  1226. <li class=" tsd-kind-function">
  1227. <a href="index.html#createstream" class="tsd-kind-icon">create<wbr>Stream</a>
  1228. </li>
  1229. <li class=" tsd-kind-function tsd-is-external">
  1230. <a href="index.html#devicedetection" class="tsd-kind-icon">device<wbr>Detection</a>
  1231. </li>
  1232. <li class=" tsd-kind-function tsd-is-external">
  1233. <a href="index.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a>
  1234. </li>
  1235. <li class=" tsd-kind-function tsd-is-external">
  1236. <a href="index.html#getcameras" class="tsd-kind-icon">get<wbr>Cameras</a>
  1237. </li>
  1238. <li class=" tsd-kind-function tsd-is-external">
  1239. <a href="index.html#getdevices" class="tsd-kind-icon">get<wbr>Devices</a>
  1240. </li>
  1241. <li class=" tsd-kind-function tsd-is-external">
  1242. <a href="index.html#getloudspeakers" class="tsd-kind-icon">get<wbr>Loudspeakers</a>
  1243. </li>
  1244. <li class=" tsd-kind-function tsd-is-external">
  1245. <a href="index.html#getmicrophones" class="tsd-kind-icon">get<wbr>Microphones</a>
  1246. </li>
  1247. <li class=" tsd-kind-function tsd-is-external">
  1248. <a href="index.html#issupportscreenshare" class="tsd-kind-icon">is<wbr>Support<wbr>Screen<wbr>Share</a>
  1249. </li>
  1250. <li class=" tsd-kind-function tsd-is-external">
  1251. <a href="index.html#issupportwebrtc" class="tsd-kind-icon">is<wbr>Support<wbr>WebRTC</a>
  1252. </li>
  1253. <li class=" tsd-kind-function">
  1254. <a href="index.html#reportlog" class="tsd-kind-icon">report<wbr>Log</a>
  1255. </li>
  1256. <li class=" tsd-kind-function">
  1257. <a href="index.html#setloglevel" class="tsd-kind-icon">set<wbr>Log<wbr>Level</a>
  1258. </li>
  1259. <li class=" tsd-kind-function tsd-is-external">
  1260. <a href="index.html#setservers" class="tsd-kind-icon">set<wbr>Servers</a>
  1261. </li>
  1262. </ul>
  1263. </nav>
  1264. </div>
  1265. </div>
  1266. </div>
  1267. <footer class="with-border-bottom">
  1268. <div class="container">
  1269. <h2>Legend</h2>
  1270. <div class="tsd-legend-group">
  1271. </div>
  1272. </div>
  1273. </footer>
  1274. <div class="container tsd-generator">
  1275. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  1276. </div>
  1277. <div class="overlay"></div>
  1278. <script src="assets/js/main.js"></script>
  1279. </body>
  1280. </html>