remotestream.html 56 KB

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