remotestream.html 59 KB

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