remotestream.html 60 KB

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