localstream.html 89 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267
  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>LocalStream | @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. <ul class="tsd-breadcrumb">
  54. <li>
  55. <a href="../index.html">@urtc/sdk-web</a>
  56. </li>
  57. <li>
  58. <a href="localstream.html">LocalStream</a>
  59. </li>
  60. </ul>
  61. <h1>Class LocalStream</h1>
  62. </div>
  63. </div>
  64. </header>
  65. <div class="container container-main">
  66. <div class="row">
  67. <div class="col-8 col-content">
  68. <section class="tsd-panel tsd-comment">
  69. <div class="tsd-comment tsd-typography">
  70. <div class="lead">
  71. <p>本地流,可用于本地预览,也可用 client 进行发布</p>
  72. </div>
  73. </div>
  74. </section>
  75. <section class="tsd-panel tsd-hierarchy">
  76. <h3>Hierarchy</h3>
  77. <ul class="tsd-hierarchy">
  78. <li>
  79. <a href="stream.html" class="tsd-signature-type" data-tsd-kind="Class">Stream</a>
  80. <ul class="tsd-hierarchy">
  81. <li>
  82. <span class="target">LocalStream</span>
  83. </li>
  84. </ul>
  85. </li>
  86. </ul>
  87. </section>
  88. <section class="tsd-panel-group tsd-index-group">
  89. <h2>Index</h2>
  90. <section class="tsd-panel tsd-index-panel">
  91. <div class="tsd-index-content">
  92. <section class="tsd-index-section tsd-is-inherited">
  93. <h3>Properties</h3>
  94. <ul class="tsd-index-list">
  95. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#audiomuted" class="tsd-kind-icon">audio<wbr>Muted</a></li>
  96. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#id" class="tsd-kind-icon">id</a></li>
  97. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#mediastream" class="tsd-kind-icon">media<wbr>Stream</a></li>
  98. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#userid" class="tsd-kind-icon">user<wbr>Id</a></li>
  99. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#videomuted" class="tsd-kind-icon">video<wbr>Muted</a></li>
  100. </ul>
  101. </section>
  102. <section class="tsd-index-section ">
  103. <h3>Methods</h3>
  104. <ul class="tsd-index-list">
  105. <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#addtrack" class="tsd-kind-icon">add<wbr>Track</a></li>
  106. <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#destroy" class="tsd-kind-icon">destroy</a></li>
  107. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#getaudiolevel" class="tsd-kind-icon">get<wbr>Audio<wbr>Level</a></li>
  108. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#getmediatype" class="tsd-kind-icon">get<wbr>Media<wbr>Type</a></li>
  109. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#getstats" class="tsd-kind-icon">get<wbr>Stats</a></li>
  110. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="localstream.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a></li>
  111. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="localstream.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a></li>
  112. <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#init" class="tsd-kind-icon">init</a></li>
  113. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#muteaudio" class="tsd-kind-icon">mute<wbr>Audio</a></li>
  114. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#mutevideo" class="tsd-kind-icon">mute<wbr>Video</a></li>
  115. <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="localstream.html#off" class="tsd-kind-icon">off</a></li>
  116. <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="localstream.html#on" class="tsd-kind-icon">on</a></li>
  117. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#play" class="tsd-kind-icon">play</a></li>
  118. <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#removetrack" class="tsd-kind-icon">remove<wbr>Track</a></li>
  119. <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#replacetrack" class="tsd-kind-icon">replace<wbr>Track</a></li>
  120. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#resume" class="tsd-kind-icon">resume</a></li>
  121. <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#setaudiolevel" class="tsd-kind-icon">set<wbr>Audio<wbr>Level</a></li>
  122. <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#setscreenprofile" class="tsd-kind-icon">set<wbr>Screen<wbr>Profile</a></li>
  123. <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#setvideoprofile" class="tsd-kind-icon">set<wbr>Video<wbr>Profile</a></li>
  124. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#snapshot" class="tsd-kind-icon">snapshot</a></li>
  125. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#stop" class="tsd-kind-icon">stop</a></li>
  126. <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#switchdevice" class="tsd-kind-icon">switch<wbr>Device</a></li>
  127. <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#switchimage" class="tsd-kind-icon">switch<wbr>Image</a></li>
  128. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#unmuteaudio" class="tsd-kind-icon">unmute<wbr>Audio</a></li>
  129. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#unmutevideo" class="tsd-kind-icon">unmute<wbr>Video</a></li>
  130. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="localstream.html#use" class="tsd-kind-icon">use</a></li>
  131. </ul>
  132. </section>
  133. </div>
  134. </section>
  135. </section>
  136. <section class="tsd-panel-group tsd-member-group tsd-is-inherited">
  137. <h2>Properties</h2>
  138. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  139. <a name="audiomuted" class="tsd-anchor"></a>
  140. <h3>audio<wbr>Muted</h3>
  141. <div class="tsd-signature tsd-kind-icon">audio<wbr>Muted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
  142. <aside class="tsd-sources">
  143. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#audiomuted">audioMuted</a></p>
  144. </aside>
  145. <div class="tsd-comment tsd-typography">
  146. <div class="lead">
  147. <p>当前流是否 mute 了音频</p>
  148. </div>
  149. </div>
  150. </section>
  151. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  152. <a name="id" class="tsd-anchor"></a>
  153. <h3>id</h3>
  154. <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  155. <aside class="tsd-sources">
  156. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#id">id</a></p>
  157. </aside>
  158. <div class="tsd-comment tsd-typography">
  159. <div class="lead">
  160. <p>当前流ID</p>
  161. </div>
  162. </div>
  163. </section>
  164. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  165. <a name="mediastream" class="tsd-anchor"></a>
  166. <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> media<wbr>Stream</h3>
  167. <div class="tsd-signature tsd-kind-icon">media<wbr>Stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MediaStream</span></div>
  168. <aside class="tsd-sources">
  169. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#mediastream">mediaStream</a></p>
  170. </aside>
  171. <div class="tsd-comment tsd-typography">
  172. <div class="lead">
  173. <p>当前流包含的媒体流,关于媒体流,请详见 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaStream">MediaStream</a>。</p>
  174. </div>
  175. </div>
  176. </section>
  177. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  178. <a name="userid" class="tsd-anchor"></a>
  179. <h3>user<wbr>Id</h3>
  180. <div class="tsd-signature tsd-kind-icon">user<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  181. <aside class="tsd-sources">
  182. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#userid">userId</a></p>
  183. </aside>
  184. <div class="tsd-comment tsd-typography">
  185. <div class="lead">
  186. <p>当前流所属用户的ID
  187. 注:若创建本地流时指定的 userId 与 join 时指定的 userId 不同,那么发布本条流时,流的 userId 将会自动被自动更新为 join 时指定的 userId</p>
  188. </div>
  189. </div>
  190. </section>
  191. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  192. <a name="videomuted" class="tsd-anchor"></a>
  193. <h3>video<wbr>Muted</h3>
  194. <div class="tsd-signature tsd-kind-icon">video<wbr>Muted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
  195. <aside class="tsd-sources">
  196. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#videomuted">videoMuted</a></p>
  197. </aside>
  198. <div class="tsd-comment tsd-typography">
  199. <div class="lead">
  200. <p>当前流是否 mute 了视频</p>
  201. </div>
  202. </div>
  203. </section>
  204. </section>
  205. <section class="tsd-panel-group tsd-member-group ">
  206. <h2>Methods</h2>
  207. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  208. <a name="addtrack" class="tsd-anchor"></a>
  209. <h3>add<wbr>Track</h3>
  210. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  211. <li class="tsd-signature tsd-kind-icon">add<wbr>Track<span class="tsd-signature-symbol">(</span>track<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  212. </ul>
  213. <ul class="tsd-descriptions">
  214. <li class="tsd-description">
  215. <aside class="tsd-sources">
  216. </aside>
  217. <div class="tsd-comment tsd-typography">
  218. <div class="lead">
  219. <p>添加一条媒体轨道(音轨或视轨)到当前流</p>
  220. <blockquote>
  221. <p>注:</p>
  222. <ol>
  223. <li>若创建本地流时,audio 为 false,不可添加音轨,video 为 false 时,不可添加视轨</li>
  224. </ol>
  225. </blockquote>
  226. </div>
  227. <dl class="tsd-comment-tags">
  228. <dt>example</dt>
  229. <dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">addTrack</span><span style="color: #000000">(</span><span style="color: #001080">track</span><span style="color: #000000">);</span>
  230. </code></pre>
  231. </dd>
  232. </dl>
  233. </div>
  234. <h4 class="tsd-parameters-title">Parameters</h4>
  235. <ul class="tsd-parameters">
  236. <li>
  237. <h5>track: <span class="tsd-signature-type">MediaStreamTrack</span></h5>
  238. <div class="tsd-comment tsd-typography">
  239. <p>媒体轨道</p>
  240. </div>
  241. </li>
  242. </ul>
  243. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  244. </li>
  245. </ul>
  246. </section>
  247. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  248. <a name="destroy" class="tsd-anchor"></a>
  249. <h3>destroy</h3>
  250. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  251. <li class="tsd-signature tsd-kind-icon">destroy<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>
  252. </ul>
  253. <ul class="tsd-descriptions">
  254. <li class="tsd-description">
  255. <aside class="tsd-sources">
  256. </aside>
  257. <div class="tsd-comment tsd-typography">
  258. <div class="lead">
  259. <p>销毁当前流,一般在本地流不再被使用时,可调用此方法销毁,解除摄像头或麦克风设备的占用。</p>
  260. </div>
  261. <dl class="tsd-comment-tags">
  262. <dt>example</dt>
  263. <dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">destroy</span><span style="color: #000000">();</span>
  264. </code></pre>
  265. </dd>
  266. </dl>
  267. </div>
  268. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  269. </li>
  270. </ul>
  271. </section>
  272. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  273. <a name="getaudiolevel" class="tsd-anchor"></a>
  274. <h3>get<wbr>Audio<wbr>Level</h3>
  275. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  276. <li class="tsd-signature tsd-kind-icon">get<wbr>Audio<wbr>Level<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
  277. </ul>
  278. <ul class="tsd-descriptions">
  279. <li class="tsd-description">
  280. <aside class="tsd-sources">
  281. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#getaudiolevel">getAudioLevel</a></p>
  282. </aside>
  283. <div class="tsd-comment tsd-typography">
  284. <div class="lead">
  285. <p>获取当前流的音量大小,只有当本地流或远端流中有音频数据才有效。</p>
  286. </div>
  287. <dl class="tsd-comment-tags">
  288. <dt>example</dt>
  289. <dd><pre><code class="language-js"><span style="color: #795E26">setInterval</span><span style="color: #000000">(() </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
  290. <span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">level</span><span style="color: #000000"> = </span><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">getAudioLevel</span><span style="color: #000000">();</span>
  291. <span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">level</span><span style="color: #000000"> &gt; </span><span style="color: #098658">0</span><span style="color: #000000">) {</span>
  292. <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">`user </span><span style="color: #0000FF">${</span><span style="color: #001080">stream</span><span style="color: #000000FF">.</span><span style="color: #001080">userId</span><span style="color: #0000FF">}</span><span style="color: #A31515"> is speaking`</span><span style="color: #000000">);</span>
  293. <span style="color: #000000"> }</span>
  294. <span style="color: #000000">}, </span><span style="color: #098658">200</span><span style="color: #000000">);</span>
  295. </code></pre>
  296. </dd>
  297. </dl>
  298. </div>
  299. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
  300. </li>
  301. </ul>
  302. </section>
  303. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  304. <a name="getmediatype" class="tsd-anchor"></a>
  305. <h3>get<wbr>Media<wbr>Type</h3>
  306. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  307. <li class="tsd-signature tsd-kind-icon">get<wbr>Media<wbr>Type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#mediatype" class="tsd-signature-type" data-tsd-kind="Type alias">MediaType</a></li>
  308. </ul>
  309. <ul class="tsd-descriptions">
  310. <li class="tsd-description">
  311. <aside class="tsd-sources">
  312. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#getmediatype">getMediaType</a></p>
  313. </aside>
  314. <div class="tsd-comment tsd-typography">
  315. <div class="lead">
  316. <p>获取流的媒体类型</p>
  317. </div>
  318. <dl class="tsd-comment-tags">
  319. <dt>example</dt>
  320. <dd><pre><code class="language-js"><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: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">getMediaType</span><span style="color: #000000">();</span>
  321. </code></pre>
  322. </dd>
  323. </dl>
  324. </div>
  325. <h4 class="tsd-returns-title">Returns <a href="../index.html#mediatype" class="tsd-signature-type" data-tsd-kind="Type alias">MediaType</a></h4>
  326. </li>
  327. </ul>
  328. </section>
  329. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  330. <a name="getstats" class="tsd-anchor"></a>
  331. <h3>get<wbr>Stats</h3>
  332. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  333. <li class="tsd-signature tsd-kind-icon">get<wbr>Stats<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/streamstats.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamStats</a><span class="tsd-signature-symbol">&gt;</span></li>
  334. </ul>
  335. <ul class="tsd-descriptions">
  336. <li class="tsd-description">
  337. <aside class="tsd-sources">
  338. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#getstats">getStats</a></p>
  339. </aside>
  340. <div class="tsd-comment tsd-typography">
  341. <div class="lead">
  342. <p>获取流发布或订阅后的统计数据</p>
  343. </div>
  344. <dl class="tsd-comment-tags">
  345. <dt>example</dt>
  346. <dd><pre><code class="language-js"><span style="color: #001080">stream</span>
  347. <span style="color: #000000"> .</span><span style="color: #795E26">getStats</span><span style="color: #000000">()</span>
  348. <span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">((</span><span style="color: #001080">stats</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
  349. <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><span style="color: #001080">stats</span><span style="color: #000000">);</span>
  350. <span style="color: #000000"> });</span>
  351. </code></pre>
  352. </dd>
  353. </dl>
  354. </div>
  355. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/streamstats.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamStats</a><span class="tsd-signature-symbol">&gt;</span></h4>
  356. </li>
  357. </ul>
  358. </section>
  359. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
  360. <a name="hasaudio" class="tsd-anchor"></a>
  361. <h3>has<wbr>Audio</h3>
  362. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
  363. <li class="tsd-signature tsd-kind-icon">has<wbr>Audio<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>
  364. </ul>
  365. <ul class="tsd-descriptions">
  366. <li class="tsd-description">
  367. <aside class="tsd-sources">
  368. <p>Overrides <a href="stream.html">Stream</a>.<a href="stream.html#hasaudio">hasAudio</a></p>
  369. </aside>
  370. <div class="tsd-comment tsd-typography">
  371. <div class="lead">
  372. <p>判断当前流是否有音频</p>
  373. </div>
  374. <dl class="tsd-comment-tags">
  375. <dt>example</dt>
  376. <dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">result</span><span style="color: #000000"> = </span><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">hasAudio</span><span style="color: #000000">();</span>
  377. </code></pre>
  378. </dd>
  379. </dl>
  380. </div>
  381. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  382. </li>
  383. </ul>
  384. </section>
  385. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
  386. <a name="hasvideo" class="tsd-anchor"></a>
  387. <h3>has<wbr>Video</h3>
  388. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
  389. <li class="tsd-signature tsd-kind-icon">has<wbr>Video<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>
  390. </ul>
  391. <ul class="tsd-descriptions">
  392. <li class="tsd-description">
  393. <aside class="tsd-sources">
  394. <p>Overrides <a href="stream.html">Stream</a>.<a href="stream.html#hasvideo">hasVideo</a></p>
  395. </aside>
  396. <div class="tsd-comment tsd-typography">
  397. <div class="lead">
  398. <p>判断当前流是否有视频</p>
  399. </div>
  400. <dl class="tsd-comment-tags">
  401. <dt>example</dt>
  402. <dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">result</span><span style="color: #000000"> = </span><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">hasVideo</span><span style="color: #000000">();</span>
  403. </code></pre>
  404. </dd>
  405. </dl>
  406. </div>
  407. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  408. </li>
  409. </ul>
  410. </section>
  411. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  412. <a name="init" class="tsd-anchor"></a>
  413. <h3>init</h3>
  414. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  415. <li class="tsd-signature tsd-kind-icon">init<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">void</span><span class="tsd-signature-symbol">&gt;</span></li>
  416. </ul>
  417. <ul class="tsd-descriptions">
  418. <li class="tsd-description">
  419. <aside class="tsd-sources">
  420. </aside>
  421. <div class="tsd-comment tsd-typography">
  422. <div class="lead">
  423. <p>初始化本地流对象,将读取麦克风、摄像头、屏幕共享等来初始化媒体流</p>
  424. </div>
  425. <dl class="tsd-comment-tags">
  426. <dt>example</dt>
  427. <dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">stream</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>
  428. <span style="color: #001080">stream</span>
  429. <span style="color: #000000"> .</span><span style="color: #795E26">init</span><span style="color: #000000">()</span>
  430. <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>
  431. <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">stream</span><span style="color: #000000">); </span><span style="color: #008000">// 发布本地流</span>
  432. <span style="color: #000000"> })</span>
  433. <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>
  434. <span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`初始化本地流失败 </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>
  435. <span style="color: #000000"> })</span>
  436. </code></pre>
  437. </dd>
  438. </dl>
  439. </div>
  440. <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>
  441. </li>
  442. </ul>
  443. </section>
  444. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  445. <a name="muteaudio" class="tsd-anchor"></a>
  446. <h3>mute<wbr>Audio</h3>
  447. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  448. <li class="tsd-signature tsd-kind-icon">mute<wbr>Audio<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>
  449. </ul>
  450. <ul class="tsd-descriptions">
  451. <li class="tsd-description">
  452. <aside class="tsd-sources">
  453. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#muteaudio">muteAudio</a></p>
  454. </aside>
  455. <div class="tsd-comment tsd-typography">
  456. <div class="lead">
  457. <p>mute 当前流的音频</p>
  458. <ul>
  459. <li>本地流调用此方法时,将不向服务器推送音频数据,远端用户将收到 <code>mute-audio</code> 的事件通知</li>
  460. <li>远端流调用此方法时,仅为不从服务器拉取音频数据,并无事件通知远端用户</li>
  461. </ul>
  462. </div>
  463. <dl class="tsd-comment-tags">
  464. <dt>example</dt>
  465. <dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">result</span><span style="color: #000000"> = </span><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">muteAudio</span><span style="color: #000000">();</span>
  466. <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 audio is muted </span><span style="color: #0000FF">${</span><span style="color: #001080">stream</span><span style="color: #000000FF">.</span><span style="color: #001080">audioMuted</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
  467. </code></pre>
  468. </dd>
  469. </dl>
  470. </div>
  471. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  472. <p>操作是否成功</p>
  473. </li>
  474. </ul>
  475. </section>
  476. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  477. <a name="mutevideo" class="tsd-anchor"></a>
  478. <h3>mute<wbr>Video</h3>
  479. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  480. <li class="tsd-signature tsd-kind-icon">mute<wbr>Video<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>
  481. </ul>
  482. <ul class="tsd-descriptions">
  483. <li class="tsd-description">
  484. <aside class="tsd-sources">
  485. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#mutevideo">muteVideo</a></p>
  486. </aside>
  487. <div class="tsd-comment tsd-typography">
  488. <div class="lead">
  489. <p>mute 当前流的视频</p>
  490. <ul>
  491. <li>本地流调用此方法时,将不向服务器推送视频数据,远端用户将收到 <code>mute-video</code> 的事件通知</li>
  492. <li>远端流调用此方法时,仅为不从服务器拉取视频数据,并无事件通知远端用户</li>
  493. </ul>
  494. </div>
  495. <dl class="tsd-comment-tags">
  496. <dt>example</dt>
  497. <dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">result</span><span style="color: #000000"> = </span><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">muteVideo</span><span style="color: #000000">();</span>
  498. <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 video is muted </span><span style="color: #0000FF">${</span><span style="color: #001080">stream</span><span style="color: #000000FF">.</span><span style="color: #001080">videoMuted</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
  499. </code></pre>
  500. </dd>
  501. </dl>
  502. </div>
  503. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  504. <p>操作是否成功</p>
  505. </li>
  506. </ul>
  507. </section>
  508. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
  509. <a name="off" class="tsd-anchor"></a>
  510. <h3>off</h3>
  511. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
  512. <li class="tsd-signature tsd-kind-icon">off&lt;T&gt;<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Listener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span></li>
  513. </ul>
  514. <ul class="tsd-descriptions">
  515. <li class="tsd-description">
  516. <aside class="tsd-sources">
  517. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#off">off</a></p>
  518. </aside>
  519. <div class="tsd-comment tsd-typography">
  520. <div class="lead">
  521. <p>取消监听流对象事件</p>
  522. </div>
  523. </div>
  524. <h4 class="tsd-type-parameters-title">Type parameters</h4>
  525. <ul class="tsd-type-parameters">
  526. <li>
  527. <h4>T<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><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><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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;player-status-change&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;*&quot;</span></h4>
  528. </li>
  529. </ul>
  530. <h4 class="tsd-parameters-title">Parameters</h4>
  531. <ul class="tsd-parameters">
  532. <li>
  533. <h5>type: <span class="tsd-signature-type">T</span></h5>
  534. <div class="tsd-comment tsd-typography">
  535. <p>流对象事件类型,特别的,当为 &#39;*&#39; 时,取消监听所有事件</p>
  536. </div>
  537. </li>
  538. <li>
  539. <h5>listener: <span class="tsd-signature-type">Listener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
  540. <div class="tsd-comment tsd-typography">
  541. <p>流对象事件监听函数</p>
  542. </div>
  543. </li>
  544. </ul>
  545. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventEmitter</span></h4>
  546. </li>
  547. </ul>
  548. </section>
  549. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
  550. <a name="on" class="tsd-anchor"></a>
  551. <h3>on</h3>
  552. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
  553. <li class="tsd-signature tsd-kind-icon">on&lt;T&gt;<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Listener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span></li>
  554. </ul>
  555. <ul class="tsd-descriptions">
  556. <li class="tsd-description">
  557. <aside class="tsd-sources">
  558. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#on">on</a></p>
  559. </aside>
  560. <div class="tsd-comment tsd-typography">
  561. <div class="lead">
  562. <p>监听流对象事件</p>
  563. </div>
  564. </div>
  565. <h4 class="tsd-type-parameters-title">Type parameters</h4>
  566. <ul class="tsd-type-parameters">
  567. <li>
  568. <h4>T<span class="tsd-signature-symbol">: </span><a href="../index.html#rtceventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcEventType</a></h4>
  569. </li>
  570. </ul>
  571. <h4 class="tsd-parameters-title">Parameters</h4>
  572. <ul class="tsd-parameters">
  573. <li>
  574. <h5>type: <span class="tsd-signature-type">T</span></h5>
  575. <div class="tsd-comment tsd-typography">
  576. <p>流事件类型</p>
  577. </div>
  578. </li>
  579. <li>
  580. <h5>listener: <span class="tsd-signature-type">Listener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
  581. <div class="tsd-comment tsd-typography">
  582. <p>流事件监听函数</p>
  583. </div>
  584. </li>
  585. </ul>
  586. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventEmitter</span></h4>
  587. </li>
  588. </ul>
  589. </section>
  590. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  591. <a name="play" class="tsd-anchor"></a>
  592. <h3>play</h3>
  593. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  594. <li class="tsd-signature tsd-kind-icon">play<span class="tsd-signature-symbol">(</span>container<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/playoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PlayOptions</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>
  595. </ul>
  596. <ul class="tsd-descriptions">
  597. <li class="tsd-description">
  598. <aside class="tsd-sources">
  599. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#play">play</a></p>
  600. </aside>
  601. <div class="tsd-comment tsd-typography">
  602. <div class="lead">
  603. <p>播放当前流</p>
  604. </div>
  605. <dl class="tsd-comment-tags">
  606. <dt>example</dt>
  607. <dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">container</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;xxx&#039;</span><span style="color: #000000">; </span><span style="color: #008000">// 比如 id 为 xxx 的 div 元素</span>
  608. <span style="color: #001080">stream</span>
  609. <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>
  610. <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>
  611. <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><span style="color: #008000">// 一般由于浏览器对自动播放的限制导致播放失败</span>
  612. <span style="color: #000000"> });</span>
  613. </code></pre>
  614. </dd>
  615. <dt>reject</dt>
  616. <dd><p><a href="rtcerror.html">RtcError</a></p>
  617. </dd>
  618. </dl>
  619. </div>
  620. <h4 class="tsd-parameters-title">Parameters</h4>
  621. <ul class="tsd-parameters">
  622. <li>
  623. <h5>container: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></h5>
  624. <div class="tsd-comment tsd-typography">
  625. <p>播放音视频时,包裹 video 标签所用的容器元素或容器元素的 ID</p>
  626. </div>
  627. </li>
  628. <li>
  629. <h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="../interfaces/playoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PlayOptions</a></h5>
  630. <div class="tsd-comment tsd-typography">
  631. <p>其他播放参数,参见<a href="../interfaces/playoptions.html">PlayOptions</a></p>
  632. </div>
  633. </li>
  634. </ul>
  635. <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>
  636. </li>
  637. </ul>
  638. </section>
  639. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  640. <a name="removetrack" class="tsd-anchor"></a>
  641. <h3>remove<wbr>Track</h3>
  642. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  643. <li class="tsd-signature tsd-kind-icon">remove<wbr>Track<span class="tsd-signature-symbol">(</span>track<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  644. </ul>
  645. <ul class="tsd-descriptions">
  646. <li class="tsd-description">
  647. <aside class="tsd-sources">
  648. </aside>
  649. <div class="tsd-comment tsd-typography">
  650. <div class="lead">
  651. <p>从当前流中删除一条媒体轨道(音轨或视轨)</p>
  652. </div>
  653. <dl class="tsd-comment-tags">
  654. <dt>example</dt>
  655. <dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">removeTrack</span><span style="color: #000000">(</span><span style="color: #001080">track</span><span style="color: #000000">);</span>
  656. </code></pre>
  657. </dd>
  658. </dl>
  659. </div>
  660. <h4 class="tsd-parameters-title">Parameters</h4>
  661. <ul class="tsd-parameters">
  662. <li>
  663. <h5>track: <span class="tsd-signature-type">MediaStreamTrack</span></h5>
  664. <div class="tsd-comment tsd-typography">
  665. <p>媒体轨道</p>
  666. </div>
  667. </li>
  668. </ul>
  669. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  670. </li>
  671. </ul>
  672. </section>
  673. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  674. <a name="replacetrack" class="tsd-anchor"></a>
  675. <h3>replace<wbr>Track</h3>
  676. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  677. <li class="tsd-signature tsd-kind-icon">replace<wbr>Track<span class="tsd-signature-symbol">(</span>track<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MediaStreamTrack</span></li>
  678. </ul>
  679. <ul class="tsd-descriptions">
  680. <li class="tsd-description">
  681. <aside class="tsd-sources">
  682. </aside>
  683. <div class="tsd-comment tsd-typography">
  684. <div class="lead">
  685. <p>替换当前流中的媒体轨道</p>
  686. <blockquote>
  687. <p>注:</p>
  688. <ol>
  689. <li>替换视频时,请使用与原轨道相同的分辨率的媒体轨道</li>
  690. <li>返回值为当前流中相同类型的媒体轨道,此媒体轨道仍可用(占用音频设备或视频设备),请自行决定是否调用其 stop 方法释放设备</li>
  691. </ol>
  692. </blockquote>
  693. </div>
  694. <dl class="tsd-comment-tags">
  695. <dt>example</dt>
  696. <dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">oldTrack</span><span style="color: #000000"> = </span><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">replaceTrack</span><span style="color: #000000">(</span><span style="color: #001080">track</span><span style="color: #000000">);</span>
  697. <span style="color: #001080">oldTrack</span><span style="color: #000000">.</span><span style="color: #795E26">stop</span><span style="color: #000000">();</span>
  698. </code></pre>
  699. </dd>
  700. </dl>
  701. </div>
  702. <h4 class="tsd-parameters-title">Parameters</h4>
  703. <ul class="tsd-parameters">
  704. <li>
  705. <h5>track: <span class="tsd-signature-type">MediaStreamTrack</span></h5>
  706. <div class="tsd-comment tsd-typography">
  707. <p>新媒体轨道</p>
  708. </div>
  709. </li>
  710. </ul>
  711. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MediaStreamTrack</span></h4>
  712. </li>
  713. </ul>
  714. </section>
  715. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  716. <a name="resume" class="tsd-anchor"></a>
  717. <h3>resume</h3>
  718. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  719. <li class="tsd-signature tsd-kind-icon">resume<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">void</span><span class="tsd-signature-symbol">&gt;</span></li>
  720. </ul>
  721. <ul class="tsd-descriptions">
  722. <li class="tsd-description">
  723. <aside class="tsd-sources">
  724. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#resume">resume</a></p>
  725. </aside>
  726. <div class="tsd-comment tsd-typography">
  727. <div class="lead">
  728. <p>恢复播放流,一般由于浏览器限制无法自动播放时,可提示用户手动触发该方法进行恢复播放</p>
  729. </div>
  730. <dl class="tsd-comment-tags">
  731. <dt>example</dt>
  732. <dd><pre><code class="language-js"><span style="color: #001080">stream</span>
  733. <span style="color: #000000"> .</span><span style="color: #795E26">resume</span><span style="color: #000000">()</span>
  734. <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>
  735. <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>
  736. <span style="color: #000000"> });</span>
  737. </code></pre>
  738. </dd>
  739. </dl>
  740. </div>
  741. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
  742. </li>
  743. </ul>
  744. </section>
  745. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  746. <a name="setaudiolevel" class="tsd-anchor"></a>
  747. <h3>set<wbr>Audio<wbr>Level</h3>
  748. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  749. <li class="tsd-signature tsd-kind-icon">set<wbr>Audio<wbr>Level<span class="tsd-signature-symbol">(</span>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  750. </ul>
  751. <ul class="tsd-descriptions">
  752. <li class="tsd-description">
  753. <aside class="tsd-sources">
  754. </aside>
  755. <div class="tsd-comment tsd-typography">
  756. <div class="lead">
  757. <p>设置音频能量大小,默认 100</p>
  758. </div>
  759. </div>
  760. <h4 class="tsd-parameters-title">Parameters</h4>
  761. <ul class="tsd-parameters">
  762. <li>
  763. <h5>level: <span class="tsd-signature-type">number</span></h5>
  764. <div class="tsd-comment tsd-typography">
  765. <p>能量大小,取值范围 [0-300]</p>
  766. </div>
  767. </li>
  768. </ul>
  769. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  770. </li>
  771. </ul>
  772. </section>
  773. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  774. <a name="setscreenprofile" class="tsd-anchor"></a>
  775. <h3>set<wbr>Screen<wbr>Profile</h3>
  776. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  777. <li class="tsd-signature tsd-kind-icon">set<wbr>Screen<wbr>Profile<span class="tsd-signature-symbol">(</span>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;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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CustomVideoProfile</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-symbol">: </span><span class="tsd-signature-type">void</span></li>
  778. </ul>
  779. <ul class="tsd-descriptions">
  780. <li class="tsd-description">
  781. <aside class="tsd-sources">
  782. </aside>
  783. <div class="tsd-comment tsd-typography">
  784. <div class="lead">
  785. <p>设置当前流(屏幕共享时)视频的 Profile,默认 &#39;1080p&#39;
  786. 注:请务必在调用 init 方法之前,设置屏幕共享流的 Profile,否则无法生效。</p>
  787. </div>
  788. <dl class="tsd-comment-tags">
  789. <dt>example</dt>
  790. <dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">setScreenProfile</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;720p&#039;</span><span style="color: #000000">);</span>
  791. <span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">init</span><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>
  792. <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>
  793. <span style="color: #000000">});</span>
  794. </code></pre>
  795. </dd>
  796. </dl>
  797. </div>
  798. <h4 class="tsd-parameters-title">Parameters</h4>
  799. <ul class="tsd-parameters">
  800. <li>
  801. <h5>profile: <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;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">CustomVideoProfile</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;480p_2&quot;</span></h5>
  802. <div class="tsd-comment tsd-typography">
  803. <p>视频 Profile</p>
  804. </div>
  805. </li>
  806. </ul>
  807. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  808. </li>
  809. </ul>
  810. </section>
  811. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  812. <a name="setvideoprofile" class="tsd-anchor"></a>
  813. <h3>set<wbr>Video<wbr>Profile</h3>
  814. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  815. <li class="tsd-signature tsd-kind-icon">set<wbr>Video<wbr>Profile<span class="tsd-signature-symbol">(</span>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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CustomVideoProfile</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">void</span><span class="tsd-signature-symbol">&gt;</span></li>
  816. </ul>
  817. <ul class="tsd-descriptions">
  818. <li class="tsd-description">
  819. <aside class="tsd-sources">
  820. </aside>
  821. <div class="tsd-comment tsd-typography">
  822. <div class="lead">
  823. <p>设置当前流视频的 Profile,默认 &#39;360p_2&#39;</p>
  824. </div>
  825. <dl class="tsd-comment-tags">
  826. <dt>example</dt>
  827. <dd><pre><code class="language-js"><span style="color: #001080">stream</span>
  828. <span style="color: #000000"> .</span><span style="color: #795E26">setVideoProfile</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;720p&#039;</span><span style="color: #000000">)</span>
  829. <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>
  830. <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;set video profile success&#039;</span><span style="color: #000000">);</span>
  831. <span style="color: #000000"> })</span>
  832. <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>
  833. <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;set video profile failed &#039;</span><span style="color: #000000">, </span><span style="color: #001080">err</span><span style="color: #000000">);</span>
  834. <span style="color: #000000"> });</span>
  835. </code></pre>
  836. <p>或</p>
  837. <pre><code class="language-js"><span style="color: #001080">stream</span>
  838. <span style="color: #000000"> .</span><span style="color: #795E26">setVideoProfile</span><span style="color: #000000">({</span><span style="color: #001080">width:</span><span style="color: #000000"> </span><span style="color: #098658">640</span><span style="color: #000000">, </span><span style="color: #001080">height:</span><span style="color: #000000"> </span><span style="color: #098658">480</span><span style="color: #000000">, </span><span style="color: #001080">framerate:</span><span style="color: #000000"> </span><span style="color: #098658">15</span><span style="color: #000000">, </span><span style="color: #001080">bitrate:</span><span style="color: #000000"> </span><span style="color: #098658">500</span><span style="color: #000000">});</span>
  839. <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>
  840. <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;set video profile success&#039;</span><span style="color: #000000">);</span>
  841. <span style="color: #000000"> })</span>
  842. <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>
  843. <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;set video profile failed &#039;</span><span style="color: #000000">, </span><span style="color: #001080">err</span><span style="color: #000000">);</span>
  844. <span style="color: #000000"> });</span>
  845. </code></pre>
  846. </dd>
  847. </dl>
  848. </div>
  849. <h4 class="tsd-parameters-title">Parameters</h4>
  850. <ul class="tsd-parameters">
  851. <li>
  852. <h5>profile: <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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CustomVideoProfile</span></h5>
  853. <div class="tsd-comment tsd-typography">
  854. <p>视频 Profile</p>
  855. </div>
  856. </li>
  857. </ul>
  858. <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>
  859. </li>
  860. </ul>
  861. </section>
  862. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  863. <a name="snapshot" class="tsd-anchor"></a>
  864. <h3>snapshot</h3>
  865. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  866. <li class="tsd-signature tsd-kind-icon">snapshot<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/snapshotoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SnapshotOptions</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">string</span><span class="tsd-signature-symbol">&gt;</span></li>
  867. </ul>
  868. <ul class="tsd-descriptions">
  869. <li class="tsd-description">
  870. <aside class="tsd-sources">
  871. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#snapshot">snapshot</a></p>
  872. </aside>
  873. <div class="tsd-comment tsd-typography">
  874. <div class="lead">
  875. <p>对当前流进行截屏,可用于页面展示或下载保存</p>
  876. </div>
  877. <dl class="tsd-comment-tags">
  878. <dt>example</dt>
  879. <dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">snapshot</span><span style="color: #000000">({</span><span style="color: #001080">filename:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;xxx.jpg&#039;</span><span style="color: #000000">})</span>
  880. <span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">((</span><span style="color: #001080">pic</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
  881. <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><span style="color: #001080">pic</span><span style="color: #000000">);</span>
  882. <span style="color: #000000"> })</span>
  883. <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>
  884. <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><span style="color: #001080">err</span><span style="color: #000000">);</span>
  885. <span style="color: #000000"> });</span>
  886. </code></pre>
  887. </dd>
  888. </dl>
  889. </div>
  890. <h4 class="tsd-parameters-title">Parameters</h4>
  891. <ul class="tsd-parameters">
  892. <li>
  893. <h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="../interfaces/snapshotoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SnapshotOptions</a></h5>
  894. <div class="tsd-comment tsd-typography">
  895. <p>截屏参数,选传,参见<a href="../interfaces/snapshotoptions.html">SnapshotOptions</a></p>
  896. </div>
  897. </li>
  898. </ul>
  899. <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">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
  900. </li>
  901. </ul>
  902. </section>
  903. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  904. <a name="stop" class="tsd-anchor"></a>
  905. <h3>stop</h3>
  906. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  907. <li class="tsd-signature tsd-kind-icon">stop<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>
  908. </ul>
  909. <ul class="tsd-descriptions">
  910. <li class="tsd-description">
  911. <aside class="tsd-sources">
  912. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#stop">stop</a></p>
  913. </aside>
  914. <div class="tsd-comment tsd-typography">
  915. <div class="lead">
  916. <p>停止播放当前流</p>
  917. </div>
  918. <dl class="tsd-comment-tags">
  919. <dt>example</dt>
  920. <dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">stop</span><span style="color: #000000">();</span>
  921. </code></pre>
  922. </dd>
  923. </dl>
  924. </div>
  925. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  926. </li>
  927. </ul>
  928. </section>
  929. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  930. <a name="switchdevice" class="tsd-anchor"></a>
  931. <h3>switch<wbr>Device</h3>
  932. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  933. <li class="tsd-signature tsd-kind-icon">switch<wbr>Device<span class="tsd-signature-symbol">(</span>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>, deviceId<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
  934. </ul>
  935. <ul class="tsd-descriptions">
  936. <li class="tsd-description">
  937. <aside class="tsd-sources">
  938. </aside>
  939. <div class="tsd-comment tsd-typography">
  940. <div class="lead">
  941. <p>切换音视频设备</p>
  942. </div>
  943. <dl class="tsd-comment-tags">
  944. <dt>example</dt>
  945. <dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">switchDevice</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;audio&#039;</span><span style="color: #000000">, </span><span style="color: #A31515">&#039;xxxxxxx&#039;</span><span style="color: #000000">)</span>
  946. <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>
  947. <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>
  948. <span style="color: #000000"> })</span>
  949. <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>
  950. <span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`切换设备失败:</span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
  951. <span style="color: #000000"> });</span>
  952. </code></pre>
  953. </dd>
  954. <dt>reject</dt>
  955. <dd><p><a href="rtcerror.html">RtcError</a></p>
  956. </dd>
  957. </dl>
  958. </div>
  959. <h4 class="tsd-parameters-title">Parameters</h4>
  960. <ul class="tsd-parameters">
  961. <li>
  962. <h5>type: <span class="tsd-signature-type">&quot;audio&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;video&quot;</span></h5>
  963. <div class="tsd-comment tsd-typography">
  964. <p>设备类型</p>
  965. </div>
  966. </li>
  967. <li>
  968. <h5>deviceId: <span class="tsd-signature-type">string</span></h5>
  969. <div class="tsd-comment tsd-typography">
  970. <p>设备 ID</p>
  971. </div>
  972. </li>
  973. </ul>
  974. <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>
  975. </li>
  976. </ul>
  977. </section>
  978. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  979. <a name="switchimage" class="tsd-anchor"></a>
  980. <h3>switch<wbr>Image</h3>
  981. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  982. <li class="tsd-signature tsd-kind-icon">switch<wbr>Image<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">File</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">void</span><span class="tsd-signature-symbol">&gt;</span></li>
  983. </ul>
  984. <ul class="tsd-descriptions">
  985. <li class="tsd-description">
  986. <aside class="tsd-sources">
  987. </aside>
  988. <div class="tsd-comment tsd-typography">
  989. <div class="lead">
  990. <p>切换图片 - 使用图片生成视频,并将当前流的视频使用其代替</p>
  991. </div>
  992. <dl class="tsd-comment-tags">
  993. <dt>example</dt>
  994. <dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">imgAddr</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;https://a.b.c/d.jpg&#039;</span><span style="color: #000000">;</span>
  995. <span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">switchImage</span><span style="color: #000000">(</span><span style="color: #001080">imgAddr</span><span style="color: #000000">)</span>
  996. <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>
  997. <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>
  998. <span style="color: #000000"> })</span>
  999. <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>
  1000. <span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">error</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>
  1001. <span style="color: #000000"> });</span>
  1002. </code></pre>
  1003. </dd>
  1004. <dt>reject</dt>
  1005. <dd><p><a href="rtcerror.html">RtcError</a></p>
  1006. </dd>
  1007. </dl>
  1008. </div>
  1009. <h4 class="tsd-parameters-title">Parameters</h4>
  1010. <ul class="tsd-parameters">
  1011. <li>
  1012. <h5>file: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">File</span></h5>
  1013. <div class="tsd-comment tsd-typography">
  1014. <p>图片地址或图片文件</p>
  1015. </div>
  1016. </li>
  1017. </ul>
  1018. <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>
  1019. </li>
  1020. </ul>
  1021. </section>
  1022. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1023. <a name="unmuteaudio" class="tsd-anchor"></a>
  1024. <h3>unmute<wbr>Audio</h3>
  1025. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1026. <li class="tsd-signature tsd-kind-icon">unmute<wbr>Audio<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>
  1027. </ul>
  1028. <ul class="tsd-descriptions">
  1029. <li class="tsd-description">
  1030. <aside class="tsd-sources">
  1031. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#unmuteaudio">unmuteAudio</a></p>
  1032. </aside>
  1033. <div class="tsd-comment tsd-typography">
  1034. <div class="lead">
  1035. <p>unmute 当前流的音频</p>
  1036. <ul>
  1037. <li>本地流调用此方法时,将向服务器推送音频数据,远端用户将收到 <code>unmute-audio</code> 的事件通知</li>
  1038. <li>远端流调用此方法时,会从服务器拉取音频数据,并无事件通知远端用户</li>
  1039. </ul>
  1040. </div>
  1041. <dl class="tsd-comment-tags">
  1042. <dt>example</dt>
  1043. <dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">result</span><span style="color: #000000"> = </span><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">unmuteAudio</span><span style="color: #000000">();</span>
  1044. <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 audio is muted </span><span style="color: #0000FF">${</span><span style="color: #001080">stream</span><span style="color: #000000FF">.</span><span style="color: #001080">audioMuted</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
  1045. </code></pre>
  1046. </dd>
  1047. </dl>
  1048. </div>
  1049. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  1050. <p>操作是否成功</p>
  1051. </li>
  1052. </ul>
  1053. </section>
  1054. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1055. <a name="unmutevideo" class="tsd-anchor"></a>
  1056. <h3>unmute<wbr>Video</h3>
  1057. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1058. <li class="tsd-signature tsd-kind-icon">unmute<wbr>Video<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>
  1059. </ul>
  1060. <ul class="tsd-descriptions">
  1061. <li class="tsd-description">
  1062. <aside class="tsd-sources">
  1063. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#unmutevideo">unmuteVideo</a></p>
  1064. </aside>
  1065. <div class="tsd-comment tsd-typography">
  1066. <div class="lead">
  1067. <p>unmute 当前流的视频</p>
  1068. <ul>
  1069. <li>本地流调用此方法时,将向服务器推送视频数据,远端用户将收到 <code>unmute-video</code> 的事件通知</li>
  1070. <li>远端流调用此方法时,会从服务器拉取视频数据,并无事件通知远端用户</li>
  1071. </ul>
  1072. </div>
  1073. <dl class="tsd-comment-tags">
  1074. <dt>example</dt>
  1075. <dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">result</span><span style="color: #000000"> = </span><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">unmuteVideo</span><span style="color: #000000">();</span>
  1076. <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 video is muted </span><span style="color: #0000FF">${</span><span style="color: #001080">stream</span><span style="color: #000000FF">.</span><span style="color: #001080">videoMuted</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
  1077. </code></pre>
  1078. </dd>
  1079. </dl>
  1080. </div>
  1081. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  1082. <p>操作是否成功</p>
  1083. </li>
  1084. </ul>
  1085. </section>
  1086. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1087. <a name="use" class="tsd-anchor"></a>
  1088. <h3><span class="tsd-flag ts-flagStatic">Static</span> use</h3>
  1089. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1090. <li class="tsd-signature tsd-kind-icon">use<span class="tsd-signature-symbol">(</span>plugin<span class="tsd-signature-symbol">: </span><a href="../interfaces/streamplugin.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamPlugin</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  1091. </ul>
  1092. <ul class="tsd-descriptions">
  1093. <li class="tsd-description">
  1094. <aside class="tsd-sources">
  1095. </aside>
  1096. <div class="tsd-comment tsd-typography">
  1097. <div class="lead">
  1098. <p>加载流插件,使用插件功能</p>
  1099. </div>
  1100. </div>
  1101. <h4 class="tsd-parameters-title">Parameters</h4>
  1102. <ul class="tsd-parameters">
  1103. <li>
  1104. <h5>plugin: <a href="../interfaces/streamplugin.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamPlugin</a></h5>
  1105. <div class="tsd-comment tsd-typography">
  1106. <p>插件</p>
  1107. </div>
  1108. </li>
  1109. <li>
  1110. <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
  1111. <div class="tsd-comment tsd-typography">
  1112. <p>插件初始化参数</p>
  1113. </div>
  1114. </li>
  1115. </ul>
  1116. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1117. </li>
  1118. </ul>
  1119. </section>
  1120. </section>
  1121. </div>
  1122. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  1123. <nav class="tsd-navigation primary">
  1124. <ul>
  1125. <li class=" ">
  1126. <a href="../index.html">Exports</a>
  1127. </li>
  1128. </ul>
  1129. </nav>
  1130. <nav class="tsd-navigation secondary menu-sticky">
  1131. <ul class="before-current">
  1132. </ul>
  1133. <ul class="current">
  1134. <li class="current tsd-kind-class">
  1135. <a href="localstream.html" class="tsd-kind-icon">Local<wbr>Stream</a>
  1136. <ul>
  1137. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  1138. <a href="localstream.html#audiomuted" class="tsd-kind-icon">audio<wbr>Muted</a>
  1139. </li>
  1140. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  1141. <a href="localstream.html#id" class="tsd-kind-icon">id</a>
  1142. </li>
  1143. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  1144. <a href="localstream.html#mediastream" class="tsd-kind-icon">media<wbr>Stream</a>
  1145. </li>
  1146. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  1147. <a href="localstream.html#userid" class="tsd-kind-icon">user<wbr>Id</a>
  1148. </li>
  1149. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  1150. <a href="localstream.html#videomuted" class="tsd-kind-icon">video<wbr>Muted</a>
  1151. </li>
  1152. <li class=" tsd-kind-method tsd-parent-kind-class">
  1153. <a href="localstream.html#addtrack" class="tsd-kind-icon">add<wbr>Track</a>
  1154. </li>
  1155. <li class=" tsd-kind-method tsd-parent-kind-class">
  1156. <a href="localstream.html#destroy" class="tsd-kind-icon">destroy</a>
  1157. </li>
  1158. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1159. <a href="localstream.html#getaudiolevel" class="tsd-kind-icon">get<wbr>Audio<wbr>Level</a>
  1160. </li>
  1161. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1162. <a href="localstream.html#getmediatype" class="tsd-kind-icon">get<wbr>Media<wbr>Type</a>
  1163. </li>
  1164. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1165. <a href="localstream.html#getstats" class="tsd-kind-icon">get<wbr>Stats</a>
  1166. </li>
  1167. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
  1168. <a href="localstream.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a>
  1169. </li>
  1170. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
  1171. <a href="localstream.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a>
  1172. </li>
  1173. <li class=" tsd-kind-method tsd-parent-kind-class">
  1174. <a href="localstream.html#init" class="tsd-kind-icon">init</a>
  1175. </li>
  1176. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1177. <a href="localstream.html#muteaudio" class="tsd-kind-icon">mute<wbr>Audio</a>
  1178. </li>
  1179. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1180. <a href="localstream.html#mutevideo" class="tsd-kind-icon">mute<wbr>Video</a>
  1181. </li>
  1182. <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
  1183. <a href="localstream.html#off" class="tsd-kind-icon">off</a>
  1184. </li>
  1185. <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
  1186. <a href="localstream.html#on" class="tsd-kind-icon">on</a>
  1187. </li>
  1188. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1189. <a href="localstream.html#play" class="tsd-kind-icon">play</a>
  1190. </li>
  1191. <li class=" tsd-kind-method tsd-parent-kind-class">
  1192. <a href="localstream.html#removetrack" class="tsd-kind-icon">remove<wbr>Track</a>
  1193. </li>
  1194. <li class=" tsd-kind-method tsd-parent-kind-class">
  1195. <a href="localstream.html#replacetrack" class="tsd-kind-icon">replace<wbr>Track</a>
  1196. </li>
  1197. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1198. <a href="localstream.html#resume" class="tsd-kind-icon">resume</a>
  1199. </li>
  1200. <li class=" tsd-kind-method tsd-parent-kind-class">
  1201. <a href="localstream.html#setaudiolevel" class="tsd-kind-icon">set<wbr>Audio<wbr>Level</a>
  1202. </li>
  1203. <li class=" tsd-kind-method tsd-parent-kind-class">
  1204. <a href="localstream.html#setscreenprofile" class="tsd-kind-icon">set<wbr>Screen<wbr>Profile</a>
  1205. </li>
  1206. <li class=" tsd-kind-method tsd-parent-kind-class">
  1207. <a href="localstream.html#setvideoprofile" class="tsd-kind-icon">set<wbr>Video<wbr>Profile</a>
  1208. </li>
  1209. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1210. <a href="localstream.html#snapshot" class="tsd-kind-icon">snapshot</a>
  1211. </li>
  1212. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1213. <a href="localstream.html#stop" class="tsd-kind-icon">stop</a>
  1214. </li>
  1215. <li class=" tsd-kind-method tsd-parent-kind-class">
  1216. <a href="localstream.html#switchdevice" class="tsd-kind-icon">switch<wbr>Device</a>
  1217. </li>
  1218. <li class=" tsd-kind-method tsd-parent-kind-class">
  1219. <a href="localstream.html#switchimage" class="tsd-kind-icon">switch<wbr>Image</a>
  1220. </li>
  1221. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1222. <a href="localstream.html#unmuteaudio" class="tsd-kind-icon">unmute<wbr>Audio</a>
  1223. </li>
  1224. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1225. <a href="localstream.html#unmutevideo" class="tsd-kind-icon">unmute<wbr>Video</a>
  1226. </li>
  1227. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1228. <a href="localstream.html#use" class="tsd-kind-icon">use</a>
  1229. </li>
  1230. </ul>
  1231. </li>
  1232. </ul>
  1233. <ul class="after-current">
  1234. </ul>
  1235. </nav>
  1236. </div>
  1237. </div>
  1238. </div>
  1239. <footer class="with-border-bottom">
  1240. <div class="container">
  1241. <h2>Legend</h2>
  1242. <div class="tsd-legend-group">
  1243. <ul class="tsd-legend">
  1244. <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
  1245. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  1246. </ul>
  1247. <ul class="tsd-legend">
  1248. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  1249. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  1250. </ul>
  1251. <ul class="tsd-legend">
  1252. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
  1253. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
  1254. </ul>
  1255. <ul class="tsd-legend">
  1256. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  1257. </ul>
  1258. </div>
  1259. </div>
  1260. </footer>
  1261. <div class="container tsd-generator">
  1262. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  1263. </div>
  1264. <div class="overlay"></div>
  1265. <script src="../assets/js/main.js"></script>
  1266. </body>
  1267. </html>