localstream.html 89 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268
  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>替换视频时,建议使用与原轨道相同的分辨率的视频轨道,若不相同,请在替换后及时设置流的 profile 来调整到合适的码率等</li>
  690. <li>返回值为当前流中相同类型的媒体轨道,此媒体轨道仍可用(占用音频设备或视频设备),请自行决定是否调用其 stop 方法释放设备</li>
  691. <li>若是切换不同的摄像头或麦克风设备,建议使用 switchDevice 方法,若是切换静态图片为视频流,建立使用 switchImage 方法</li>
  692. </ol>
  693. </blockquote>
  694. </div>
  695. <dl class="tsd-comment-tags">
  696. <dt>example</dt>
  697. <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>
  698. <span style="color: #001080">oldTrack</span><span style="color: #000000">.</span><span style="color: #795E26">stop</span><span style="color: #000000">();</span>
  699. </code></pre>
  700. </dd>
  701. </dl>
  702. </div>
  703. <h4 class="tsd-parameters-title">Parameters</h4>
  704. <ul class="tsd-parameters">
  705. <li>
  706. <h5>track: <span class="tsd-signature-type">MediaStreamTrack</span></h5>
  707. <div class="tsd-comment tsd-typography">
  708. <p>新媒体轨道</p>
  709. </div>
  710. </li>
  711. </ul>
  712. <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>
  713. </li>
  714. </ul>
  715. </section>
  716. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  717. <a name="resume" class="tsd-anchor"></a>
  718. <h3>resume</h3>
  719. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  720. <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>
  721. </ul>
  722. <ul class="tsd-descriptions">
  723. <li class="tsd-description">
  724. <aside class="tsd-sources">
  725. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#resume">resume</a></p>
  726. </aside>
  727. <div class="tsd-comment tsd-typography">
  728. <div class="lead">
  729. <p>恢复播放流,一般由于浏览器限制无法自动播放时,可提示用户手动触发该方法进行恢复播放</p>
  730. </div>
  731. <dl class="tsd-comment-tags">
  732. <dt>example</dt>
  733. <dd><pre><code class="language-js"><span style="color: #001080">stream</span>
  734. <span style="color: #000000"> .</span><span style="color: #795E26">resume</span><span style="color: #000000">()</span>
  735. <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>
  736. <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>
  737. <span style="color: #000000"> });</span>
  738. </code></pre>
  739. </dd>
  740. </dl>
  741. </div>
  742. <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>
  743. </li>
  744. </ul>
  745. </section>
  746. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  747. <a name="setaudiolevel" class="tsd-anchor"></a>
  748. <h3>set<wbr>Audio<wbr>Level</h3>
  749. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  750. <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>
  751. </ul>
  752. <ul class="tsd-descriptions">
  753. <li class="tsd-description">
  754. <aside class="tsd-sources">
  755. </aside>
  756. <div class="tsd-comment tsd-typography">
  757. <div class="lead">
  758. <p>设置音频能量大小,默认 100</p>
  759. </div>
  760. </div>
  761. <h4 class="tsd-parameters-title">Parameters</h4>
  762. <ul class="tsd-parameters">
  763. <li>
  764. <h5>level: <span class="tsd-signature-type">number</span></h5>
  765. <div class="tsd-comment tsd-typography">
  766. <p>能量大小,取值范围 [0-300]</p>
  767. </div>
  768. </li>
  769. </ul>
  770. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  771. </li>
  772. </ul>
  773. </section>
  774. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  775. <a name="setscreenprofile" class="tsd-anchor"></a>
  776. <h3>set<wbr>Screen<wbr>Profile</h3>
  777. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  778. <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>
  779. </ul>
  780. <ul class="tsd-descriptions">
  781. <li class="tsd-description">
  782. <aside class="tsd-sources">
  783. </aside>
  784. <div class="tsd-comment tsd-typography">
  785. <div class="lead">
  786. <p>设置当前流(屏幕共享流)视频的 Profile,默认 &#39;1080p&#39;
  787. 注:请务必在调用 init 方法之前,设置屏幕共享流的 Profile,否则无法生效。</p>
  788. </div>
  789. <dl class="tsd-comment-tags">
  790. <dt>example</dt>
  791. <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>
  792. <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>
  793. <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>
  794. <span style="color: #000000">});</span>
  795. </code></pre>
  796. </dd>
  797. </dl>
  798. </div>
  799. <h4 class="tsd-parameters-title">Parameters</h4>
  800. <ul class="tsd-parameters">
  801. <li>
  802. <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>
  803. <div class="tsd-comment tsd-typography">
  804. <p>视频 Profile</p>
  805. </div>
  806. </li>
  807. </ul>
  808. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  809. </li>
  810. </ul>
  811. </section>
  812. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  813. <a name="setvideoprofile" class="tsd-anchor"></a>
  814. <h3>set<wbr>Video<wbr>Profile</h3>
  815. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  816. <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>
  817. </ul>
  818. <ul class="tsd-descriptions">
  819. <li class="tsd-description">
  820. <aside class="tsd-sources">
  821. </aside>
  822. <div class="tsd-comment tsd-typography">
  823. <div class="lead">
  824. <p>设置当前流视频的 Profile,默认 &#39;360p_2&#39;</p>
  825. </div>
  826. <dl class="tsd-comment-tags">
  827. <dt>example</dt>
  828. <dd><pre><code class="language-js"><span style="color: #001080">stream</span>
  829. <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>
  830. <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>
  831. <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>
  832. <span style="color: #000000"> })</span>
  833. <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>
  834. <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>
  835. <span style="color: #000000"> });</span>
  836. </code></pre>
  837. <p>或</p>
  838. <pre><code class="language-js"><span style="color: #001080">stream</span>
  839. <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>
  840. <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>
  841. <span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;set video profile success&#039;</span><span style="color: #000000">);</span>
  842. <span style="color: #000000"> })</span>
  843. <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>
  844. <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>
  845. <span style="color: #000000"> });</span>
  846. </code></pre>
  847. </dd>
  848. </dl>
  849. </div>
  850. <h4 class="tsd-parameters-title">Parameters</h4>
  851. <ul class="tsd-parameters">
  852. <li>
  853. <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>
  854. <div class="tsd-comment tsd-typography">
  855. <p>视频 Profile</p>
  856. </div>
  857. </li>
  858. </ul>
  859. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
  860. </li>
  861. </ul>
  862. </section>
  863. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  864. <a name="snapshot" class="tsd-anchor"></a>
  865. <h3>snapshot</h3>
  866. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  867. <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>
  868. </ul>
  869. <ul class="tsd-descriptions">
  870. <li class="tsd-description">
  871. <aside class="tsd-sources">
  872. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#snapshot">snapshot</a></p>
  873. </aside>
  874. <div class="tsd-comment tsd-typography">
  875. <div class="lead">
  876. <p>对当前流进行截屏,可用于页面展示或下载保存</p>
  877. </div>
  878. <dl class="tsd-comment-tags">
  879. <dt>example</dt>
  880. <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>
  881. <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>
  882. <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>
  883. <span style="color: #000000"> })</span>
  884. <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>
  885. <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>
  886. <span style="color: #000000"> });</span>
  887. </code></pre>
  888. </dd>
  889. </dl>
  890. </div>
  891. <h4 class="tsd-parameters-title">Parameters</h4>
  892. <ul class="tsd-parameters">
  893. <li>
  894. <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>
  895. <div class="tsd-comment tsd-typography">
  896. <p>截屏参数,选传,参见<a href="../interfaces/snapshotoptions.html">SnapshotOptions</a></p>
  897. </div>
  898. </li>
  899. </ul>
  900. <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>
  901. </li>
  902. </ul>
  903. </section>
  904. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  905. <a name="stop" class="tsd-anchor"></a>
  906. <h3>stop</h3>
  907. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  908. <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>
  909. </ul>
  910. <ul class="tsd-descriptions">
  911. <li class="tsd-description">
  912. <aside class="tsd-sources">
  913. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#stop">stop</a></p>
  914. </aside>
  915. <div class="tsd-comment tsd-typography">
  916. <div class="lead">
  917. <p>停止播放当前流</p>
  918. </div>
  919. <dl class="tsd-comment-tags">
  920. <dt>example</dt>
  921. <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>
  922. </code></pre>
  923. </dd>
  924. </dl>
  925. </div>
  926. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  927. </li>
  928. </ul>
  929. </section>
  930. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  931. <a name="switchdevice" class="tsd-anchor"></a>
  932. <h3>switch<wbr>Device</h3>
  933. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  934. <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>
  935. </ul>
  936. <ul class="tsd-descriptions">
  937. <li class="tsd-description">
  938. <aside class="tsd-sources">
  939. </aside>
  940. <div class="tsd-comment tsd-typography">
  941. <div class="lead">
  942. <p>切换音视频设备</p>
  943. </div>
  944. <dl class="tsd-comment-tags">
  945. <dt>example</dt>
  946. <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>
  947. <span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
  948. <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>
  949. <span style="color: #000000"> })</span>
  950. <span style="color: #000000"> .</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
  951. <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>
  952. <span style="color: #000000"> });</span>
  953. </code></pre>
  954. </dd>
  955. <dt>reject</dt>
  956. <dd><p><a href="rtcerror.html">RtcError</a></p>
  957. </dd>
  958. </dl>
  959. </div>
  960. <h4 class="tsd-parameters-title">Parameters</h4>
  961. <ul class="tsd-parameters">
  962. <li>
  963. <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>
  964. <div class="tsd-comment tsd-typography">
  965. <p>设备类型</p>
  966. </div>
  967. </li>
  968. <li>
  969. <h5>deviceId: <span class="tsd-signature-type">string</span></h5>
  970. <div class="tsd-comment tsd-typography">
  971. <p>设备 ID</p>
  972. </div>
  973. </li>
  974. </ul>
  975. <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>
  976. </li>
  977. </ul>
  978. </section>
  979. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
  980. <a name="switchimage" class="tsd-anchor"></a>
  981. <h3>switch<wbr>Image</h3>
  982. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
  983. <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>
  984. </ul>
  985. <ul class="tsd-descriptions">
  986. <li class="tsd-description">
  987. <aside class="tsd-sources">
  988. </aside>
  989. <div class="tsd-comment tsd-typography">
  990. <div class="lead">
  991. <p>切换图片 - 使用图片生成视频,并将当前流的视频使用其代替</p>
  992. </div>
  993. <dl class="tsd-comment-tags">
  994. <dt>example</dt>
  995. <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>
  996. <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>
  997. <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>
  998. <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>
  999. <span style="color: #000000"> })</span>
  1000. <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>
  1001. <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>
  1002. <span style="color: #000000"> });</span>
  1003. </code></pre>
  1004. </dd>
  1005. <dt>reject</dt>
  1006. <dd><p><a href="rtcerror.html">RtcError</a></p>
  1007. </dd>
  1008. </dl>
  1009. </div>
  1010. <h4 class="tsd-parameters-title">Parameters</h4>
  1011. <ul class="tsd-parameters">
  1012. <li>
  1013. <h5>file: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">File</span></h5>
  1014. <div class="tsd-comment tsd-typography">
  1015. <p>图片地址或图片文件</p>
  1016. </div>
  1017. </li>
  1018. </ul>
  1019. <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>
  1020. </li>
  1021. </ul>
  1022. </section>
  1023. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1024. <a name="unmuteaudio" class="tsd-anchor"></a>
  1025. <h3>unmute<wbr>Audio</h3>
  1026. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1027. <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>
  1028. </ul>
  1029. <ul class="tsd-descriptions">
  1030. <li class="tsd-description">
  1031. <aside class="tsd-sources">
  1032. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#unmuteaudio">unmuteAudio</a></p>
  1033. </aside>
  1034. <div class="tsd-comment tsd-typography">
  1035. <div class="lead">
  1036. <p>unmute 当前流的音频</p>
  1037. <ul>
  1038. <li>本地流调用此方法时,将向服务器推送音频数据,远端用户将收到 <code>unmute-audio</code> 的事件通知</li>
  1039. <li>远端流调用此方法时,会从服务器拉取音频数据,并无事件通知远端用户</li>
  1040. </ul>
  1041. </div>
  1042. <dl class="tsd-comment-tags">
  1043. <dt>example</dt>
  1044. <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>
  1045. <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>
  1046. </code></pre>
  1047. </dd>
  1048. </dl>
  1049. </div>
  1050. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  1051. <p>操作是否成功</p>
  1052. </li>
  1053. </ul>
  1054. </section>
  1055. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1056. <a name="unmutevideo" class="tsd-anchor"></a>
  1057. <h3>unmute<wbr>Video</h3>
  1058. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1059. <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>
  1060. </ul>
  1061. <ul class="tsd-descriptions">
  1062. <li class="tsd-description">
  1063. <aside class="tsd-sources">
  1064. <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#unmutevideo">unmuteVideo</a></p>
  1065. </aside>
  1066. <div class="tsd-comment tsd-typography">
  1067. <div class="lead">
  1068. <p>unmute 当前流的视频</p>
  1069. <ul>
  1070. <li>本地流调用此方法时,将向服务器推送视频数据,远端用户将收到 <code>unmute-video</code> 的事件通知</li>
  1071. <li>远端流调用此方法时,会从服务器拉取视频数据,并无事件通知远端用户</li>
  1072. </ul>
  1073. </div>
  1074. <dl class="tsd-comment-tags">
  1075. <dt>example</dt>
  1076. <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>
  1077. <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>
  1078. </code></pre>
  1079. </dd>
  1080. </dl>
  1081. </div>
  1082. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  1083. <p>操作是否成功</p>
  1084. </li>
  1085. </ul>
  1086. </section>
  1087. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1088. <a name="use" class="tsd-anchor"></a>
  1089. <h3><span class="tsd-flag ts-flagStatic">Static</span> use</h3>
  1090. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1091. <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>
  1092. </ul>
  1093. <ul class="tsd-descriptions">
  1094. <li class="tsd-description">
  1095. <aside class="tsd-sources">
  1096. </aside>
  1097. <div class="tsd-comment tsd-typography">
  1098. <div class="lead">
  1099. <p>加载流插件,使用插件功能</p>
  1100. </div>
  1101. </div>
  1102. <h4 class="tsd-parameters-title">Parameters</h4>
  1103. <ul class="tsd-parameters">
  1104. <li>
  1105. <h5>plugin: <a href="../interfaces/streamplugin.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamPlugin</a></h5>
  1106. <div class="tsd-comment tsd-typography">
  1107. <p>插件</p>
  1108. </div>
  1109. </li>
  1110. <li>
  1111. <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
  1112. <div class="tsd-comment tsd-typography">
  1113. <p>插件初始化参数</p>
  1114. </div>
  1115. </li>
  1116. </ul>
  1117. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1118. </li>
  1119. </ul>
  1120. </section>
  1121. </section>
  1122. </div>
  1123. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  1124. <nav class="tsd-navigation primary">
  1125. <ul>
  1126. <li class=" ">
  1127. <a href="../index.html">Exports</a>
  1128. </li>
  1129. </ul>
  1130. </nav>
  1131. <nav class="tsd-navigation secondary menu-sticky">
  1132. <ul class="before-current">
  1133. </ul>
  1134. <ul class="current">
  1135. <li class="current tsd-kind-class">
  1136. <a href="localstream.html" class="tsd-kind-icon">Local<wbr>Stream</a>
  1137. <ul>
  1138. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  1139. <a href="localstream.html#audiomuted" class="tsd-kind-icon">audio<wbr>Muted</a>
  1140. </li>
  1141. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  1142. <a href="localstream.html#id" class="tsd-kind-icon">id</a>
  1143. </li>
  1144. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  1145. <a href="localstream.html#mediastream" class="tsd-kind-icon">media<wbr>Stream</a>
  1146. </li>
  1147. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  1148. <a href="localstream.html#userid" class="tsd-kind-icon">user<wbr>Id</a>
  1149. </li>
  1150. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
  1151. <a href="localstream.html#videomuted" class="tsd-kind-icon">video<wbr>Muted</a>
  1152. </li>
  1153. <li class=" tsd-kind-method tsd-parent-kind-class">
  1154. <a href="localstream.html#addtrack" class="tsd-kind-icon">add<wbr>Track</a>
  1155. </li>
  1156. <li class=" tsd-kind-method tsd-parent-kind-class">
  1157. <a href="localstream.html#destroy" class="tsd-kind-icon">destroy</a>
  1158. </li>
  1159. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1160. <a href="localstream.html#getaudiolevel" class="tsd-kind-icon">get<wbr>Audio<wbr>Level</a>
  1161. </li>
  1162. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1163. <a href="localstream.html#getmediatype" class="tsd-kind-icon">get<wbr>Media<wbr>Type</a>
  1164. </li>
  1165. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1166. <a href="localstream.html#getstats" class="tsd-kind-icon">get<wbr>Stats</a>
  1167. </li>
  1168. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
  1169. <a href="localstream.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a>
  1170. </li>
  1171. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
  1172. <a href="localstream.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a>
  1173. </li>
  1174. <li class=" tsd-kind-method tsd-parent-kind-class">
  1175. <a href="localstream.html#init" class="tsd-kind-icon">init</a>
  1176. </li>
  1177. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1178. <a href="localstream.html#muteaudio" class="tsd-kind-icon">mute<wbr>Audio</a>
  1179. </li>
  1180. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1181. <a href="localstream.html#mutevideo" class="tsd-kind-icon">mute<wbr>Video</a>
  1182. </li>
  1183. <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
  1184. <a href="localstream.html#off" class="tsd-kind-icon">off</a>
  1185. </li>
  1186. <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
  1187. <a href="localstream.html#on" class="tsd-kind-icon">on</a>
  1188. </li>
  1189. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1190. <a href="localstream.html#play" class="tsd-kind-icon">play</a>
  1191. </li>
  1192. <li class=" tsd-kind-method tsd-parent-kind-class">
  1193. <a href="localstream.html#removetrack" class="tsd-kind-icon">remove<wbr>Track</a>
  1194. </li>
  1195. <li class=" tsd-kind-method tsd-parent-kind-class">
  1196. <a href="localstream.html#replacetrack" class="tsd-kind-icon">replace<wbr>Track</a>
  1197. </li>
  1198. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1199. <a href="localstream.html#resume" class="tsd-kind-icon">resume</a>
  1200. </li>
  1201. <li class=" tsd-kind-method tsd-parent-kind-class">
  1202. <a href="localstream.html#setaudiolevel" class="tsd-kind-icon">set<wbr>Audio<wbr>Level</a>
  1203. </li>
  1204. <li class=" tsd-kind-method tsd-parent-kind-class">
  1205. <a href="localstream.html#setscreenprofile" class="tsd-kind-icon">set<wbr>Screen<wbr>Profile</a>
  1206. </li>
  1207. <li class=" tsd-kind-method tsd-parent-kind-class">
  1208. <a href="localstream.html#setvideoprofile" class="tsd-kind-icon">set<wbr>Video<wbr>Profile</a>
  1209. </li>
  1210. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1211. <a href="localstream.html#snapshot" class="tsd-kind-icon">snapshot</a>
  1212. </li>
  1213. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1214. <a href="localstream.html#stop" class="tsd-kind-icon">stop</a>
  1215. </li>
  1216. <li class=" tsd-kind-method tsd-parent-kind-class">
  1217. <a href="localstream.html#switchdevice" class="tsd-kind-icon">switch<wbr>Device</a>
  1218. </li>
  1219. <li class=" tsd-kind-method tsd-parent-kind-class">
  1220. <a href="localstream.html#switchimage" class="tsd-kind-icon">switch<wbr>Image</a>
  1221. </li>
  1222. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1223. <a href="localstream.html#unmuteaudio" class="tsd-kind-icon">unmute<wbr>Audio</a>
  1224. </li>
  1225. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
  1226. <a href="localstream.html#unmutevideo" class="tsd-kind-icon">unmute<wbr>Video</a>
  1227. </li>
  1228. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1229. <a href="localstream.html#use" class="tsd-kind-icon">use</a>
  1230. </li>
  1231. </ul>
  1232. </li>
  1233. </ul>
  1234. <ul class="after-current">
  1235. </ul>
  1236. </nav>
  1237. </div>
  1238. </div>
  1239. </div>
  1240. <footer class="with-border-bottom">
  1241. <div class="container">
  1242. <h2>Legend</h2>
  1243. <div class="tsd-legend-group">
  1244. <ul class="tsd-legend">
  1245. <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
  1246. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  1247. </ul>
  1248. <ul class="tsd-legend">
  1249. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  1250. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  1251. </ul>
  1252. <ul class="tsd-legend">
  1253. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
  1254. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
  1255. </ul>
  1256. <ul class="tsd-legend">
  1257. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  1258. </ul>
  1259. </div>
  1260. </div>
  1261. </footer>
  1262. <div class="container tsd-generator">
  1263. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  1264. </div>
  1265. <div class="overlay"></div>
  1266. <script src="../assets/js/main.js"></script>
  1267. </body>
  1268. </html>