remotestream.html 58 KB

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