index.html 105 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549
  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. <script async src="assets/js/search.js" id="search-script"></script>
  11. </head>
  12. <body>
  13. <header>
  14. <div class="tsd-page-toolbar">
  15. <div class="container">
  16. <div class="table-wrap">
  17. <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
  18. <div class="field">
  19. <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
  20. <input id="tsd-search-field" type="text" />
  21. </div>
  22. <ul class="results">
  23. <li class="state loading">Preparing search index...</li>
  24. <li class="state failure">The search index is not available</li>
  25. </ul>
  26. <a href="index.html" class="title">@urtc/sdk-web</a>
  27. </div>
  28. <div class="table-cell" id="tsd-widgets">
  29. <div id="tsd-filter">
  30. <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
  31. <div class="tsd-filter-group">
  32. <div class="tsd-select" id="tsd-filter-visibility">
  33. <span class="tsd-select-label">All</span>
  34. <ul class="tsd-select-list">
  35. <li data-value="public">Public</li>
  36. <li data-value="protected">Public/Protected</li>
  37. <li data-value="private" class="selected">All</li>
  38. </ul>
  39. </div>
  40. <input type="checkbox" id="tsd-filter-inherited" checked />
  41. <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
  42. <input type="checkbox" id="tsd-filter-externals" checked />
  43. <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
  44. </div>
  45. </div>
  46. <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
  47. </div>
  48. </div>
  49. </div>
  50. </div>
  51. <div class="tsd-page-title">
  52. <div class="container">
  53. <h1>@urtc/sdk-web</h1>
  54. </div>
  55. </div>
  56. </header>
  57. <div class="container container-main">
  58. <div class="row">
  59. <div class="col-8 col-content">
  60. <section class="tsd-panel-group tsd-index-group">
  61. <h2>Index</h2>
  62. <section class="tsd-panel tsd-index-panel">
  63. <div class="tsd-index-content">
  64. <section class="tsd-index-section ">
  65. <h3>Classes</h3>
  66. <ul class="tsd-index-list">
  67. <li class="tsd-kind-class"><a href="classes/client.html" class="tsd-kind-icon">Client</a></li>
  68. <li class="tsd-kind-class"><a href="classes/localstream.html" class="tsd-kind-icon">Local<wbr>Stream</a></li>
  69. <li class="tsd-kind-class"><a href="classes/remotestream.html" class="tsd-kind-icon">Remote<wbr>Stream</a></li>
  70. <li class="tsd-kind-class"><a href="classes/rtcerror.html" class="tsd-kind-icon">Rtc<wbr>Error</a></li>
  71. <li class="tsd-kind-class"><a href="classes/stream.html" class="tsd-kind-icon">Stream</a></li>
  72. <li class="tsd-kind-class"><a href="classes/user.html" class="tsd-kind-icon">User</a></li>
  73. </ul>
  74. </section>
  75. <section class="tsd-index-section ">
  76. <h3>Interfaces</h3>
  77. <ul class="tsd-index-list">
  78. <li class="tsd-kind-interface"><a href="interfaces/audiostats.html" class="tsd-kind-icon">Audio<wbr>Stats</a></li>
  79. <li class="tsd-kind-interface"><a href="interfaces/clientoptions.html" class="tsd-kind-icon">Client<wbr>Options</a></li>
  80. <li class="tsd-kind-interface"><a href="interfaces/clientplugin.html" class="tsd-kind-icon">Client<wbr>Plugin</a></li>
  81. <li class="tsd-kind-interface"><a href="interfaces/codecs.html" class="tsd-kind-icon">Codecs</a></li>
  82. <li class="tsd-kind-interface"><a href="interfaces/connectionstates.html" class="tsd-kind-icon">Connection<wbr>States</a></li>
  83. <li class="tsd-kind-interface"><a href="interfaces/devicedetectionoptions.html" class="tsd-kind-icon">Device<wbr>Detection<wbr>Options</a></li>
  84. <li class="tsd-kind-interface"><a href="interfaces/joinoptions.html" class="tsd-kind-icon">Join<wbr>Options</a></li>
  85. <li class="tsd-kind-interface"><a href="interfaces/localstreamoptions.html" class="tsd-kind-icon">Local<wbr>Stream<wbr>Options</a></li>
  86. <li class="tsd-kind-interface"><a href="interfaces/networkqualities.html" class="tsd-kind-icon">Network<wbr>Qualities</a></li>
  87. <li class="tsd-kind-interface"><a href="interfaces/networkstats.html" class="tsd-kind-icon">Network<wbr>Stats</a></li>
  88. <li class="tsd-kind-interface"><a href="interfaces/playoptions.html" class="tsd-kind-icon">Play<wbr>Options</a></li>
  89. <li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/rtcevent.html" class="tsd-kind-icon">Rtc<wbr>Event</a></li>
  90. <li class="tsd-kind-interface"><a href="interfaces/serverconfig.html" class="tsd-kind-icon">Server<wbr>Config</a></li>
  91. <li class="tsd-kind-interface"><a href="interfaces/snapshotoptions.html" class="tsd-kind-icon">Snapshot<wbr>Options</a></li>
  92. <li class="tsd-kind-interface"><a href="interfaces/streamplugin.html" class="tsd-kind-icon">Stream<wbr>Plugin</a></li>
  93. <li class="tsd-kind-interface"><a href="interfaces/streamstats.html" class="tsd-kind-icon">Stream<wbr>Stats</a></li>
  94. <li class="tsd-kind-interface"><a href="interfaces/videostats.html" class="tsd-kind-icon">Video<wbr>Stats</a></li>
  95. </ul>
  96. </section>
  97. <section class="tsd-index-section ">
  98. <h3>Type aliases</h3>
  99. <ul class="tsd-index-list">
  100. <li class="tsd-kind-type-alias"><a href="index.html#audiocodec" class="tsd-kind-icon">Audio<wbr>Codec</a></li>
  101. <li class="tsd-kind-type-alias"><a href="index.html#connectionstate" class="tsd-kind-icon">Connection<wbr>State</a></li>
  102. <li class="tsd-kind-type-alias"><a href="index.html#errorcode" class="tsd-kind-icon">Error<wbr>Code</a></li>
  103. <li class="tsd-kind-type-alias"><a href="index.html#facingmode" class="tsd-kind-icon">Facing<wbr>Mode</a></li>
  104. <li class="tsd-kind-type-alias"><a href="index.html#mediatype" class="tsd-kind-icon">Media<wbr>Type</a></li>
  105. <li class="tsd-kind-type-alias"><a href="index.html#networkquality" class="tsd-kind-icon">Network<wbr>Quality</a></li>
  106. <li class="tsd-kind-type-alias"><a href="index.html#playcontrolstype" class="tsd-kind-icon">Play<wbr>Controls<wbr>Type</a></li>
  107. <li class="tsd-kind-type-alias"><a href="index.html#playervideofittype" class="tsd-kind-icon">Player<wbr>Video<wbr>Fit<wbr>Type</a></li>
  108. <li class="tsd-kind-type-alias"><a href="index.html#roletype" class="tsd-kind-icon">Role<wbr>Type</a></li>
  109. <li class="tsd-kind-type-alias"><a href="index.html#roomtype" class="tsd-kind-icon">Room<wbr>Type</a></li>
  110. <li class="tsd-kind-type-alias"><a href="index.html#rtcconnectionevent" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>Event</a></li>
  111. <li class="tsd-kind-type-alias"><a href="index.html#rtcconnectioneventtype" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>Event<wbr>Type</a></li>
  112. <li class="tsd-kind-type-alias"><a href="index.html#rtceventtype" class="tsd-kind-icon">Rtc<wbr>Event<wbr>Type</a></li>
  113. <li class="tsd-kind-type-alias"><a href="index.html#rtcplayerevent" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event</a></li>
  114. <li class="tsd-kind-type-alias"><a href="index.html#rtcplayereventtype" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event<wbr>Type</a></li>
  115. <li class="tsd-kind-type-alias"><a href="index.html#rtcstreamevent" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event</a></li>
  116. <li class="tsd-kind-type-alias"><a href="index.html#rtcstreameventtype" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event<wbr>Type</a></li>
  117. <li class="tsd-kind-type-alias"><a href="index.html#rtcuserevent" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event</a></li>
  118. <li class="tsd-kind-type-alias"><a href="index.html#rtcusereventtype" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event<wbr>Type</a></li>
  119. <li class="tsd-kind-type-alias"><a href="index.html#screenprofile" class="tsd-kind-icon">Screen<wbr>Profile</a></li>
  120. <li class="tsd-kind-type-alias"><a href="index.html#switchdevicetype" class="tsd-kind-icon">Switch<wbr>Device<wbr>Type</a></li>
  121. <li class="tsd-kind-type-alias"><a href="index.html#videocodec" class="tsd-kind-icon">Video<wbr>Codec</a></li>
  122. <li class="tsd-kind-type-alias"><a href="index.html#videoprofile" class="tsd-kind-icon">Video<wbr>Profile</a></li>
  123. </ul>
  124. </section>
  125. <section class="tsd-index-section ">
  126. <h3>Variables</h3>
  127. <ul class="tsd-index-list">
  128. <li class="tsd-kind-variable"><a href="index.html#version" class="tsd-kind-icon">version</a></li>
  129. </ul>
  130. </section>
  131. <section class="tsd-index-section ">
  132. <h3>Functions</h3>
  133. <ul class="tsd-index-list">
  134. <li class="tsd-kind-function"><a href="index.html#createclient" class="tsd-kind-icon">create<wbr>Client</a></li>
  135. <li class="tsd-kind-function"><a href="index.html#createstream" class="tsd-kind-icon">create<wbr>Stream</a></li>
  136. <li class="tsd-kind-function"><a href="index.html#devicedetection" class="tsd-kind-icon">device<wbr>Detection</a></li>
  137. <li class="tsd-kind-function"><a href="index.html#disableuploadlog" class="tsd-kind-icon">disable<wbr>Upload<wbr>Log</a></li>
  138. <li class="tsd-kind-function"><a href="index.html#enableuploadlog" class="tsd-kind-icon">enable<wbr>Upload<wbr>Log</a></li>
  139. <li class="tsd-kind-function"><a href="index.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a></li>
  140. <li class="tsd-kind-function"><a href="index.html#getcameras" class="tsd-kind-icon">get<wbr>Cameras</a></li>
  141. <li class="tsd-kind-function"><a href="index.html#getdevices" class="tsd-kind-icon">get<wbr>Devices</a></li>
  142. <li class="tsd-kind-function"><a href="index.html#getloudspeakers" class="tsd-kind-icon">get<wbr>Loudspeakers</a></li>
  143. <li class="tsd-kind-function"><a href="index.html#getmicrophones" class="tsd-kind-icon">get<wbr>Microphones</a></li>
  144. <li class="tsd-kind-function"><a href="index.html#getsupportedcodec" class="tsd-kind-icon">get<wbr>Supported<wbr>Codec</a></li>
  145. <li class="tsd-kind-function"><a href="index.html#issupportscreenshare" class="tsd-kind-icon">is<wbr>Support<wbr>Screen<wbr>Share</a></li>
  146. <li class="tsd-kind-function"><a href="index.html#issupportwebrtc" class="tsd-kind-icon">is<wbr>Support<wbr>WebRTC</a></li>
  147. <li class="tsd-kind-function"><a href="index.html#setloglevel" class="tsd-kind-icon">set<wbr>Log<wbr>Level</a></li>
  148. <li class="tsd-kind-function"><a href="index.html#setservers" class="tsd-kind-icon">set<wbr>Servers</a></li>
  149. </ul>
  150. </section>
  151. </div>
  152. </section>
  153. </section>
  154. <section class="tsd-panel-group tsd-member-group ">
  155. <h2>Type aliases</h2>
  156. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  157. <a name="audiocodec" class="tsd-anchor"></a>
  158. <h3>Audio<wbr>Codec</h3>
  159. <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>
  160. <aside class="tsd-sources">
  161. </aside>
  162. <div class="tsd-comment tsd-typography">
  163. <div class="lead">
  164. <p>音频编解码格式</p>
  165. </div>
  166. </div>
  167. </section>
  168. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  169. <a name="connectionstate" class="tsd-anchor"></a>
  170. <h3>Connection<wbr>State</h3>
  171. <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>
  172. <aside class="tsd-sources">
  173. </aside>
  174. <div class="tsd-comment tsd-typography">
  175. <div class="lead">
  176. <p>连接状态类型:</p>
  177. <ul>
  178. <li>OPEN - 已连接</li>
  179. <li>CONNECTING - 连接中</li>
  180. <li>CLOSING - 断开中</li>
  181. <li>RECONNECTING - 重连中</li>
  182. <li>CLOSED - 已断开</li>
  183. </ul>
  184. </div>
  185. </div>
  186. </section>
  187. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  188. <a name="errorcode" class="tsd-anchor"></a>
  189. <h3>Error<wbr>Code</h3>
  190. <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>
  191. <aside class="tsd-sources">
  192. </aside>
  193. <div class="tsd-comment tsd-typography">
  194. <div class="lead">
  195. <p>RTC 错误代码</p>
  196. </div>
  197. <p>通用错误及代码</p>
  198. <ul>
  199. <li>1000 - 非法参数</li>
  200. <li>1001 - 非法操作</li>
  201. <li>1002 - 不支持</li>
  202. <li>1003 - 不存在</li>
  203. <li>1004 - 请求失败</li>
  204. <li>1999 - 其他错误</li>
  205. </ul>
  206. <p>房间相关错误及代码</p>
  207. <ul>
  208. <li>2000 - 网关不可达</li>
  209. <li>2001 - 获取 Access Token 失败</li>
  210. <li>2002 - Access Token 非法</li>
  211. <li>2003 - Websocket 连接失败</li>
  212. <li>2004 - 加入房间失败</li>
  213. <li>2005 - 未加入房间</li>
  214. <li>2006 - 正在加入房间</li>
  215. <li>2007 - 正在离开房间</li>
  216. <li>2008 - 角色类型不匹配</li>
  217. <li>2009 - 信令服务器地址错误</li>
  218. </ul>
  219. <p>流相关错误及代码</p>
  220. <ul>
  221. <li>3000 - 流不存在</li>
  222. <li>3001 - 同类型的流已存在</li>
  223. <li>3002 - 音频不存在</li>
  224. <li>3003 - 视频不存在</li>
  225. <li>3004 - [中止错误] 尽管用户和操作系统都授予了访问设备硬件的权利,而且未出现可能抛出NotReadableError异常的硬件问题,但仍然有一些问题的出现导致了设备无法被使用。</li>
  226. <li>3005 - [拒绝错误] 用户拒绝了当前的浏览器实例的访问请求;或者用户拒绝了当前会话的访问;或者用户在全局范围内拒绝了所有媒体访问请求。</li>
  227. <li>3006 - [找不到错误] 找不到满足请求参数的媒体类型。</li>
  228. <li>3007 - [无法读取错误] 尽管用户已经授权使用相应的设备,操作系统上某个硬件、浏览器或者网页层面发生的错误导致设备无法被访问。</li>
  229. <li>3008 - [无法满足要求错误] 指定的要求无法被设备满足。</li>
  230. <li>3009 - 流连接失败</li>
  231. <li>3010 - 流正在重连</li>
  232. <li>3011 - 流尚未发布</li>
  233. <li>3012 - 流正在发布</li>
  234. <li>3013 - 流正在取消发布</li>
  235. <li>3014 - 流已经发布</li>
  236. <li>3015 - 流尚未订阅</li>
  237. <li>3016 - 流正在订阅</li>
  238. <li>3017 - 流正在取消订阅</li>
  239. <li>3018 - 流已经订阅</li>
  240. <li>3019 - 自动播放被禁止错误</li>
  241. <li>3020 - 音视频数据异常,未成功播放(一般为网络原因导致,拉流时音视频数据加载过慢)</li>
  242. <li>3021 - 因未曾调用或调用 play 方法失败,故不可恢复播放</li>
  243. </ul>
  244. </div>
  245. </section>
  246. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  247. <a name="facingmode" class="tsd-anchor"></a>
  248. <h3>Facing<wbr>Mode</h3>
  249. <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>
  250. <aside class="tsd-sources">
  251. </aside>
  252. <div class="tsd-comment tsd-typography">
  253. <div class="lead">
  254. <p>指定使用前置或后置摄像头,&#39;user&#39;(前置摄像头)或 &#39;environment&#39;(后置摄像头)</p>
  255. </div>
  256. </div>
  257. </section>
  258. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  259. <a name="mediatype" class="tsd-anchor"></a>
  260. <h3>Media<wbr>Type</h3>
  261. <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>
  262. <aside class="tsd-sources">
  263. </aside>
  264. <div class="tsd-comment tsd-typography">
  265. <div class="lead">
  266. <p>流的媒体类型, camera - 主视频流,screen - 辅助视频流,通常是一个屏幕分享流</p>
  267. </div>
  268. </div>
  269. </section>
  270. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  271. <a name="networkquality" class="tsd-anchor"></a>
  272. <h3>Network<wbr>Quality</h3>
  273. <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>
  274. <aside class="tsd-sources">
  275. </aside>
  276. <div class="tsd-comment tsd-typography">
  277. <div class="lead">
  278. <p>流的网络质量评分,有 &#39;0&#39; | &#39;1&#39; | &#39;2&#39; | &#39;3&#39; | &#39;4&#39; | &#39;5&#39; | &#39;6&#39;</p>
  279. <ul>
  280. <li>&#39;0&#39;: 网络质量未知</li>
  281. <li>&#39;1&#39;: 网络质量优秀</li>
  282. <li>&#39;2&#39;: 网络质量良好</li>
  283. <li>&#39;3&#39;: 网络质量一般</li>
  284. <li>&#39;4&#39;: 网络质量较差</li>
  285. <li>&#39;5&#39;: 网络质量糟糕</li>
  286. <li>&#39;6&#39;: 网络连接断开</li>
  287. </ul>
  288. </div>
  289. </div>
  290. </section>
  291. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  292. <a name="playcontrolstype" class="tsd-anchor"></a>
  293. <h3>Play<wbr>Controls<wbr>Type</h3>
  294. <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>
  295. <aside class="tsd-sources">
  296. </aside>
  297. <div class="tsd-comment tsd-typography">
  298. <div class="lead">
  299. <p>视频播放时 audio / video 的控制面板的显示模式</p>
  300. <ul>
  301. <li>show 模式:一直显示</li>
  302. <li>hide 模式:一直隐藏</li>
  303. <li>auto 模式:自动判断</li>
  304. </ul>
  305. </div>
  306. </div>
  307. </section>
  308. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  309. <a name="playervideofittype" class="tsd-anchor"></a>
  310. <h3>Player<wbr>Video<wbr>Fit<wbr>Type</h3>
  311. <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>
  312. <aside class="tsd-sources">
  313. </aside>
  314. <div class="tsd-comment tsd-typography">
  315. <div class="lead">
  316. <p>视频播放时的显示模式</p>
  317. <ul>
  318. <li>cover 模式:优先保证视窗被填满。</li>
  319. <li>contain 模式:优先保证视频内容全部显示。
  320. 播放摄像头视频流默认使用 cover 模式,屏幕共享视频流默认使用 contain 模式。</li>
  321. </ul>
  322. </div>
  323. </div>
  324. </section>
  325. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  326. <a name="roletype" class="tsd-anchor"></a>
  327. <h3>Role<wbr>Type</h3>
  328. <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>
  329. <aside class="tsd-sources">
  330. </aside>
  331. <div class="tsd-comment tsd-typography">
  332. <div class="lead">
  333. <p>用户角色,&#39;audience&#39; | &#39;speaker&#39; 分别为观众,主讲。</p>
  334. </div>
  335. </div>
  336. </section>
  337. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  338. <a name="roomtype" class="tsd-anchor"></a>
  339. <h3>Room<wbr>Type</h3>
  340. <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>
  341. <aside class="tsd-sources">
  342. </aside>
  343. <div class="tsd-comment tsd-typography">
  344. <div class="lead">
  345. <p>房间类型:&#39;conference&#39; | &#39;live&#39;,分别对应会议模式 | 直播模式。
  346. 注:
  347. 会议模式:房间内用户数较少,各用户均会推流,并拉其他用户的流。
  348. 直播模式:房间内用户数较多,个别用户会推流,大部分用户只拉流观看。</p>
  349. </div>
  350. </div>
  351. </section>
  352. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  353. <a name="rtcconnectionevent" class="tsd-anchor"></a>
  354. <h3>Rtc<wbr>Connection<wbr>Event</h3>
  355. <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Connection<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type" data-tsd-kind="Interface">RtcEvent</a><span class="tsd-signature-symbol">&lt;</span><a href="index.html#rtcconnectioneventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcConnectionEventType</a><span class="tsd-signature-symbol">, </span><a href="interfaces/connectionstates.html" class="tsd-signature-type" data-tsd-kind="Interface">ConnectionStates</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>
  356. <aside class="tsd-sources">
  357. </aside>
  358. <div class="tsd-comment tsd-typography">
  359. <div class="lead">
  360. <p>Rtc 连接事件,事件类型参见 <a href="index.html#rtcconnectioneventtype">RtcConnectionEventType</a></p>
  361. </div>
  362. </div>
  363. </section>
  364. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  365. <a name="rtcconnectioneventtype" class="tsd-anchor"></a>
  366. <h3>Rtc<wbr>Connection<wbr>Event<wbr>Type</h3>
  367. <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Connection<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;connection-state-changed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;network-quality&quot;</span></div>
  368. <aside class="tsd-sources">
  369. </aside>
  370. <div class="tsd-comment tsd-typography">
  371. <div class="lead">
  372. <p>Rtc 客户端连接事件类型:</p>
  373. </div>
  374. <p><a href="index.html#rtcconnectionevent">连接事件</a></p>
  375. <ul>
  376. <li>connection-state-changed - 连接状态改变</li>
  377. <li>network-quality - 上/下行网络质量</li>
  378. </ul>
  379. <dl class="tsd-comment-tags">
  380. <dt>example</dt>
  381. <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>
  382. <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>
  383. <span style="color: #000000">});</span>
  384. </code></pre>
  385. <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>
  386. <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>
  387. <span style="color: #000000">});</span>
  388. </code></pre>
  389. </dd>
  390. </dl>
  391. </div>
  392. </section>
  393. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  394. <a name="rtceventtype" class="tsd-anchor"></a>
  395. <h3>Rtc<wbr>Event<wbr>Type</h3>
  396. <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="index.html#rtcusereventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcUserEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcstreameventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcStreamEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcconnectioneventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcConnectionEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcplayereventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcPlayerEventType</a></div>
  397. <aside class="tsd-sources">
  398. </aside>
  399. <div class="tsd-comment tsd-typography">
  400. <div class="lead">
  401. <p>Rtc 事件类型</p>
  402. </div>
  403. </div>
  404. </section>
  405. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  406. <a name="rtcplayerevent" class="tsd-anchor"></a>
  407. <h3>Rtc<wbr>Player<wbr>Event</h3>
  408. <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Player<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type" data-tsd-kind="Interface">RtcEvent</a><span class="tsd-signature-symbol">&lt;</span><a href="index.html#rtcplayereventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcPlayerEventType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">PlayerEventData</span><span class="tsd-signature-symbol">&gt;</span></div>
  409. <aside class="tsd-sources">
  410. </aside>
  411. <div class="tsd-comment tsd-typography">
  412. <div class="lead">
  413. <p>Rtc 连接事件,事件类型参见 <a href="index.html#rtcplayereventtype">RtcPlayerEventType</a></p>
  414. </div>
  415. </div>
  416. </section>
  417. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  418. <a name="rtcplayereventtype" class="tsd-anchor"></a>
  419. <h3>Rtc<wbr>Player<wbr>Event<wbr>Type</h3>
  420. <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>
  421. <aside class="tsd-sources">
  422. </aside>
  423. <div class="tsd-comment tsd-typography">
  424. <div class="lead">
  425. <p>Rtc 播放器事件类型:</p>
  426. </div>
  427. <p><a href="index.html#rtcplayerevent">播放器事件</a></p>
  428. <ul>
  429. <li>player-status-change - 流播放器状态改变</li>
  430. </ul>
  431. <p><strong>注,此事件需在单条流上进行监听</strong></p>
  432. <dl class="tsd-comment-tags">
  433. <dt>example</dt>
  434. <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>
  435. <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>
  436. <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>
  437. <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>
  438. <span style="color: #000000">});</span>
  439. </code></pre>
  440. </dd>
  441. </dl>
  442. </div>
  443. </section>
  444. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  445. <a name="rtcstreamevent" class="tsd-anchor"></a>
  446. <h3>Rtc<wbr>Stream<wbr>Event</h3>
  447. <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>
  448. <aside class="tsd-sources">
  449. </aside>
  450. <div class="tsd-comment tsd-typography">
  451. <div class="lead">
  452. <p>Rtc 流事件,事件类型参见 <a href="index.html#rtcstreameventtype">RtcStreamEventType</a></p>
  453. </div>
  454. </div>
  455. </section>
  456. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  457. <a name="rtcstreameventtype" class="tsd-anchor"></a>
  458. <h3>Rtc<wbr>Stream<wbr>Event<wbr>Type</h3>
  459. <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;screen-sharing-stopped&quot;</span></div>
  460. <aside class="tsd-sources">
  461. </aside>
  462. <div class="tsd-comment tsd-typography">
  463. <div class="lead">
  464. <p>Rtc 流事件类型:</p>
  465. </div>
  466. <p><a href="index.html#rtcstreamevent">流事件</a></p>
  467. <ul>
  468. <li>stream-added - 有远端流加入,此时事件中的 data 为 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
  469. <li>stream-removed - 有远端流移除,此时事件中的 data 为 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
  470. <li>stream-subscribed - 远端流订阅完成,此时事件中的 data 为 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
  471. <li>stream-published - 本地流发布完成,此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流</li>
  472. <li>stream-reconnecting - 流正在重连(本地流重新发布/远端流重新订阅),此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流或 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
  473. <li>stream-reconnected - 流已重连(本地流已重新发布/远端流已重新订阅),此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流或 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
  474. <li>mute-audio - 流的音频被 mute</li>
  475. <li>unmute-audio - 流的音频被取消 mute</li>
  476. <li>mute-video - 流的视频被 mute</li>
  477. <li>unmute-video - 流的视频被取消 mute</li>
  478. </ul>
  479. <dl class="tsd-comment-tags">
  480. <dt>example</dt>
  481. <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>
  482. <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>
  483. <span style="color: #000000">});</span>
  484. </code></pre>
  485. <p><strong>特别地,以下事件需在单条流上进行监听</strong></p>
  486. <ul>
  487. <li>screen-sharing-stopped - 屏幕共享流被中止,此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流</li>
  488. <li>first-key-frame - 接收到远端流的首帧</li>
  489. </ul>
  490. </dd>
  491. <dt>example</dt>
  492. <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>
  493. <span style="color: #000000"> </span><span style="color: #008000">// 此事件只针对本地流有效,若本地流已发布,监听到此事件后,可以决定要不要取消发布</span>
  494. <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>
  495. <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>
  496. <span style="color: #000000">});</span>
  497. </code></pre>
  498. </dd>
  499. <dt>example</dt>
  500. <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>
  501. <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>
  502. <span style="color: #000000">});</span>
  503. </code></pre>
  504. </dd>
  505. </dl>
  506. </div>
  507. </section>
  508. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  509. <a name="rtcuserevent" class="tsd-anchor"></a>
  510. <h3>Rtc<wbr>User<wbr>Event</h3>
  511. <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>
  512. <aside class="tsd-sources">
  513. </aside>
  514. <div class="tsd-comment tsd-typography">
  515. <div class="lead">
  516. <p>Rtc 用户事件,事件类型参见 <a href="index.html#rtcusereventtype">RtcUserEventType</a></p>
  517. </div>
  518. </div>
  519. </section>
  520. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  521. <a name="rtcusereventtype" class="tsd-anchor"></a>
  522. <h3>Rtc<wbr>User<wbr>Event<wbr>Type</h3>
  523. <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>
  524. <aside class="tsd-sources">
  525. </aside>
  526. <div class="tsd-comment tsd-typography">
  527. <div class="lead">
  528. <p>Rtc 用户事件类型:</p>
  529. </div>
  530. <p><a href="index.html#rtcuserevent">用户事件</a></p>
  531. <ul>
  532. <li>user-joined - 有用户加入房间</li>
  533. <li>user-left - 有用户离开房间</li>
  534. <li>kick-off - 当前用户被踢出房间</li>
  535. </ul>
  536. <dl class="tsd-comment-tags">
  537. <dt>example</dt>
  538. <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>
  539. <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>
  540. <span style="color: #000000">});</span>
  541. </code></pre>
  542. </dd>
  543. </dl>
  544. </div>
  545. </section>
  546. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  547. <a name="screenprofile" class="tsd-anchor"></a>
  548. <h3>Screen<wbr>Profile</h3>
  549. <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>
  550. <aside class="tsd-sources">
  551. </aside>
  552. <div class="tsd-comment tsd-typography">
  553. <div class="lead">
  554. <p>预设的屏幕共享视频 Profile</p>
  555. </div>
  556. <table>
  557. <thead>
  558. <tr>
  559. <th align="center">名称</th>
  560. <th align="center">视频宽</th>
  561. <th align="center">视频高</th>
  562. <th align="center">帧率 (fps)</th>
  563. <th align="center">码率 (kbps)</th>
  564. </tr>
  565. </thead>
  566. <tbody><tr>
  567. <td align="center">480p</td>
  568. <td align="center">640</td>
  569. <td align="center">480</td>
  570. <td align="center">5</td>
  571. <td align="center">600</td>
  572. </tr>
  573. <tr>
  574. <td align="center">480p_2</td>
  575. <td align="center">640</td>
  576. <td align="center">480</td>
  577. <td align="center">30</td>
  578. <td align="center">1000</td>
  579. </tr>
  580. <tr>
  581. <td align="center">720p</td>
  582. <td align="center">1280</td>
  583. <td align="center">720</td>
  584. <td align="center">5</td>
  585. <td align="center">1000</td>
  586. </tr>
  587. <tr>
  588. <td align="center">720p_2</td>
  589. <td align="center">1280</td>
  590. <td align="center">720</td>
  591. <td align="center">30</td>
  592. <td align="center">2000</td>
  593. </tr>
  594. <tr>
  595. <td align="center">1080p</td>
  596. <td align="center">1920</td>
  597. <td align="center">1080</td>
  598. <td align="center">5</td>
  599. <td align="center">1500</td>
  600. </tr>
  601. <tr>
  602. <td align="center">1080p_2</td>
  603. <td align="center">1920</td>
  604. <td align="center">1080</td>
  605. <td align="center">30</td>
  606. <td align="center">2500</td>
  607. </tr>
  608. </tbody></table>
  609. </div>
  610. </section>
  611. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  612. <a name="switchdevicetype" class="tsd-anchor"></a>
  613. <h3>Switch<wbr>Device<wbr>Type</h3>
  614. <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>
  615. <aside class="tsd-sources">
  616. </aside>
  617. <div class="tsd-comment tsd-typography">
  618. <div class="lead">
  619. <p>切换设备的类型</p>
  620. </div>
  621. </div>
  622. </section>
  623. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  624. <a name="videocodec" class="tsd-anchor"></a>
  625. <h3>Video<wbr>Codec</h3>
  626. <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>
  627. <aside class="tsd-sources">
  628. </aside>
  629. <div class="tsd-comment tsd-typography">
  630. <div class="lead">
  631. <p>视频编解码格式</p>
  632. </div>
  633. <dl class="tsd-comment-tags">
  634. <dt>note</dt>
  635. <dd><p>&#39;h265&#39; 目前仅部分浏览器在开启试验性功能时才支持,如 Safari 开启 <code>WebRTC H265 codec</code></p>
  636. </dd>
  637. </dl>
  638. </div>
  639. </section>
  640. <section class="tsd-panel tsd-member tsd-kind-type-alias">
  641. <a name="videoprofile" class="tsd-anchor"></a>
  642. <h3>Video<wbr>Profile</h3>
  643. <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>
  644. <aside class="tsd-sources">
  645. </aside>
  646. <div class="tsd-comment tsd-typography">
  647. <div class="lead">
  648. <p>预设的视频 Profile</p>
  649. </div>
  650. <table>
  651. <thead>
  652. <tr>
  653. <th align="center">名称</th>
  654. <th align="center">视频宽</th>
  655. <th align="center">视频高</th>
  656. <th align="center">帧率 (fps)</th>
  657. <th align="center">码率 (kbps)</th>
  658. </tr>
  659. </thead>
  660. <tbody><tr>
  661. <td align="center">180p</td>
  662. <td align="center">240</td>
  663. <td align="center">180</td>
  664. <td align="center">15</td>
  665. <td align="center">200</td>
  666. </tr>
  667. <tr>
  668. <td align="center">180p_2</td>
  669. <td align="center">320</td>
  670. <td align="center">180</td>
  671. <td align="center">15</td>
  672. <td align="center">300</td>
  673. </tr>
  674. <tr>
  675. <td align="center">240p</td>
  676. <td align="center">320</td>
  677. <td align="center">240</td>
  678. <td align="center">15</td>
  679. <td align="center">400</td>
  680. </tr>
  681. <tr>
  682. <td align="center">360p</td>
  683. <td align="center">480</td>
  684. <td align="center">360</td>
  685. <td align="center">15</td>
  686. <td align="center">400</td>
  687. </tr>
  688. <tr>
  689. <td align="center">360p_2</td>
  690. <td align="center">640</td>
  691. <td align="center">360</td>
  692. <td align="center">15</td>
  693. <td align="center">500</td>
  694. </tr>
  695. <tr>
  696. <td align="center">480p</td>
  697. <td align="center">640</td>
  698. <td align="center">480</td>
  699. <td align="center">15</td>
  700. <td align="center">600</td>
  701. </tr>
  702. <tr>
  703. <td align="center">720p</td>
  704. <td align="center">1280</td>
  705. <td align="center">720</td>
  706. <td align="center">15</td>
  707. <td align="center">1000</td>
  708. </tr>
  709. <tr>
  710. <td align="center">720p_2</td>
  711. <td align="center">1280</td>
  712. <td align="center">720</td>
  713. <td align="center">15</td>
  714. <td align="center">1500</td>
  715. </tr>
  716. <tr>
  717. <td align="center">720p_3</td>
  718. <td align="center">1280</td>
  719. <td align="center">720</td>
  720. <td align="center">30</td>
  721. <td align="center">2000</td>
  722. </tr>
  723. <tr>
  724. <td align="center">1080p</td>
  725. <td align="center">1920</td>
  726. <td align="center">1080</td>
  727. <td align="center">15</td>
  728. <td align="center">1500</td>
  729. </tr>
  730. <tr>
  731. <td align="center">1080p_2</td>
  732. <td align="center">1920</td>
  733. <td align="center">1080</td>
  734. <td align="center">15</td>
  735. <td align="center">2000</td>
  736. </tr>
  737. <tr>
  738. <td align="center">1080p_3</td>
  739. <td align="center">1920</td>
  740. <td align="center">1080</td>
  741. <td align="center">30</td>
  742. <td align="center">2500</td>
  743. </tr>
  744. </tbody></table>
  745. </div>
  746. </section>
  747. </section>
  748. <section class="tsd-panel-group tsd-member-group ">
  749. <h2>Variables</h2>
  750. <section class="tsd-panel tsd-member tsd-kind-variable">
  751. <a name="version" class="tsd-anchor"></a>
  752. <h3><span class="tsd-flag ts-flagConst">Const</span> version</h3>
  753. <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>
  754. <aside class="tsd-sources">
  755. </aside>
  756. <div class="tsd-comment tsd-typography">
  757. <div class="lead">
  758. <p>当前 sdk 的版本号</p>
  759. </div>
  760. </div>
  761. </section>
  762. </section>
  763. <section class="tsd-panel-group tsd-member-group ">
  764. <h2>Functions</h2>
  765. <section class="tsd-panel tsd-member tsd-kind-function">
  766. <a name="createclient" class="tsd-anchor"></a>
  767. <h3>create<wbr>Client</h3>
  768. <ul class="tsd-signatures tsd-kind-function">
  769. <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>
  770. </ul>
  771. <ul class="tsd-descriptions">
  772. <li class="tsd-description">
  773. <aside class="tsd-sources">
  774. </aside>
  775. <div class="tsd-comment tsd-typography">
  776. <div class="lead">
  777. <p>创建客户端</p>
  778. </div>
  779. <dl class="tsd-comment-tags">
  780. <dt>example</dt>
  781. <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>
  782. <span style="color: #001080">client</span>
  783. <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>
  784. <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>
  785. <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>
  786. <span style="color: #000000"> })</span>
  787. <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>
  788. <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>
  789. <span style="color: #000000"> });</span>
  790. </code></pre>
  791. </dd>
  792. <dt>throws</dt>
  793. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  794. </dd>
  795. </dl>
  796. </div>
  797. <h4 class="tsd-parameters-title">Parameters</h4>
  798. <ul class="tsd-parameters">
  799. <li>
  800. <h5>appId: <span class="tsd-signature-type">string</span></h5>
  801. <div class="tsd-comment tsd-typography">
  802. <p>应用 ID,可在控制台查看</p>
  803. </div>
  804. </li>
  805. <li>
  806. <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>
  807. <div class="tsd-comment tsd-typography">
  808. <p>定义客户端的属性</p>
  809. </div>
  810. </li>
  811. </ul>
  812. <h4 class="tsd-returns-title">Returns <a href="classes/client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4>
  813. </li>
  814. </ul>
  815. </section>
  816. <section class="tsd-panel tsd-member tsd-kind-function">
  817. <a name="createstream" class="tsd-anchor"></a>
  818. <h3>create<wbr>Stream</h3>
  819. <ul class="tsd-signatures tsd-kind-function">
  820. <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>
  821. </ul>
  822. <ul class="tsd-descriptions">
  823. <li class="tsd-description">
  824. <aside class="tsd-sources">
  825. </aside>
  826. <div class="tsd-comment tsd-typography">
  827. <div class="lead">
  828. <p>创建本地流</p>
  829. </div>
  830. <dl class="tsd-comment-tags">
  831. <dt>example</dt>
  832. <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>
  833. <span style="color: #001080">localStream</span>
  834. <span style="color: #000000"> .</span><span style="color: #795E26">init</span><span style="color: #000000">()</span>
  835. <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>
  836. <span style="color: #000000"> </span><span style="color: #001080">localStream</span>
  837. <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>
  838. <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>
  839. <span style="color: #000000"> })</span>
  840. <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>
  841. <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>
  842. <span style="color: #000000"> });</span>
  843. </code></pre>
  844. </dd>
  845. <dt>throws</dt>
  846. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  847. </dd>
  848. </dl>
  849. </div>
  850. <h4 class="tsd-parameters-title">Parameters</h4>
  851. <ul class="tsd-parameters">
  852. <li>
  853. <h5>opts: <a href="interfaces/localstreamoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LocalStreamOptions</a></h5>
  854. <div class="tsd-comment tsd-typography">
  855. <p>必传,定义本地音视频流的属性
  856. 注:</p>
  857. <ol>
  858. <li>video, screen 不可同时为 true</li>
  859. <li>audio, video, screen 不可同时为 false</li>
  860. <li>若指定了 file,则 init 时将优先使用 file 来创建初始化本地流的视频</li>
  861. <li>screenAudio 在不同浏览器上表现不同,参见 <a href="interfaces/localstreamoptions.html">LocalStreamOptions</a></li>
  862. </ol>
  863. </div>
  864. </li>
  865. </ul>
  866. <h4 class="tsd-returns-title">Returns <a href="classes/localstream.html" class="tsd-signature-type" data-tsd-kind="Class">LocalStream</a></h4>
  867. </li>
  868. </ul>
  869. </section>
  870. <section class="tsd-panel tsd-member tsd-kind-function">
  871. <a name="devicedetection" class="tsd-anchor"></a>
  872. <h3>device<wbr>Detection</h3>
  873. <ul class="tsd-signatures tsd-kind-function">
  874. <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>
  875. </ul>
  876. <ul class="tsd-descriptions">
  877. <li class="tsd-description">
  878. <aside class="tsd-sources">
  879. </aside>
  880. <div class="tsd-comment tsd-typography">
  881. <div class="lead">
  882. <p>设备可用性检测 - 创建包含麦克风音频或摄像头视频的本地流时,有可能因为麦克风或摄像头设备问题(如驱动问题,或未经授权等),导致无法正确创建。此方法可用于设备检测,根据检测结果,再决定创建本地流时启用麦克风或摄像头或麦克风和摄像头</p>
  883. </div>
  884. <dl class="tsd-comment-tags">
  885. <dt>example</dt>
  886. <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>
  887. <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>
  888. <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>
  889. <span style="color: #000000"> })</span>
  890. <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>
  891. <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>
  892. <span style="color: #000000"> });</span>
  893. </code></pre>
  894. </dd>
  895. <dt>reject</dt>
  896. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  897. </dd>
  898. </dl>
  899. </div>
  900. <h4 class="tsd-parameters-title">Parameters</h4>
  901. <ul class="tsd-parameters">
  902. <li>
  903. <h5>options: <a href="interfaces/devicedetectionoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DeviceDetectionOptions</a></h5>
  904. <div class="tsd-comment tsd-typography">
  905. <p>需指定设备时,请传入设备 ID</p>
  906. </div>
  907. </li>
  908. </ul>
  909. <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>
  910. </li>
  911. </ul>
  912. </section>
  913. <section class="tsd-panel tsd-member tsd-kind-function">
  914. <a name="disableuploadlog" class="tsd-anchor"></a>
  915. <h3>disable<wbr>Upload<wbr>Log</h3>
  916. <ul class="tsd-signatures tsd-kind-function">
  917. <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>
  918. </ul>
  919. <ul class="tsd-descriptions">
  920. <li class="tsd-description">
  921. <aside class="tsd-sources">
  922. </aside>
  923. <div class="tsd-comment tsd-typography">
  924. <div class="lead">
  925. <p>关闭日志(操作/错误/状态)的上报
  926. 注:若无特殊原因,不建议关闭日志上报,关闭后,在线上出现错误时,将无法根据日志定位问题</p>
  927. </div>
  928. <dl class="tsd-comment-tags">
  929. <dt>example</dt>
  930. <dd><pre><code class="language-js"><span style="color: #795E26">disableUploadLog</span><span style="color: #000000">();</span>
  931. </code></pre>
  932. </dd>
  933. </dl>
  934. </div>
  935. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  936. </li>
  937. </ul>
  938. </section>
  939. <section class="tsd-panel tsd-member tsd-kind-function">
  940. <a name="enableuploadlog" class="tsd-anchor"></a>
  941. <h3>enable<wbr>Upload<wbr>Log</h3>
  942. <ul class="tsd-signatures tsd-kind-function">
  943. <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>
  944. </ul>
  945. <ul class="tsd-descriptions">
  946. <li class="tsd-description">
  947. <aside class="tsd-sources">
  948. </aside>
  949. <div class="tsd-comment tsd-typography">
  950. <div class="lead">
  951. <p>开启日志(操作/错误/状态)的上报,默认开启</p>
  952. </div>
  953. <dl class="tsd-comment-tags">
  954. <dt>example</dt>
  955. <dd><pre><code class="language-js"><span style="color: #795E26">enableUploadLog</span><span style="color: #000000">();</span>
  956. </code></pre>
  957. </dd>
  958. </dl>
  959. </div>
  960. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  961. </li>
  962. </ul>
  963. </section>
  964. <section class="tsd-panel tsd-member tsd-kind-function">
  965. <a name="generatetoken" class="tsd-anchor"></a>
  966. <h3>generate<wbr>Token</h3>
  967. <ul class="tsd-signatures tsd-kind-function">
  968. <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>
  969. </ul>
  970. <ul class="tsd-descriptions">
  971. <li class="tsd-description">
  972. <aside class="tsd-sources">
  973. </aside>
  974. <div class="tsd-comment tsd-typography">
  975. <div class="lead">
  976. <p>根据 AppId,AppKey,RoomId,UserId 生成 token,用于开发阶段临时快速的加入房间并验证功能,由于 AppKey 不可暴露于公网,因此生产环境中不建议使用此方法生成 token。</p>
  977. </div>
  978. <dl class="tsd-comment-tags">
  979. <dt>example</dt>
  980. <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>
  981. <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>
  982. </code></pre>
  983. </dd>
  984. </dl>
  985. </div>
  986. <h4 class="tsd-parameters-title">Parameters</h4>
  987. <ul class="tsd-parameters">
  988. <li>
  989. <h5>appId: <span class="tsd-signature-type">string</span></h5>
  990. <div class="tsd-comment tsd-typography">
  991. <p>应用 ID,可在控制台查看</p>
  992. </div>
  993. </li>
  994. <li>
  995. <h5>appKey: <span class="tsd-signature-type">string</span></h5>
  996. <div class="tsd-comment tsd-typography">
  997. <p>应用密钥,可在控制台查看</p>
  998. </div>
  999. </li>
  1000. <li>
  1001. <h5>roomId: <span class="tsd-signature-type">string</span></h5>
  1002. <div class="tsd-comment tsd-typography">
  1003. <p>房间 ID</p>
  1004. </div>
  1005. </li>
  1006. <li>
  1007. <h5>userId: <span class="tsd-signature-type">string</span></h5>
  1008. <div class="tsd-comment tsd-typography">
  1009. <p>用户 ID</p>
  1010. </div>
  1011. </li>
  1012. </ul>
  1013. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
  1014. </li>
  1015. </ul>
  1016. </section>
  1017. <section class="tsd-panel tsd-member tsd-kind-function">
  1018. <a name="getcameras" class="tsd-anchor"></a>
  1019. <h3>get<wbr>Cameras</h3>
  1020. <ul class="tsd-signatures tsd-kind-function">
  1021. <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>
  1022. </ul>
  1023. <ul class="tsd-descriptions">
  1024. <li class="tsd-description">
  1025. <aside class="tsd-sources">
  1026. </aside>
  1027. <div class="tsd-comment tsd-typography">
  1028. <div class="lead">
  1029. <p>获取摄像头设备列表,点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
  1030. </div>
  1031. <dl class="tsd-comment-tags">
  1032. <dt>example</dt>
  1033. <dd><pre><code class="language-js"><span style="color: #795E26">getCameras</span><span style="color: #000000">()</span>
  1034. <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>
  1035. <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>
  1036. <span style="color: #000000"> })</span>
  1037. <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>
  1038. <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>
  1039. <span style="color: #000000"> });</span>
  1040. </code></pre>
  1041. </dd>
  1042. <dt>reject</dt>
  1043. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  1044. </dd>
  1045. </dl>
  1046. </div>
  1047. <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>
  1048. </li>
  1049. </ul>
  1050. </section>
  1051. <section class="tsd-panel tsd-member tsd-kind-function">
  1052. <a name="getdevices" class="tsd-anchor"></a>
  1053. <h3>get<wbr>Devices</h3>
  1054. <ul class="tsd-signatures tsd-kind-function">
  1055. <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>
  1056. </ul>
  1057. <ul class="tsd-descriptions">
  1058. <li class="tsd-description">
  1059. <aside class="tsd-sources">
  1060. </aside>
  1061. <div class="tsd-comment tsd-typography">
  1062. <div class="lead">
  1063. <p>获取音视频输入/输出设备列表,点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
  1064. </div>
  1065. <dl class="tsd-comment-tags">
  1066. <dt>example</dt>
  1067. <dd><pre><code class="language-js"><span style="color: #795E26">getDevices</span><span style="color: #000000">()</span>
  1068. <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>
  1069. <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>
  1070. <span style="color: #000000"> })</span>
  1071. <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>
  1072. <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>
  1073. <span style="color: #000000"> });</span>
  1074. </code></pre>
  1075. </dd>
  1076. <dt>reject</dt>
  1077. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  1078. </dd>
  1079. </dl>
  1080. </div>
  1081. <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>
  1082. </li>
  1083. </ul>
  1084. </section>
  1085. <section class="tsd-panel tsd-member tsd-kind-function">
  1086. <a name="getloudspeakers" class="tsd-anchor"></a>
  1087. <h3>get<wbr>Loudspeakers</h3>
  1088. <ul class="tsd-signatures tsd-kind-function">
  1089. <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>
  1090. </ul>
  1091. <ul class="tsd-descriptions">
  1092. <li class="tsd-description">
  1093. <aside class="tsd-sources">
  1094. </aside>
  1095. <div class="tsd-comment tsd-typography">
  1096. <div class="lead">
  1097. <p>获取扬声器设备列表,点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
  1098. </div>
  1099. <dl class="tsd-comment-tags">
  1100. <dt>example</dt>
  1101. <dd><pre><code class="language-js"><span style="color: #795E26">getLoudspeakers</span><span style="color: #000000">()</span>
  1102. <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>
  1103. <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>
  1104. <span style="color: #000000"> })</span>
  1105. <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>
  1106. <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>
  1107. <span style="color: #000000"> });</span>
  1108. </code></pre>
  1109. </dd>
  1110. <dt>reject</dt>
  1111. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  1112. </dd>
  1113. </dl>
  1114. </div>
  1115. <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>
  1116. </li>
  1117. </ul>
  1118. </section>
  1119. <section class="tsd-panel tsd-member tsd-kind-function">
  1120. <a name="getmicrophones" class="tsd-anchor"></a>
  1121. <h3>get<wbr>Microphones</h3>
  1122. <ul class="tsd-signatures tsd-kind-function">
  1123. <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>
  1124. </ul>
  1125. <ul class="tsd-descriptions">
  1126. <li class="tsd-description">
  1127. <aside class="tsd-sources">
  1128. </aside>
  1129. <div class="tsd-comment tsd-typography">
  1130. <div class="lead">
  1131. <p>获取麦克风设备列表,点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
  1132. </div>
  1133. <dl class="tsd-comment-tags">
  1134. <dt>example</dt>
  1135. <dd><pre><code class="language-js"><span style="color: #795E26">getMicrophones</span><span style="color: #000000">()</span>
  1136. <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>
  1137. <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>
  1138. <span style="color: #000000"> })</span>
  1139. <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>
  1140. <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>
  1141. <span style="color: #000000"> });</span>
  1142. </code></pre>
  1143. </dd>
  1144. <dt>reject</dt>
  1145. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  1146. </dd>
  1147. </dl>
  1148. </div>
  1149. <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>
  1150. </li>
  1151. </ul>
  1152. </section>
  1153. <section class="tsd-panel tsd-member tsd-kind-function">
  1154. <a name="getsupportedcodec" class="tsd-anchor"></a>
  1155. <h3>get<wbr>Supported<wbr>Codec</h3>
  1156. <ul class="tsd-signatures tsd-kind-function">
  1157. <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>
  1158. </ul>
  1159. <ul class="tsd-descriptions">
  1160. <li class="tsd-description">
  1161. <aside class="tsd-sources">
  1162. </aside>
  1163. <div class="tsd-comment tsd-typography">
  1164. <div class="lead">
  1165. <p>检测浏览器支持的音视频编解码格式</p>
  1166. </div>
  1167. <dl class="tsd-comment-tags">
  1168. <dt>example</dt>
  1169. <dd><pre><code class="language-js"><span style="color: #795E26">getSupportedCodec</span><span style="color: #000000">()</span>
  1170. <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>
  1171. <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>
  1172. <span style="color: #000000"> })</span>
  1173. <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>
  1174. <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>
  1175. <span style="color: #000000"> });</span>
  1176. </code></pre>
  1177. </dd>
  1178. </dl>
  1179. </div>
  1180. <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>
  1181. </li>
  1182. </ul>
  1183. </section>
  1184. <section class="tsd-panel tsd-member tsd-kind-function">
  1185. <a name="issupportscreenshare" class="tsd-anchor"></a>
  1186. <h3>is<wbr>Support<wbr>Screen<wbr>Share</h3>
  1187. <ul class="tsd-signatures tsd-kind-function">
  1188. <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>
  1189. </ul>
  1190. <ul class="tsd-descriptions">
  1191. <li class="tsd-description">
  1192. <aside class="tsd-sources">
  1193. </aside>
  1194. <div class="tsd-comment tsd-typography">
  1195. <div class="lead">
  1196. <p>检测浏览器是否支持屏幕共享</p>
  1197. </div>
  1198. <dl class="tsd-comment-tags">
  1199. <dt>example</dt>
  1200. <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>
  1201. <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>
  1202. <span style="color: #000000">}</span>
  1203. </code></pre>
  1204. </dd>
  1205. </dl>
  1206. </div>
  1207. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  1208. </li>
  1209. </ul>
  1210. </section>
  1211. <section class="tsd-panel tsd-member tsd-kind-function">
  1212. <a name="issupportwebrtc" class="tsd-anchor"></a>
  1213. <h3>is<wbr>Support<wbr>WebRTC</h3>
  1214. <ul class="tsd-signatures tsd-kind-function">
  1215. <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>
  1216. </ul>
  1217. <ul class="tsd-descriptions">
  1218. <li class="tsd-description">
  1219. <aside class="tsd-sources">
  1220. </aside>
  1221. <div class="tsd-comment tsd-typography">
  1222. <div class="lead">
  1223. <p>检测浏览器是否完全(可访问本地音视频设备)支持 WebRTC。</p>
  1224. </div>
  1225. <dl class="tsd-comment-tags">
  1226. <dt>example</dt>
  1227. <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>
  1228. <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>
  1229. <span style="color: #000000">}</span>
  1230. </code></pre>
  1231. </dd>
  1232. </dl>
  1233. </div>
  1234. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  1235. </li>
  1236. </ul>
  1237. </section>
  1238. <section class="tsd-panel tsd-member tsd-kind-function">
  1239. <a name="setloglevel" class="tsd-anchor"></a>
  1240. <h3>set<wbr>Log<wbr>Level</h3>
  1241. <ul class="tsd-signatures tsd-kind-function">
  1242. <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>
  1243. </ul>
  1244. <ul class="tsd-descriptions">
  1245. <li class="tsd-description">
  1246. <aside class="tsd-sources">
  1247. </aside>
  1248. <div class="tsd-comment tsd-typography">
  1249. <div class="lead">
  1250. <p>设置日志打印级别,用于打印出更多日志来调试或定位问题,默认 warn 级别</p>
  1251. </div>
  1252. <dl class="tsd-comment-tags">
  1253. <dt>example</dt>
  1254. <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>
  1255. </code></pre>
  1256. </dd>
  1257. </dl>
  1258. </div>
  1259. <h4 class="tsd-parameters-title">Parameters</h4>
  1260. <ul class="tsd-parameters">
  1261. <li>
  1262. <h5>level: <span class="tsd-signature-type">LogLevel</span></h5>
  1263. <div class="tsd-comment tsd-typography">
  1264. <p>日志级别,有 &#39;debug&#39;, &#39;info&#39;, &#39;warn&#39;, &#39;error&#39; 级别;</p>
  1265. </div>
  1266. </li>
  1267. </ul>
  1268. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1269. </li>
  1270. </ul>
  1271. </section>
  1272. <section class="tsd-panel tsd-member tsd-kind-function">
  1273. <a name="setservers" class="tsd-anchor"></a>
  1274. <h3>set<wbr>Servers</h3>
  1275. <ul class="tsd-signatures tsd-kind-function">
  1276. <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>
  1277. </ul>
  1278. <ul class="tsd-descriptions">
  1279. <li class="tsd-description">
  1280. <aside class="tsd-sources">
  1281. </aside>
  1282. <div class="tsd-comment tsd-typography">
  1283. <div class="lead">
  1284. <p>用于私有化部署时,指定部署的服务器地址</p>
  1285. </div>
  1286. <dl class="tsd-comment-tags">
  1287. <dt>example</dt>
  1288. <dd><pre><code class="language-js"><span style="color: #795E26">setServers</span><span style="color: #000000">({</span>
  1289. <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>
  1290. <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>
  1291. <span style="color: #000000">});</span>
  1292. </code></pre>
  1293. <p><strong>特别地,单信令服务器时,不需要网关进行分配信令服务器,可以直接指定信令服务器</strong></p>
  1294. <pre><code class="language-js"><span style="color: #795E26">setServers</span><span style="color: #000000">({</span>
  1295. <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>
  1296. <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>
  1297. <span style="color: #000000">});</span>
  1298. </code></pre>
  1299. </dd>
  1300. <dt>throws</dt>
  1301. <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
  1302. </dd>
  1303. </dl>
  1304. </div>
  1305. <h4 class="tsd-parameters-title">Parameters</h4>
  1306. <ul class="tsd-parameters">
  1307. <li>
  1308. <h5>conf: <a href="interfaces/serverconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerConfig</a></h5>
  1309. <div class="tsd-comment tsd-typography">
  1310. <p>服务器配置,具体描述参见 ServerConfig 的说明</p>
  1311. </div>
  1312. </li>
  1313. </ul>
  1314. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1315. </li>
  1316. </ul>
  1317. </section>
  1318. </section>
  1319. </div>
  1320. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  1321. <nav class="tsd-navigation primary">
  1322. <ul>
  1323. <li class="current ">
  1324. <a href="index.html">Exports</a>
  1325. </li>
  1326. </ul>
  1327. </nav>
  1328. <nav class="tsd-navigation secondary menu-sticky">
  1329. <ul class="before-current">
  1330. <li class=" tsd-kind-class">
  1331. <a href="classes/client.html" class="tsd-kind-icon">Client</a>
  1332. </li>
  1333. <li class=" tsd-kind-class">
  1334. <a href="classes/localstream.html" class="tsd-kind-icon">Local<wbr>Stream</a>
  1335. </li>
  1336. <li class=" tsd-kind-class">
  1337. <a href="classes/remotestream.html" class="tsd-kind-icon">Remote<wbr>Stream</a>
  1338. </li>
  1339. <li class=" tsd-kind-class">
  1340. <a href="classes/rtcerror.html" class="tsd-kind-icon">Rtc<wbr>Error</a>
  1341. </li>
  1342. <li class=" tsd-kind-class">
  1343. <a href="classes/stream.html" class="tsd-kind-icon">Stream</a>
  1344. </li>
  1345. <li class=" tsd-kind-class">
  1346. <a href="classes/user.html" class="tsd-kind-icon">User</a>
  1347. </li>
  1348. <li class=" tsd-kind-interface">
  1349. <a href="interfaces/audiostats.html" class="tsd-kind-icon">Audio<wbr>Stats</a>
  1350. </li>
  1351. <li class=" tsd-kind-interface">
  1352. <a href="interfaces/clientoptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
  1353. </li>
  1354. <li class=" tsd-kind-interface">
  1355. <a href="interfaces/clientplugin.html" class="tsd-kind-icon">Client<wbr>Plugin</a>
  1356. </li>
  1357. <li class=" tsd-kind-interface">
  1358. <a href="interfaces/codecs.html" class="tsd-kind-icon">Codecs</a>
  1359. </li>
  1360. <li class=" tsd-kind-interface">
  1361. <a href="interfaces/connectionstates.html" class="tsd-kind-icon">Connection<wbr>States</a>
  1362. </li>
  1363. <li class=" tsd-kind-interface">
  1364. <a href="interfaces/devicedetectionoptions.html" class="tsd-kind-icon">Device<wbr>Detection<wbr>Options</a>
  1365. </li>
  1366. <li class=" tsd-kind-interface">
  1367. <a href="interfaces/joinoptions.html" class="tsd-kind-icon">Join<wbr>Options</a>
  1368. </li>
  1369. <li class=" tsd-kind-interface">
  1370. <a href="interfaces/localstreamoptions.html" class="tsd-kind-icon">Local<wbr>Stream<wbr>Options</a>
  1371. </li>
  1372. <li class=" tsd-kind-interface">
  1373. <a href="interfaces/networkqualities.html" class="tsd-kind-icon">Network<wbr>Qualities</a>
  1374. </li>
  1375. <li class=" tsd-kind-interface">
  1376. <a href="interfaces/networkstats.html" class="tsd-kind-icon">Network<wbr>Stats</a>
  1377. </li>
  1378. <li class=" tsd-kind-interface">
  1379. <a href="interfaces/playoptions.html" class="tsd-kind-icon">Play<wbr>Options</a>
  1380. </li>
  1381. <li class=" tsd-kind-interface tsd-has-type-parameter">
  1382. <a href="interfaces/rtcevent.html" class="tsd-kind-icon">Rtc<wbr>Event</a>
  1383. </li>
  1384. <li class=" tsd-kind-interface">
  1385. <a href="interfaces/serverconfig.html" class="tsd-kind-icon">Server<wbr>Config</a>
  1386. </li>
  1387. <li class=" tsd-kind-interface">
  1388. <a href="interfaces/snapshotoptions.html" class="tsd-kind-icon">Snapshot<wbr>Options</a>
  1389. </li>
  1390. <li class=" tsd-kind-interface">
  1391. <a href="interfaces/streamplugin.html" class="tsd-kind-icon">Stream<wbr>Plugin</a>
  1392. </li>
  1393. <li class=" tsd-kind-interface">
  1394. <a href="interfaces/streamstats.html" class="tsd-kind-icon">Stream<wbr>Stats</a>
  1395. </li>
  1396. <li class=" tsd-kind-interface">
  1397. <a href="interfaces/videostats.html" class="tsd-kind-icon">Video<wbr>Stats</a>
  1398. </li>
  1399. <li class=" tsd-kind-type-alias">
  1400. <a href="index.html#audiocodec" class="tsd-kind-icon">Audio<wbr>Codec</a>
  1401. </li>
  1402. <li class=" tsd-kind-type-alias">
  1403. <a href="index.html#connectionstate" class="tsd-kind-icon">Connection<wbr>State</a>
  1404. </li>
  1405. <li class=" tsd-kind-type-alias">
  1406. <a href="index.html#errorcode" class="tsd-kind-icon">Error<wbr>Code</a>
  1407. </li>
  1408. <li class=" tsd-kind-type-alias">
  1409. <a href="index.html#facingmode" class="tsd-kind-icon">Facing<wbr>Mode</a>
  1410. </li>
  1411. <li class=" tsd-kind-type-alias">
  1412. <a href="index.html#mediatype" class="tsd-kind-icon">Media<wbr>Type</a>
  1413. </li>
  1414. <li class=" tsd-kind-type-alias">
  1415. <a href="index.html#networkquality" class="tsd-kind-icon">Network<wbr>Quality</a>
  1416. </li>
  1417. <li class=" tsd-kind-type-alias">
  1418. <a href="index.html#playcontrolstype" class="tsd-kind-icon">Play<wbr>Controls<wbr>Type</a>
  1419. </li>
  1420. <li class=" tsd-kind-type-alias">
  1421. <a href="index.html#playervideofittype" class="tsd-kind-icon">Player<wbr>Video<wbr>Fit<wbr>Type</a>
  1422. </li>
  1423. <li class=" tsd-kind-type-alias">
  1424. <a href="index.html#roletype" class="tsd-kind-icon">Role<wbr>Type</a>
  1425. </li>
  1426. <li class=" tsd-kind-type-alias">
  1427. <a href="index.html#roomtype" class="tsd-kind-icon">Room<wbr>Type</a>
  1428. </li>
  1429. <li class=" tsd-kind-type-alias">
  1430. <a href="index.html#rtcconnectionevent" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>Event</a>
  1431. </li>
  1432. <li class=" tsd-kind-type-alias">
  1433. <a href="index.html#rtcconnectioneventtype" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>Event<wbr>Type</a>
  1434. </li>
  1435. <li class=" tsd-kind-type-alias">
  1436. <a href="index.html#rtceventtype" class="tsd-kind-icon">Rtc<wbr>Event<wbr>Type</a>
  1437. </li>
  1438. <li class=" tsd-kind-type-alias">
  1439. <a href="index.html#rtcplayerevent" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event</a>
  1440. </li>
  1441. <li class=" tsd-kind-type-alias">
  1442. <a href="index.html#rtcplayereventtype" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event<wbr>Type</a>
  1443. </li>
  1444. <li class=" tsd-kind-type-alias">
  1445. <a href="index.html#rtcstreamevent" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event</a>
  1446. </li>
  1447. <li class=" tsd-kind-type-alias">
  1448. <a href="index.html#rtcstreameventtype" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event<wbr>Type</a>
  1449. </li>
  1450. <li class=" tsd-kind-type-alias">
  1451. <a href="index.html#rtcuserevent" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event</a>
  1452. </li>
  1453. <li class=" tsd-kind-type-alias">
  1454. <a href="index.html#rtcusereventtype" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event<wbr>Type</a>
  1455. </li>
  1456. <li class=" tsd-kind-type-alias">
  1457. <a href="index.html#screenprofile" class="tsd-kind-icon">Screen<wbr>Profile</a>
  1458. </li>
  1459. <li class=" tsd-kind-type-alias">
  1460. <a href="index.html#switchdevicetype" class="tsd-kind-icon">Switch<wbr>Device<wbr>Type</a>
  1461. </li>
  1462. <li class=" tsd-kind-type-alias">
  1463. <a href="index.html#videocodec" class="tsd-kind-icon">Video<wbr>Codec</a>
  1464. </li>
  1465. <li class=" tsd-kind-type-alias">
  1466. <a href="index.html#videoprofile" class="tsd-kind-icon">Video<wbr>Profile</a>
  1467. </li>
  1468. <li class=" tsd-kind-variable">
  1469. <a href="index.html#version" class="tsd-kind-icon">version</a>
  1470. </li>
  1471. <li class=" tsd-kind-function">
  1472. <a href="index.html#createclient" class="tsd-kind-icon">create<wbr>Client</a>
  1473. </li>
  1474. <li class=" tsd-kind-function">
  1475. <a href="index.html#createstream" class="tsd-kind-icon">create<wbr>Stream</a>
  1476. </li>
  1477. <li class=" tsd-kind-function">
  1478. <a href="index.html#devicedetection" class="tsd-kind-icon">device<wbr>Detection</a>
  1479. </li>
  1480. <li class=" tsd-kind-function">
  1481. <a href="index.html#disableuploadlog" class="tsd-kind-icon">disable<wbr>Upload<wbr>Log</a>
  1482. </li>
  1483. <li class=" tsd-kind-function">
  1484. <a href="index.html#enableuploadlog" class="tsd-kind-icon">enable<wbr>Upload<wbr>Log</a>
  1485. </li>
  1486. <li class=" tsd-kind-function">
  1487. <a href="index.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a>
  1488. </li>
  1489. <li class=" tsd-kind-function">
  1490. <a href="index.html#getcameras" class="tsd-kind-icon">get<wbr>Cameras</a>
  1491. </li>
  1492. <li class=" tsd-kind-function">
  1493. <a href="index.html#getdevices" class="tsd-kind-icon">get<wbr>Devices</a>
  1494. </li>
  1495. <li class=" tsd-kind-function">
  1496. <a href="index.html#getloudspeakers" class="tsd-kind-icon">get<wbr>Loudspeakers</a>
  1497. </li>
  1498. <li class=" tsd-kind-function">
  1499. <a href="index.html#getmicrophones" class="tsd-kind-icon">get<wbr>Microphones</a>
  1500. </li>
  1501. <li class=" tsd-kind-function">
  1502. <a href="index.html#getsupportedcodec" class="tsd-kind-icon">get<wbr>Supported<wbr>Codec</a>
  1503. </li>
  1504. <li class=" tsd-kind-function">
  1505. <a href="index.html#issupportscreenshare" class="tsd-kind-icon">is<wbr>Support<wbr>Screen<wbr>Share</a>
  1506. </li>
  1507. <li class=" tsd-kind-function">
  1508. <a href="index.html#issupportwebrtc" class="tsd-kind-icon">is<wbr>Support<wbr>WebRTC</a>
  1509. </li>
  1510. <li class=" tsd-kind-function">
  1511. <a href="index.html#setloglevel" class="tsd-kind-icon">set<wbr>Log<wbr>Level</a>
  1512. </li>
  1513. <li class=" tsd-kind-function">
  1514. <a href="index.html#setservers" class="tsd-kind-icon">set<wbr>Servers</a>
  1515. </li>
  1516. </ul>
  1517. </nav>
  1518. </div>
  1519. </div>
  1520. </div>
  1521. <footer class="with-border-bottom">
  1522. <div class="container">
  1523. <h2>Legend</h2>
  1524. <div class="tsd-legend-group">
  1525. <ul class="tsd-legend">
  1526. <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
  1527. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  1528. </ul>
  1529. <ul class="tsd-legend">
  1530. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  1531. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  1532. </ul>
  1533. <ul class="tsd-legend">
  1534. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
  1535. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
  1536. </ul>
  1537. <ul class="tsd-legend">
  1538. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  1539. </ul>
  1540. </div>
  1541. </div>
  1542. </footer>
  1543. <div class="container tsd-generator">
  1544. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  1545. </div>
  1546. <div class="overlay"></div>
  1547. <script src="assets/js/main.js"></script>
  1548. </body>
  1549. </html>