remotestream.html 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872
  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>RemoteStream | @urtc/sdk-web</title>
  7. <meta name="description" content="Documentation for @urtc/sdk-web">
  8. <meta name="viewport" content="width=device-width, initial-scale=1">
  9. <link rel="stylesheet" href="../assets/css/main.css">
  10. </head>
  11. <body>
  12. <header>
  13. <div class="tsd-page-toolbar">
  14. <div class="container">
  15. <div class="table-wrap">
  16. <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
  17. <div class="field">
  18. <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
  19. <input id="tsd-search-field" type="text" />
  20. </div>
  21. <ul class="results">
  22. <li class="state loading">Preparing search index...</li>
  23. <li class="state failure">The search index is not available</li>
  24. </ul>
  25. <a href="../index.html" class="title">@urtc/sdk-web</a>
  26. </div>
  27. <div class="table-cell" id="tsd-widgets">
  28. <div id="tsd-filter">
  29. <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
  30. <div class="tsd-filter-group">
  31. <div class="tsd-select" id="tsd-filter-visibility">
  32. <span class="tsd-select-label">All</span>
  33. <ul class="tsd-select-list">
  34. <li data-value="public">Public</li>
  35. <li data-value="protected">Public/Protected</li>
  36. <li data-value="private" class="selected">All</li>
  37. </ul>
  38. </div>
  39. <input type="checkbox" id="tsd-filter-inherited" checked />
  40. <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
  41. <input type="checkbox" id="tsd-filter-externals" checked />
  42. <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
  43. </div>
  44. </div>
  45. <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
  46. </div>
  47. </div>
  48. </div>
  49. </div>
  50. <div class="tsd-page-title">
  51. <div class="container">
  52. <ul class="tsd-breadcrumb">
  53. <li>
  54. <a href="../index.html">Globals</a>
  55. </li>
  56. <li>
  57. <a href="remotestream.html">RemoteStream</a>
  58. </li>
  59. </ul>
  60. <h1>Class RemoteStream</h1>
  61. </div>
  62. </div>
  63. </header>
  64. <div class="container container-main">
  65. <div class="row">
  66. <div class="col-8 col-content">
  67. <section class="tsd-panel tsd-comment">
  68. <div class="tsd-comment tsd-typography">
  69. <div class="lead">
  70. <p>远端流,房间内其他用户发布的流,可通过 client 进行订阅</p>
  71. </div>
  72. </div>
  73. </section>
  74. <section class="tsd-panel tsd-hierarchy">
  75. <h3>Hierarchy</h3>
  76. <ul class="tsd-hierarchy">
  77. <li>
  78. <a href="stream.html" class="tsd-signature-type">Stream</a>
  79. <ul class="tsd-hierarchy">
  80. <li>
  81. <span class="target">RemoteStream</span>
  82. </li>
  83. </ul>
  84. </li>
  85. </ul>
  86. </section>
  87. <section class="tsd-panel-group tsd-index-group">
  88. <h2>Index</h2>
  89. <section class="tsd-panel tsd-index-panel">
  90. <div class="tsd-index-content">
  91. <section class="tsd-index-section tsd-is-external">
  92. <h3>Properties</h3>
  93. <ul class="tsd-index-list">
  94. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#audiomuted" class="tsd-kind-icon">audio<wbr>Muted</a></li>
  95. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#id" class="tsd-kind-icon">id</a></li>
  96. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#mediastream" class="tsd-kind-icon">media<wbr>Stream</a></li>
  97. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="remotestream.html#sourceaudiomuted" class="tsd-kind-icon">source<wbr>Audio<wbr>Muted</a></li>
  98. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="remotestream.html#sourcevideomuted" class="tsd-kind-icon">source<wbr>Video<wbr>Muted</a></li>
  99. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="remotestream.html#userid" class="tsd-kind-icon">user<wbr>Id</a></li>
  100. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#videomuted" class="tsd-kind-icon">video<wbr>Muted</a></li>
  101. </ul>
  102. </section>
  103. <section class="tsd-index-section tsd-is-external">
  104. <h3>Methods</h3>
  105. <ul class="tsd-index-list">
  106. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#destroy" class="tsd-kind-icon">destroy</a></li>
  107. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.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 tsd-is-external"><a href="remotestream.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 tsd-is-external"><a href="remotestream.html#getstats" class="tsd-kind-icon">get<wbr>Stats</a></li>
  110. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a></li>
  111. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a></li>
  112. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#muteaudio" class="tsd-kind-icon">mute<wbr>Audio</a></li>
  113. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#mutevideo" class="tsd-kind-icon">mute<wbr>Video</a></li>
  114. <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="remotestream.html#off" class="tsd-kind-icon">off</a></li>
  115. <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="remotestream.html#on" class="tsd-kind-icon">on</a></li>
  116. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#play" class="tsd-kind-icon">play</a></li>
  117. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#resume" class="tsd-kind-icon">resume</a></li>
  118. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="remotestream.html#setaudiovolume" class="tsd-kind-icon">set<wbr>Audio<wbr>Volume</a></li>
  119. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#stop" class="tsd-kind-icon">stop</a></li>
  120. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#unmuteaudio" class="tsd-kind-icon">unmute<wbr>Audio</a></li>
  121. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="remotestream.html#unmutevideo" class="tsd-kind-icon">unmute<wbr>Video</a></li>
  122. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="remotestream.html#use" class="tsd-kind-icon">use</a></li>
  123. </ul>
  124. </section>
  125. </div>
  126. </section>
  127. </section>
  128. <section class="tsd-panel-group tsd-member-group tsd-is-external">
  129. <h2>Properties</h2>
  130. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  131. <a name="audiomuted" class="tsd-anchor"></a>
  132. <h3>audio<wbr>Muted</h3>
  133. <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>
  134. <aside class="tsd-sources">
  135. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#audiomuted">audioMuted</a></p>
  136. </aside>
  137. <div class="tsd-comment tsd-typography">
  138. <div class="lead">
  139. <p>当前流是否 mute 了音频</p>
  140. </div>
  141. </div>
  142. </section>
  143. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  144. <a name="id" class="tsd-anchor"></a>
  145. <h3>id</h3>
  146. <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  147. <aside class="tsd-sources">
  148. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#id">id</a></p>
  149. </aside>
  150. <div class="tsd-comment tsd-typography">
  151. <div class="lead">
  152. <p>当前流ID</p>
  153. </div>
  154. </div>
  155. </section>
  156. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  157. <a name="mediastream" class="tsd-anchor"></a>
  158. <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> media<wbr>Stream</h3>
  159. <div class="tsd-signature tsd-kind-icon">media<wbr>Stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MediaStream</span></div>
  160. <aside class="tsd-sources">
  161. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#mediastream">mediaStream</a></p>
  162. </aside>
  163. <div class="tsd-comment tsd-typography">
  164. <div class="lead">
  165. <p>当前流包含的媒体流,关于媒体流,请详见 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaStream">MediaStream</a>。</p>
  166. </div>
  167. </div>
  168. </section>
  169. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
  170. <a name="sourceaudiomuted" class="tsd-anchor"></a>
  171. <h3>source<wbr>Audio<wbr>Muted</h3>
  172. <div class="tsd-signature tsd-kind-icon">source<wbr>Audio<wbr>Muted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
  173. <aside class="tsd-sources">
  174. </aside>
  175. <div class="tsd-comment tsd-typography">
  176. <div class="lead">
  177. <p>音频源是否已 mute,当源端 mute/unmute 音频时,本端将收到 <code>mute-audio</code> 或 <code>unmute-audio</code> 事件的通知,同时此值将变为对应值</p>
  178. </div>
  179. </div>
  180. </section>
  181. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
  182. <a name="sourcevideomuted" class="tsd-anchor"></a>
  183. <h3>source<wbr>Video<wbr>Muted</h3>
  184. <div class="tsd-signature tsd-kind-icon">source<wbr>Video<wbr>Muted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
  185. <aside class="tsd-sources">
  186. </aside>
  187. <div class="tsd-comment tsd-typography">
  188. <div class="lead">
  189. <p>视频源是否已 mute,当源端 mute/unmute 视频时,本端将收到 <code>mute-video</code> 或 <code>unmute-video</code> 事件的通知,同时此值将变为对应值</p>
  190. </div>
  191. </div>
  192. </section>
  193. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
  194. <a name="userid" class="tsd-anchor"></a>
  195. <h3>user<wbr>Id</h3>
  196. <div class="tsd-signature tsd-kind-icon">user<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  197. <aside class="tsd-sources">
  198. </aside>
  199. <div class="tsd-comment tsd-typography">
  200. <div class="lead">
  201. <p>该流所属用户的ID</p>
  202. </div>
  203. </div>
  204. </section>
  205. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  206. <a name="videomuted" class="tsd-anchor"></a>
  207. <h3>video<wbr>Muted</h3>
  208. <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>
  209. <aside class="tsd-sources">
  210. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#videomuted">videoMuted</a></p>
  211. </aside>
  212. <div class="tsd-comment tsd-typography">
  213. <div class="lead">
  214. <p>当前流是否 mute 了视频</p>
  215. </div>
  216. </div>
  217. </section>
  218. </section>
  219. <section class="tsd-panel-group tsd-member-group tsd-is-external">
  220. <h2>Methods</h2>
  221. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  222. <a name="destroy" class="tsd-anchor"></a>
  223. <h3>destroy</h3>
  224. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  225. <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>
  226. </ul>
  227. <ul class="tsd-descriptions">
  228. <li class="tsd-description">
  229. <aside class="tsd-sources">
  230. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#destroy">destroy</a></p>
  231. </aside>
  232. <div class="tsd-comment tsd-typography">
  233. <div class="lead">
  234. <p>销毁当前流,一般在本地流不再被使用时,可调用此方法销毁,解除摄像头或麦克风设备的占用。</p>
  235. <blockquote>
  236. <p>注:远端流,不需要手动调用此方法</p>
  237. </blockquote>
  238. </div>
  239. <dl class="tsd-comment-tags">
  240. <dt>example</dt>
  241. <dd><pre><code class="language-js">stream.destroy();</code></pre>
  242. </dd>
  243. </dl>
  244. </div>
  245. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  246. </li>
  247. </ul>
  248. </section>
  249. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  250. <a name="getaudiolevel" class="tsd-anchor"></a>
  251. <h3>get<wbr>Audio<wbr>Level</h3>
  252. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  253. <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>
  254. </ul>
  255. <ul class="tsd-descriptions">
  256. <li class="tsd-description">
  257. <aside class="tsd-sources">
  258. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#getaudiolevel">getAudioLevel</a></p>
  259. </aside>
  260. <div class="tsd-comment tsd-typography">
  261. <div class="lead">
  262. <p>获取当前流的音量大小,只有当本地流或远端流中有音频数据才有效。</p>
  263. </div>
  264. <dl class="tsd-comment-tags">
  265. <dt>example</dt>
  266. <dd><pre><code class="language-js"><span class="hljs-built_in">setInterval</span>(<span class="hljs-function">() =&gt;</span> {
  267. <span class="hljs-keyword">const</span> level = stream.getAudioLevel();
  268. <span class="hljs-keyword">if</span> (level &gt; <span class="hljs-number">0</span>) {
  269. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`user <span class="hljs-subst">${stream.userId}</span> is speaking`</span>);
  270. }
  271. }, <span class="hljs-number">200</span>);</code></pre>
  272. </dd>
  273. </dl>
  274. </div>
  275. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
  276. </li>
  277. </ul>
  278. </section>
  279. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  280. <a name="getmediatype" class="tsd-anchor"></a>
  281. <h3>get<wbr>Media<wbr>Type</h3>
  282. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  283. <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">MediaType</a></li>
  284. </ul>
  285. <ul class="tsd-descriptions">
  286. <li class="tsd-description">
  287. <aside class="tsd-sources">
  288. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#getmediatype">getMediaType</a></p>
  289. </aside>
  290. <div class="tsd-comment tsd-typography">
  291. <div class="lead">
  292. <p>获取流的媒体类型</p>
  293. </div>
  294. <dl class="tsd-comment-tags">
  295. <dt>example</dt>
  296. <dd><pre><code class="language-js"><span class="hljs-keyword">const</span> type = stream.getMediaType();</code></pre>
  297. </dd>
  298. </dl>
  299. </div>
  300. <h4 class="tsd-returns-title">Returns <a href="../index.html#mediatype" class="tsd-signature-type">MediaType</a></h4>
  301. </li>
  302. </ul>
  303. </section>
  304. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  305. <a name="getstats" class="tsd-anchor"></a>
  306. <h3>get<wbr>Stats</h3>
  307. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  308. <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">StreamStats</a><span class="tsd-signature-symbol">&gt;</span></li>
  309. </ul>
  310. <ul class="tsd-descriptions">
  311. <li class="tsd-description">
  312. <aside class="tsd-sources">
  313. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#getstats">getStats</a></p>
  314. </aside>
  315. <div class="tsd-comment tsd-typography">
  316. <div class="lead">
  317. <p>获取流发布或订阅后的统计数据</p>
  318. </div>
  319. <dl class="tsd-comment-tags">
  320. <dt>example</dt>
  321. <dd><pre><code class="language-js">stream
  322. .getStats()
  323. .then(<span class="hljs-function">(<span class="hljs-params">stats</span>) =&gt;</span> {
  324. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;当前流的统计数据为: &#x27;</span>, stats);
  325. });</code></pre>
  326. </dd>
  327. </dl>
  328. </div>
  329. <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">StreamStats</a><span class="tsd-signature-symbol">&gt;</span></h4>
  330. </li>
  331. </ul>
  332. </section>
  333. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  334. <a name="hasaudio" class="tsd-anchor"></a>
  335. <h3>has<wbr>Audio</h3>
  336. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  337. <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>
  338. </ul>
  339. <ul class="tsd-descriptions">
  340. <li class="tsd-description">
  341. <aside class="tsd-sources">
  342. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#hasaudio">hasAudio</a></p>
  343. </aside>
  344. <div class="tsd-comment tsd-typography">
  345. <div class="lead">
  346. <p>判断当前流是否有音频</p>
  347. </div>
  348. <dl class="tsd-comment-tags">
  349. <dt>example</dt>
  350. <dd><pre><code class="language-js"><span class="hljs-keyword">const</span> result = stream.hasAudio();</code></pre>
  351. </dd>
  352. </dl>
  353. </div>
  354. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  355. </li>
  356. </ul>
  357. </section>
  358. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  359. <a name="hasvideo" class="tsd-anchor"></a>
  360. <h3>has<wbr>Video</h3>
  361. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  362. <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>
  363. </ul>
  364. <ul class="tsd-descriptions">
  365. <li class="tsd-description">
  366. <aside class="tsd-sources">
  367. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#hasvideo">hasVideo</a></p>
  368. </aside>
  369. <div class="tsd-comment tsd-typography">
  370. <div class="lead">
  371. <p>判断当前流是否有视频</p>
  372. </div>
  373. <dl class="tsd-comment-tags">
  374. <dt>example</dt>
  375. <dd><pre><code class="language-js"><span class="hljs-keyword">const</span> result = stream.hasVideo();</code></pre>
  376. </dd>
  377. </dl>
  378. </div>
  379. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  380. </li>
  381. </ul>
  382. </section>
  383. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  384. <a name="muteaudio" class="tsd-anchor"></a>
  385. <h3>mute<wbr>Audio</h3>
  386. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  387. <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>
  388. </ul>
  389. <ul class="tsd-descriptions">
  390. <li class="tsd-description">
  391. <aside class="tsd-sources">
  392. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#muteaudio">muteAudio</a></p>
  393. </aside>
  394. <div class="tsd-comment tsd-typography">
  395. <div class="lead">
  396. <p>mute 当前流的音频</p>
  397. <ul>
  398. <li>本地流调用此方法时,将不向服务器推送音频数据,远端用户将收到 <code>mute-audio</code> 的事件通知</li>
  399. <li>远端流调用此方法时,仅为不从服务器拉取音频数据,并无事件通知远端用户</li>
  400. </ul>
  401. </div>
  402. <dl class="tsd-comment-tags">
  403. <dt>example</dt>
  404. <dd><pre><code class="language-js"><span class="hljs-keyword">const</span> result = stream.muteAudio();
  405. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`stream&#x27;audio is muted <span class="hljs-subst">${stream.audioMuted}</span>`</span>);</code></pre>
  406. </dd>
  407. </dl>
  408. </div>
  409. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  410. <p>操作是否成功</p>
  411. </li>
  412. </ul>
  413. </section>
  414. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  415. <a name="mutevideo" class="tsd-anchor"></a>
  416. <h3>mute<wbr>Video</h3>
  417. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  418. <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>
  419. </ul>
  420. <ul class="tsd-descriptions">
  421. <li class="tsd-description">
  422. <aside class="tsd-sources">
  423. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#mutevideo">muteVideo</a></p>
  424. </aside>
  425. <div class="tsd-comment tsd-typography">
  426. <div class="lead">
  427. <p>mute 当前流的视频</p>
  428. <ul>
  429. <li>本地流调用此方法时,将不向服务器推送视频数据,远端用户将收到 <code>mute-video</code> 的事件通知</li>
  430. <li>远端流调用此方法时,仅为不从服务器拉取视频数据,并无事件通知远端用户</li>
  431. </ul>
  432. </div>
  433. <dl class="tsd-comment-tags">
  434. <dt>example</dt>
  435. <dd><pre><code class="language-js"><span class="hljs-keyword">const</span> result = stream.muteVideo();
  436. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`stream&#x27;s video is muted <span class="hljs-subst">${stream.videoMuted}</span>`</span>);</code></pre>
  437. </dd>
  438. </dl>
  439. </div>
  440. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  441. <p>操作是否成功</p>
  442. </li>
  443. </ul>
  444. </section>
  445. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
  446. <a name="off" class="tsd-anchor"></a>
  447. <h3>off</h3>
  448. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
  449. <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><a href="../interfaces/listener.html" class="tsd-signature-type">Listener</a><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>
  450. </ul>
  451. <ul class="tsd-descriptions">
  452. <li class="tsd-description">
  453. <aside class="tsd-sources">
  454. <p>Inherited from EventEmitter.off</p>
  455. </aside>
  456. <div class="tsd-comment tsd-typography">
  457. <div class="lead">
  458. <p>取消监听流对象事件</p>
  459. </div>
  460. </div>
  461. <h4 class="tsd-type-parameters-title">Type parameters</h4>
  462. <ul class="tsd-type-parameters">
  463. <li>
  464. <h4>T<span class="tsd-signature-symbol">: </span><a href="../index.html#rtceventtype" class="tsd-signature-type">RtcEventType</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"*"</span></h4>
  465. </li>
  466. </ul>
  467. <h4 class="tsd-parameters-title">Parameters</h4>
  468. <ul class="tsd-parameters">
  469. <li>
  470. <h5>type: <span class="tsd-signature-type">T</span></h5>
  471. <div class="tsd-comment tsd-typography">
  472. <p>流对象事件类型,特别的,当为 &#39;*&#39; 时,取消监听所有事件</p>
  473. </div>
  474. </li>
  475. <li>
  476. <h5>listener: <a href="../interfaces/listener.html" class="tsd-signature-type">Listener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
  477. <div class="tsd-comment tsd-typography">
  478. <p>流对象事件监听函数</p>
  479. </div>
  480. </li>
  481. </ul>
  482. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventEmitter</span></h4>
  483. </li>
  484. </ul>
  485. </section>
  486. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
  487. <a name="on" class="tsd-anchor"></a>
  488. <h3>on</h3>
  489. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
  490. <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><a href="../interfaces/listener.html" class="tsd-signature-type">Listener</a><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>
  491. </ul>
  492. <ul class="tsd-descriptions">
  493. <li class="tsd-description">
  494. <aside class="tsd-sources">
  495. <p>Inherited from EventEmitter.on</p>
  496. </aside>
  497. <div class="tsd-comment tsd-typography">
  498. <div class="lead">
  499. <p>监听流对象事件</p>
  500. </div>
  501. </div>
  502. <h4 class="tsd-type-parameters-title">Type parameters</h4>
  503. <ul class="tsd-type-parameters">
  504. <li>
  505. <h4>T<span class="tsd-signature-symbol">: </span><a href="../index.html#rtceventtype" class="tsd-signature-type">RtcEventType</a></h4>
  506. </li>
  507. </ul>
  508. <h4 class="tsd-parameters-title">Parameters</h4>
  509. <ul class="tsd-parameters">
  510. <li>
  511. <h5>type: <span class="tsd-signature-type">T</span></h5>
  512. <div class="tsd-comment tsd-typography">
  513. <p>流事件类型</p>
  514. </div>
  515. </li>
  516. <li>
  517. <h5>listener: <a href="../interfaces/listener.html" class="tsd-signature-type">Listener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
  518. <div class="tsd-comment tsd-typography">
  519. <p>流事件监听函数</p>
  520. </div>
  521. </li>
  522. </ul>
  523. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventEmitter</span></h4>
  524. </li>
  525. </ul>
  526. </section>
  527. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  528. <a name="play" class="tsd-anchor"></a>
  529. <h3>play</h3>
  530. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  531. <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">HTMLElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/playoptions.html" class="tsd-signature-type">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>
  532. </ul>
  533. <ul class="tsd-descriptions">
  534. <li class="tsd-description">
  535. <aside class="tsd-sources">
  536. <p>Inherited from <a href="remotestream.html">RemoteStream</a>.<a href="remotestream.html#play">play</a></p>
  537. </aside>
  538. <div class="tsd-comment tsd-typography">
  539. <div class="lead">
  540. <p>播放当前流</p>
  541. </div>
  542. <dl class="tsd-comment-tags">
  543. <dt>example</dt>
  544. <dd><pre><code class="language-js"><span class="hljs-keyword">const</span> container = <span class="hljs-string">&#x27;xxx&#x27;</span>; <span class="hljs-comment">// 比如 id 为 xxx 的 div 元素</span>
  545. stream
  546. .play(container)
  547. .catch(<span class="hljs-function">(<span class="hljs-params">err</span>) =&gt;</span> {
  548. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`播放失败: <span class="hljs-subst">${err}</span>`</span>); <span class="hljs-comment">// 一般由于浏览器对自动播放的限制导致播放失败</span>
  549. });</code></pre>
  550. </dd>
  551. <dt>reject</dt>
  552. <dd><p><a href="rtcerror.html">RtcError</a></p>
  553. </dd>
  554. </dl>
  555. </div>
  556. <h4 class="tsd-parameters-title">Parameters</h4>
  557. <ul class="tsd-parameters">
  558. <li>
  559. <h5>container: <span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
  560. <div class="tsd-comment tsd-typography">
  561. <p>播放音视频时,包裹 video 标签所用的容器元素或容器元素的 ID</p>
  562. </div>
  563. </li>
  564. <li>
  565. <h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="../interfaces/playoptions.html" class="tsd-signature-type">PlayOptions</a></h5>
  566. <div class="tsd-comment tsd-typography">
  567. <p>其他播放参数,参见<a href="../interfaces/playoptions.html">PlayOptions</a></p>
  568. </div>
  569. </li>
  570. </ul>
  571. <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>
  572. </li>
  573. </ul>
  574. </section>
  575. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  576. <a name="resume" class="tsd-anchor"></a>
  577. <h3>resume</h3>
  578. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  579. <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>
  580. </ul>
  581. <ul class="tsd-descriptions">
  582. <li class="tsd-description">
  583. <aside class="tsd-sources">
  584. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#resume">resume</a></p>
  585. </aside>
  586. <div class="tsd-comment tsd-typography">
  587. <div class="lead">
  588. <p>恢复播放流,一般由于浏览器限制无法自动播放时,可提示用户手动触发该方法进行恢复播放</p>
  589. </div>
  590. <dl class="tsd-comment-tags">
  591. <dt>example</dt>
  592. <dd><pre><code class="language-js">stream
  593. .resume()
  594. .catch(<span class="hljs-function">(<span class="hljs-params">err</span>) =&gt;</span> {
  595. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`恢复播放失败:<span class="hljs-subst">${err}</span>`</span>);
  596. });</code></pre>
  597. </dd>
  598. </dl>
  599. </div>
  600. <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>
  601. </li>
  602. </ul>
  603. </section>
  604. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
  605. <a name="setaudiovolume" class="tsd-anchor"></a>
  606. <h3>set<wbr>Audio<wbr>Volume</h3>
  607. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
  608. <li class="tsd-signature tsd-kind-icon">set<wbr>Audio<wbr>Volume<span class="tsd-signature-symbol">(</span>volume<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>
  609. </ul>
  610. <ul class="tsd-descriptions">
  611. <li class="tsd-description">
  612. <aside class="tsd-sources">
  613. </aside>
  614. <div class="tsd-comment tsd-typography">
  615. <div class="lead">
  616. <p>设置输出音量,默认为 100</p>
  617. </div>
  618. <dl class="tsd-comment-tags">
  619. <dt>throws</dt>
  620. <dd><p>RtcError</p>
  621. </dd>
  622. <dt>example</dt>
  623. <dd><pre><code class="language-js">stream.setAudioVolume(<span class="hljs-number">50</span>);</code></pre>
  624. </dd>
  625. </dl>
  626. </div>
  627. <h4 class="tsd-parameters-title">Parameters</h4>
  628. <ul class="tsd-parameters">
  629. <li>
  630. <h5>volume: <span class="tsd-signature-type">number</span></h5>
  631. <div class="tsd-comment tsd-typography">
  632. <p>音量大小, 可设范围[0-100]</p>
  633. </div>
  634. </li>
  635. </ul>
  636. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  637. </li>
  638. </ul>
  639. </section>
  640. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  641. <a name="stop" class="tsd-anchor"></a>
  642. <h3>stop</h3>
  643. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  644. <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>
  645. </ul>
  646. <ul class="tsd-descriptions">
  647. <li class="tsd-description">
  648. <aside class="tsd-sources">
  649. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#stop">stop</a></p>
  650. </aside>
  651. <div class="tsd-comment tsd-typography">
  652. <div class="lead">
  653. <p>停止播放当前流</p>
  654. </div>
  655. <dl class="tsd-comment-tags">
  656. <dt>example</dt>
  657. <dd><pre><code class="language-js">stream.stop();</code></pre>
  658. </dd>
  659. </dl>
  660. </div>
  661. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  662. </li>
  663. </ul>
  664. </section>
  665. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  666. <a name="unmuteaudio" class="tsd-anchor"></a>
  667. <h3>unmute<wbr>Audio</h3>
  668. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  669. <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>
  670. </ul>
  671. <ul class="tsd-descriptions">
  672. <li class="tsd-description">
  673. <aside class="tsd-sources">
  674. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#unmuteaudio">unmuteAudio</a></p>
  675. </aside>
  676. <div class="tsd-comment tsd-typography">
  677. <div class="lead">
  678. <p>unmute 当前流的音频</p>
  679. <ul>
  680. <li>本地流调用此方法时,将向服务器推送音频数据,远端用户将收到 <code>unmute-audio</code> 的事件通知</li>
  681. <li>远端流调用此方法时,会从服务器拉取音频数据,并无事件通知远端用户</li>
  682. </ul>
  683. </div>
  684. <dl class="tsd-comment-tags">
  685. <dt>example</dt>
  686. <dd><pre><code class="language-js"><span class="hljs-keyword">const</span> result = stream.unmuteAudio();
  687. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`stream&#x27;s audio is muted <span class="hljs-subst">${stream.audioMuted}</span>`</span>);</code></pre>
  688. </dd>
  689. </dl>
  690. </div>
  691. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  692. <p>操作是否成功</p>
  693. </li>
  694. </ul>
  695. </section>
  696. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  697. <a name="unmutevideo" class="tsd-anchor"></a>
  698. <h3>unmute<wbr>Video</h3>
  699. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  700. <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>
  701. </ul>
  702. <ul class="tsd-descriptions">
  703. <li class="tsd-description">
  704. <aside class="tsd-sources">
  705. <p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#unmutevideo">unmuteVideo</a></p>
  706. </aside>
  707. <div class="tsd-comment tsd-typography">
  708. <div class="lead">
  709. <p>unmute 当前流的视频</p>
  710. <ul>
  711. <li>本地流调用此方法时,将向服务器推送视频数据,远端用户将收到 <code>unmute-video</code> 的事件通知</li>
  712. <li>远端流调用此方法时,会从服务器拉取视频数据,并无事件通知远端用户</li>
  713. </ul>
  714. </div>
  715. <dl class="tsd-comment-tags">
  716. <dt>example</dt>
  717. <dd><pre><code class="language-js"><span class="hljs-keyword">const</span> result = stream.unmuteVideo();
  718. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`stream&#x27;s video is muted <span class="hljs-subst">${stream.videoMuted}</span>`</span>);</code></pre>
  719. </dd>
  720. </dl>
  721. </div>
  722. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
  723. <p>操作是否成功</p>
  724. </li>
  725. </ul>
  726. </section>
  727. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
  728. <a name="use" class="tsd-anchor"></a>
  729. <h3><span class="tsd-flag ts-flagStatic">Static</span> use</h3>
  730. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
  731. <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">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>
  732. </ul>
  733. <ul class="tsd-descriptions">
  734. <li class="tsd-description">
  735. <aside class="tsd-sources">
  736. </aside>
  737. <div class="tsd-comment tsd-typography">
  738. <div class="lead">
  739. <p>加载流插件,使用插件功能</p>
  740. </div>
  741. </div>
  742. <h4 class="tsd-parameters-title">Parameters</h4>
  743. <ul class="tsd-parameters">
  744. <li>
  745. <h5>plugin: <a href="../interfaces/streamplugin.html" class="tsd-signature-type">StreamPlugin</a></h5>
  746. <div class="tsd-comment tsd-typography">
  747. <p>插件</p>
  748. </div>
  749. </li>
  750. <li>
  751. <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
  752. <div class="tsd-comment tsd-typography">
  753. <p>插件初始化参数</p>
  754. </div>
  755. </li>
  756. </ul>
  757. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  758. </li>
  759. </ul>
  760. </section>
  761. </section>
  762. </div>
  763. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  764. <nav class="tsd-navigation primary">
  765. <ul>
  766. <li class="globals ">
  767. <a href="../index.html"><em>Globals</em></a>
  768. </li>
  769. </ul>
  770. </nav>
  771. <nav class="tsd-navigation secondary menu-sticky">
  772. <ul class="before-current">
  773. </ul>
  774. <ul class="current">
  775. <li class="current tsd-kind-class tsd-is-external">
  776. <a href="remotestream.html" class="tsd-kind-icon">Remote<wbr>Stream</a>
  777. <ul>
  778. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  779. <a href="remotestream.html#audiomuted" class="tsd-kind-icon">audio<wbr>Muted</a>
  780. </li>
  781. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  782. <a href="remotestream.html#id" class="tsd-kind-icon">id</a>
  783. </li>
  784. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  785. <a href="remotestream.html#mediastream" class="tsd-kind-icon">media<wbr>Stream</a>
  786. </li>
  787. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
  788. <a href="remotestream.html#sourceaudiomuted" class="tsd-kind-icon">source<wbr>Audio<wbr>Muted</a>
  789. </li>
  790. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
  791. <a href="remotestream.html#sourcevideomuted" class="tsd-kind-icon">source<wbr>Video<wbr>Muted</a>
  792. </li>
  793. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
  794. <a href="remotestream.html#userid" class="tsd-kind-icon">user<wbr>Id</a>
  795. </li>
  796. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  797. <a href="remotestream.html#videomuted" class="tsd-kind-icon">video<wbr>Muted</a>
  798. </li>
  799. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  800. <a href="remotestream.html#destroy" class="tsd-kind-icon">destroy</a>
  801. </li>
  802. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  803. <a href="remotestream.html#getaudiolevel" class="tsd-kind-icon">get<wbr>Audio<wbr>Level</a>
  804. </li>
  805. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  806. <a href="remotestream.html#getmediatype" class="tsd-kind-icon">get<wbr>Media<wbr>Type</a>
  807. </li>
  808. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  809. <a href="remotestream.html#getstats" class="tsd-kind-icon">get<wbr>Stats</a>
  810. </li>
  811. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  812. <a href="remotestream.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a>
  813. </li>
  814. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  815. <a href="remotestream.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a>
  816. </li>
  817. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  818. <a href="remotestream.html#muteaudio" class="tsd-kind-icon">mute<wbr>Audio</a>
  819. </li>
  820. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  821. <a href="remotestream.html#mutevideo" class="tsd-kind-icon">mute<wbr>Video</a>
  822. </li>
  823. <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
  824. <a href="remotestream.html#off" class="tsd-kind-icon">off</a>
  825. </li>
  826. <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
  827. <a href="remotestream.html#on" class="tsd-kind-icon">on</a>
  828. </li>
  829. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  830. <a href="remotestream.html#play" class="tsd-kind-icon">play</a>
  831. </li>
  832. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  833. <a href="remotestream.html#resume" class="tsd-kind-icon">resume</a>
  834. </li>
  835. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
  836. <a href="remotestream.html#setaudiovolume" class="tsd-kind-icon">set<wbr>Audio<wbr>Volume</a>
  837. </li>
  838. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  839. <a href="remotestream.html#stop" class="tsd-kind-icon">stop</a>
  840. </li>
  841. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  842. <a href="remotestream.html#unmuteaudio" class="tsd-kind-icon">unmute<wbr>Audio</a>
  843. </li>
  844. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  845. <a href="remotestream.html#unmutevideo" class="tsd-kind-icon">unmute<wbr>Video</a>
  846. </li>
  847. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
  848. <a href="remotestream.html#use" class="tsd-kind-icon">use</a>
  849. </li>
  850. </ul>
  851. </li>
  852. </ul>
  853. <ul class="after-current">
  854. </ul>
  855. </nav>
  856. </div>
  857. </div>
  858. </div>
  859. <footer class="with-border-bottom">
  860. <div class="container">
  861. <h2>Legend</h2>
  862. <div class="tsd-legend-group">
  863. </div>
  864. </div>
  865. </footer>
  866. <div class="container tsd-generator">
  867. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  868. </div>
  869. <div class="overlay"></div>
  870. <script src="../assets/js/main.js"></script>
  871. </body>
  872. </html>