ホーム エクスプローラ ヘルプ
サインイン
githab
/
urtc-sdk-web
2
0
Fork 0
ファイル 課題 0 プルリクエスト 0 Wiki
ツリー: 5316b4961e
ブランチ タグ
urtc-sdk-web
/
docs
/
classes
/
stream.html

stream.html 50 KB
履歴 Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826 
  1. <!doctype html>
    2. 

  2. <html class="default no-js">
    3. 

  3. <head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    6. 

  6. 	<title>Stream | @urtc/sdk-web</title>
    7. 

  7. 	<meta name="description" content="Documentation for @urtc/sdk-web">
    8. 

  8. 	<meta name="viewport" content="width=device-width, initial-scale=1">
    9. 

  9. 	<link rel="stylesheet" href="../assets/css/main.css">
    10. 

  10. 	<script async src="../assets/js/search.js" id="search-script"></script>
    11. 

  11. </head>
    12. 

  12. <body>
    13. 

  13. <header>
    14. 

  14. 	<div class="tsd-page-toolbar">
    15. 

  15. 		<div class="container">
    16. 

  16. 			<div class="table-wrap">
    17. 

  17. 				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
    18. 

  18. 					<div class="field">
    19. 

  19. 						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
    20. 

  20. 						<input id="tsd-search-field" type="text" />
    21. 

  21. 					</div>
    22. 

  22. 					<ul class="results">
    23. 

  23. 						<li class="state loading">Preparing search index...</li>
    24. 

  24. 						<li class="state failure">The search index is not available</li>
    25. 

  25. 					</ul>
    26. 

  26. 					<a href="../index.html" class="title">@urtc/sdk-web</a>
    27. 

  27. 				</div>
    28. 

  28. 				<div class="table-cell" id="tsd-widgets">
    29. 

  29. 					<div id="tsd-filter">
    30. 

  30. 						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
    31. 

  31. 						<div class="tsd-filter-group">
    32. 

  32. 							<div class="tsd-select" id="tsd-filter-visibility">
    33. 

  33. 								<span class="tsd-select-label">All</span>
    34. 

  34. 								<ul class="tsd-select-list">
    35. 

  35. 									<li data-value="public">Public</li>
    36. 

  36. 									<li data-value="protected">Public/Protected</li>
    37. 

  37. 									<li data-value="private" class="selected">All</li>
    38. 

  38. 								</ul>
    39. 

  39. 							</div>
    40. 

  40. 							<input type="checkbox" id="tsd-filter-inherited" checked />
    41. 

  41. 							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
    42. 

  42. 							<input type="checkbox" id="tsd-filter-externals" checked />
    43. 

  43. 							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
    44. 

  44. 						</div>
    45. 

  45. 					</div>
    46. 

  46. 					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
    47. 

  47. 				</div>
    48. 

  48. 			</div>
    49. 

  49. 		</div>
    50. 

  50. 	</div>
    51. 

  51. 	<div class="tsd-page-title">
    52. 

  52. 		<div class="container">
    53. 

  53. 			<ul class="tsd-breadcrumb">
    54. 

  54. 				<li>
    55. 

  55. 					<a href="../index.html">@urtc/sdk-web</a>
    56. 

  56. 				</li>
    57. 

  57. 				<li>
    58. 

  58. 					<a href="stream.html">Stream</a>
    59. 

  59. 				</li>
    60. 

  60. 			</ul>
    61. 

  61. 			<h1>Class Stream</h1>
    62. 

  62. 		</div>
    63. 

  63. 	</div>
    64. 

  64. </header>
    65. 

  65. <div class="container container-main">
    66. 

  66. 	<div class="row">
    67. 

  67. 		<div class="col-8 col-content">
    68. 

  68. 			<section class="tsd-panel tsd-comment">
    69. 

  69. 				<div class="tsd-comment tsd-typography">
    70. 

  70. 					<div class="lead">
    71. 

  71. 						<p>LocalStream 和 RemoteStream 的基类</p>
    72. 

  72. 					</div>
    73. 

  73. 				</div>
    74. 

  74. 			</section>
    75. 

  75. 			<section class="tsd-panel tsd-hierarchy">
    76. 

  76. 				<h3>Hierarchy</h3>
    77. 

  77. 				<ul class="tsd-hierarchy">
    78. 

  78. 					<li>
    79. 

  79. 						<span class="tsd-signature-type">EventEmitter</span>
    80. 

  80. 						<ul class="tsd-hierarchy">
    81. 

  81. 							<li>
    82. 

  82. 								<span class="target">Stream</span>
    83. 

  83. 								<ul class="tsd-hierarchy">
    84. 

  84. 									<li>
    85. 

  85. 										<a href="localstream.html" class="tsd-signature-type" data-tsd-kind="Class">LocalStream</a>
    86. 

  86. 									</li>
    87. 

  87. 									<li>
    88. 

  88. 										<a href="remotestream.html" class="tsd-signature-type" data-tsd-kind="Class">RemoteStream</a>
    89. 

  89. 									</li>
    90. 

  90. 								</ul>
    91. 

  91. 							</li>
    92. 

  92. 						</ul>
    93. 

  93. 					</li>
    94. 

  94. 				</ul>
    95. 

  95. 			</section>
    96. 

  96. 			<section class="tsd-panel-group tsd-index-group">
    97. 

  97. 				<h2>Index</h2>
    98. 

  98. 				<section class="tsd-panel tsd-index-panel">
    99. 

  99. 					<div class="tsd-index-content">
    100. 

  100. 						<section class="tsd-index-section ">
    101. 

  101. 							<h3>Properties</h3>
    102. 

  102. 							<ul class="tsd-index-list">
    103. 

  103. 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#audiomuted" class="tsd-kind-icon">audio<wbr>Muted</a></li>
    104. 

  104. 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#id" class="tsd-kind-icon">id</a></li>
    105. 

  105. 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#mediastream" class="tsd-kind-icon">media<wbr>Stream</a></li>
    106. 

  106. 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#userid" class="tsd-kind-icon">user<wbr>Id</a></li>
    107. 

  107. 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#videomuted" class="tsd-kind-icon">video<wbr>Muted</a></li>
    108. 

  108. 							</ul>
    109. 

  109. 						</section>
    110. 

  110. 						<section class="tsd-index-section ">
    111. 

  111. 							<h3>Methods</h3>
    112. 

  112. 							<ul class="tsd-index-list">
    113. 

  113. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#destroy" class="tsd-kind-icon">destroy</a></li>
    114. 

  114. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#getaudiolevel" class="tsd-kind-icon">get<wbr>Audio<wbr>Level</a></li>
    115. 

  115. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#getmediatype" class="tsd-kind-icon">get<wbr>Media<wbr>Type</a></li>
    116. 

  116. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#getstats" class="tsd-kind-icon">get<wbr>Stats</a></li>
    117. 

  117. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a></li>
    118. 

  118. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a></li>
    119. 

  119. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#muteaudio" class="tsd-kind-icon">mute<wbr>Audio</a></li>
    120. 

  120. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#mutevideo" class="tsd-kind-icon">mute<wbr>Video</a></li>
    121. 

  121. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="stream.html#off" class="tsd-kind-icon">off</a></li>
    122. 

  122. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="stream.html#on" class="tsd-kind-icon">on</a></li>
    123. 

  123. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#play" class="tsd-kind-icon">play</a></li>
    124. 

  124. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#resume" class="tsd-kind-icon">resume</a></li>
    125. 

  125. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#snapshot" class="tsd-kind-icon">snapshot</a></li>
    126. 

  126. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#stop" class="tsd-kind-icon">stop</a></li>
    127. 

  127. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#unmuteaudio" class="tsd-kind-icon">unmute<wbr>Audio</a></li>
    128. 

  128. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="stream.html#unmutevideo" class="tsd-kind-icon">unmute<wbr>Video</a></li>
    129. 

  129. 							</ul>
    130. 

  130. 						</section>
    131. 

  131. 					</div>
    132. 

  132. 				</section>
    133. 

  133. 			</section>
    134. 

  134. 			<section class="tsd-panel-group tsd-member-group ">
    135. 

  135. 				<h2>Properties</h2>
    136. 

  136. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
    137. 

  137. 					<a name="audiomuted" class="tsd-anchor"></a>
    138. 

  138. 					<h3>audio<wbr>Muted</h3>
    139. 

  139. 					<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>
    140. 

  140. 					<aside class="tsd-sources">
    141. 

  141. 					</aside>
    142. 

  142. 					<div class="tsd-comment tsd-typography">
    143. 

  143. 						<div class="lead">
    144. 

  144. 							<p>当前流是否 mute 了音频</p>
    145. 

  145. 						</div>
    146. 

  146. 					</div>
    147. 

  147. 				</section>
    148. 

  148. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
    149. 

  149. 					<a name="id" class="tsd-anchor"></a>
    150. 

  150. 					<h3>id</h3>
    151. 

  151. 					<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
    152. 

  152. 					<aside class="tsd-sources">
    153. 

  153. 					</aside>
    154. 

  154. 					<div class="tsd-comment tsd-typography">
    155. 

  155. 						<div class="lead">
    156. 

  156. 							<p>当前流ID</p>
    157. 

  157. 						</div>
    158. 

  158. 					</div>
    159. 

  159. 				</section>
    160. 

  160. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
    161. 

  161. 					<a name="mediastream" class="tsd-anchor"></a>
    162. 

  162. 					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> media<wbr>Stream</h3>
    163. 

  163. 					<div class="tsd-signature tsd-kind-icon">media<wbr>Stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MediaStream</span></div>
    164. 

  164. 					<aside class="tsd-sources">
    165. 

  165. 					</aside>
    166. 

  166. 					<div class="tsd-comment tsd-typography">
    167. 

  167. 						<div class="lead">
    168. 

  168. 							<p>当前流包含的媒体流，关于媒体流，请详见 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaStream">MediaStream</a>。</p>
    169. 

  169. 						</div>
    170. 

  170. 					</div>
    171. 

  171. 				</section>
    172. 

  172. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
    173. 

  173. 					<a name="userid" class="tsd-anchor"></a>
    174. 

  174. 					<h3>user<wbr>Id</h3>
    175. 

  175. 					<div class="tsd-signature tsd-kind-icon">user<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
    176. 

  176. 					<aside class="tsd-sources">
    177. 

  177. 					</aside>
    178. 

  178. 					<div class="tsd-comment tsd-typography">
    179. 

  179. 						<div class="lead">
    180. 

  180. 							<p>当前流所属用户的ID
    181. 

  181. 							注：若创建本地流时指定的 userId 与 join 时指定的 userId 不同，那么发布本条流时，流的 userId 将会自动被自动更新为 join 时指定的 userId</p>
    182. 

  182. 						</div>
    183. 

  183. 					</div>
    184. 

  184. 				</section>
    185. 

  185. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
    186. 

  186. 					<a name="videomuted" class="tsd-anchor"></a>
    187. 

  187. 					<h3>video<wbr>Muted</h3>
    188. 

  188. 					<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>
    189. 

  189. 					<aside class="tsd-sources">
    190. 

  190. 					</aside>
    191. 

  191. 					<div class="tsd-comment tsd-typography">
    192. 

  192. 						<div class="lead">
    193. 

  193. 							<p>当前流是否 mute 了视频</p>
    194. 

  194. 						</div>
    195. 

  195. 					</div>
    196. 

  196. 				</section>
    197. 

  197. 			</section>
    198. 

  198. 			<section class="tsd-panel-group tsd-member-group ">
    199. 

  199. 				<h2>Methods</h2>
    200. 

  200. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    201. 

  201. 					<a name="destroy" class="tsd-anchor"></a>
    202. 

  202. 					<h3>destroy</h3>
    203. 

  203. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    204. 

  204. 						<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
    205. 

  205. 					</ul>
    206. 

  206. 					<ul class="tsd-descriptions">
    207. 

  207. 						<li class="tsd-description">
    208. 

  208. 							<aside class="tsd-sources">
    209. 

  209. 							</aside>
    210. 

  210. 							<div class="tsd-comment tsd-typography">
    211. 

  211. 								<div class="lead">
    212. 

  212. 									<p>销毁当前流，一般在本地流不再被使用时，可调用此方法销毁，解除摄像头或麦克风设备的占用。
    213. 

  213. 									注：远端流，不需要手动调用此方法</p>
    214. 

  214. 								</div>
    215. 

  215. 								<dl class="tsd-comment-tags">
    216. 

  216. 									<dt>example</dt>
    217. 

  217. 									<dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">destroy</span><span style="color: #000000">();</span>
    218. 

  218. </code></pre>
    219. 

  219. 									</dd>
    220. 

  220. 								</dl>
    221. 

  221. 							</div>
    222. 

  222. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
    223. 

  223. 						</li>
    224. 

  224. 					</ul>
    225. 

  225. 				</section>
    226. 

  226. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    227. 

  227. 					<a name="getaudiolevel" class="tsd-anchor"></a>
    228. 

  228. 					<h3>get<wbr>Audio<wbr>Level</h3>
    229. 

  229. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    230. 

  230. 						<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>
    231. 

  231. 					</ul>
    232. 

  232. 					<ul class="tsd-descriptions">
    233. 

  233. 						<li class="tsd-description">
    234. 

  234. 							<aside class="tsd-sources">
    235. 

  235. 							</aside>
    236. 

  236. 							<div class="tsd-comment tsd-typography">
    237. 

  237. 								<div class="lead">
    238. 

  238. 									<p>获取当前流的音量大小，只有当本地流或远端流中有音频数据才有效。</p>
    239. 

  239. 								</div>
    240. 

  240. 								<dl class="tsd-comment-tags">
    241. 

  241. 									<dt>example</dt>
    242. 

  242. 									<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>
    243. 

  243. <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>
    244. 

  244. <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>
    245. 

  245. <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>
    246. 

  246. <span style="color: #000000">  }</span>
    247. 

  247. <span style="color: #000000">}, </span><span style="color: #098658">200</span><span style="color: #000000">);</span>
    248. 

  248. </code></pre>
    249. 

  249. 									</dd>
    250. 

  250. 								</dl>
    251. 

  251. 							</div>
    252. 

  252. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
    253. 

  253. 						</li>
    254. 

  254. 					</ul>
    255. 

  255. 				</section>
    256. 

  256. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    257. 

  257. 					<a name="getmediatype" class="tsd-anchor"></a>
    258. 

  258. 					<h3>get<wbr>Media<wbr>Type</h3>
    259. 

  259. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    260. 

  260. 						<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>
    261. 

  261. 					</ul>
    262. 

  262. 					<ul class="tsd-descriptions">
    263. 

  263. 						<li class="tsd-description">
    264. 

  264. 							<aside class="tsd-sources">
    265. 

  265. 							</aside>
    266. 

  266. 							<div class="tsd-comment tsd-typography">
    267. 

  267. 								<div class="lead">
    268. 

  268. 									<p>获取流的媒体类型</p>
    269. 

  269. 								</div>
    270. 

  270. 								<dl class="tsd-comment-tags">
    271. 

  271. 									<dt>example</dt>
    272. 

  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. 

  273. </code></pre>
    274. 

  274. 									</dd>
    275. 

  275. 								</dl>
    276. 

  276. 							</div>
    277. 

  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. 

  278. 						</li>
    279. 

  279. 					</ul>
    280. 

  280. 				</section>
    281. 

  281. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    282. 

  282. 					<a name="getstats" class="tsd-anchor"></a>
    283. 

  283. 					<h3>get<wbr>Stats</h3>
    284. 

  284. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    285. 

  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. 

  286. 					</ul>
    287. 

  287. 					<ul class="tsd-descriptions">
    288. 

  288. 						<li class="tsd-description">
    289. 

  289. 							<aside class="tsd-sources">
    290. 

  290. 							</aside>
    291. 

  291. 							<div class="tsd-comment tsd-typography">
    292. 

  292. 								<div class="lead">
    293. 

  293. 									<p>获取流发布或订阅后的统计数据</p>
    294. 

  294. 								</div>
    295. 

  295. 								<dl class="tsd-comment-tags">
    296. 

  296. 									<dt>example</dt>
    297. 

  297. 									<dd><pre><code class="language-js"><span style="color: #001080">stream</span>
    298. 

  298. <span style="color: #000000">  .</span><span style="color: #795E26">getStats</span><span style="color: #000000">()</span>
    299. 

  299. <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>
    300. 

  300. <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>
    301. 

  301. <span style="color: #000000">  });</span>
    302. 

  302. </code></pre>
    303. 

  303. 									</dd>
    304. 

  304. 								</dl>
    305. 

  305. 							</div>
    306. 

  306. 							<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>
    307. 

  307. 						</li>
    308. 

  308. 					</ul>
    309. 

  309. 				</section>
    310. 

  310. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    311. 

  311. 					<a name="hasaudio" class="tsd-anchor"></a>
    312. 

  312. 					<h3>has<wbr>Audio</h3>
    313. 

  313. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    314. 

  314. 						<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>
    315. 

  315. 					</ul>
    316. 

  316. 					<ul class="tsd-descriptions">
    317. 

  317. 						<li class="tsd-description">
    318. 

  318. 							<aside class="tsd-sources">
    319. 

  319. 							</aside>
    320. 

  320. 							<div class="tsd-comment tsd-typography">
    321. 

  321. 								<div class="lead">
    322. 

  322. 									<p>判断当前流是否有音频</p>
    323. 

  323. 								</div>
    324. 

  324. 								<dl class="tsd-comment-tags">
    325. 

  325. 									<dt>example</dt>
    326. 

  326. 									<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>
    327. 

  327. </code></pre>
    328. 

  328. 									</dd>
    329. 

  329. 								</dl>
    330. 

  330. 							</div>
    331. 

  331. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
    332. 

  332. 						</li>
    333. 

  333. 					</ul>
    334. 

  334. 				</section>
    335. 

  335. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    336. 

  336. 					<a name="hasvideo" class="tsd-anchor"></a>
    337. 

  337. 					<h3>has<wbr>Video</h3>
    338. 

  338. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    339. 

  339. 						<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>
    340. 

  340. 					</ul>
    341. 

  341. 					<ul class="tsd-descriptions">
    342. 

  342. 						<li class="tsd-description">
    343. 

  343. 							<aside class="tsd-sources">
    344. 

  344. 							</aside>
    345. 

  345. 							<div class="tsd-comment tsd-typography">
    346. 

  346. 								<div class="lead">
    347. 

  347. 									<p>判断当前流是否有视频</p>
    348. 

  348. 								</div>
    349. 

  349. 								<dl class="tsd-comment-tags">
    350. 

  350. 									<dt>example</dt>
    351. 

  351. 									<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>
    352. 

  352. </code></pre>
    353. 

  353. 									</dd>
    354. 

  354. 								</dl>
    355. 

  355. 							</div>
    356. 

  356. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
    357. 

  357. 						</li>
    358. 

  358. 					</ul>
    359. 

  359. 				</section>
    360. 

  360. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    361. 

  361. 					<a name="muteaudio" class="tsd-anchor"></a>
    362. 

  362. 					<h3>mute<wbr>Audio</h3>
    363. 

  363. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    364. 

  364. 						<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>
    365. 

  365. 					</ul>
    366. 

  366. 					<ul class="tsd-descriptions">
    367. 

  367. 						<li class="tsd-description">
    368. 

  368. 							<aside class="tsd-sources">
    369. 

  369. 							</aside>
    370. 

  370. 							<div class="tsd-comment tsd-typography">
    371. 

  371. 								<div class="lead">
    372. 

  372. 									<p>mute 当前流的音频</p>
    373. 

  373. 									<ul>
    374. 

  374. 										<li>本地流调用此方法时，将不向服务器推送音频数据，远端用户将收到 <code>mute-audio</code> 的事件通知</li>
    375. 

  375. 										<li>远端流调用此方法时，仅为不从服务器拉取音频数据，并无事件通知远端用户</li>
    376. 

  376. 									</ul>
    377. 

  377. 								</div>
    378. 

  378. 								<dl class="tsd-comment-tags">
    379. 

  379. 									<dt>example</dt>
    380. 

  380. 									<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>
    381. 

  381. <span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`stream&#039;audio is muted </span><span style="color: #0000FF">${</span><span style="color: #001080">stream</span><span style="color: #000000FF">.</span><span style="color: #001080">audioMuted</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    382. 

  382. </code></pre>
    383. 

  383. 									</dd>
    384. 

  384. 								</dl>
    385. 

  385. 							</div>
    386. 

  386. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
    387. 

  387. 							<p>操作是否成功</p>
    388. 

  388. 						</li>
    389. 

  389. 					</ul>
    390. 

  390. 				</section>
    391. 

  391. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    392. 

  392. 					<a name="mutevideo" class="tsd-anchor"></a>
    393. 

  393. 					<h3>mute<wbr>Video</h3>
    394. 

  394. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    395. 

  395. 						<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>
    396. 

  396. 					</ul>
    397. 

  397. 					<ul class="tsd-descriptions">
    398. 

  398. 						<li class="tsd-description">
    399. 

  399. 							<aside class="tsd-sources">
    400. 

  400. 							</aside>
    401. 

  401. 							<div class="tsd-comment tsd-typography">
    402. 

  402. 								<div class="lead">
    403. 

  403. 									<p>mute 当前流的视频</p>
    404. 

  404. 									<ul>
    405. 

  405. 										<li>本地流调用此方法时，将不向服务器推送视频数据，远端用户将收到 <code>mute-video</code> 的事件通知</li>
    406. 

  406. 										<li>远端流调用此方法时，仅为不从服务器拉取视频数据，并无事件通知远端用户</li>
    407. 

  407. 									</ul>
    408. 

  408. 								</div>
    409. 

  409. 								<dl class="tsd-comment-tags">
    410. 

  410. 									<dt>example</dt>
    411. 

  411. 									<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">result</span><span style="color: #000000"> = </span><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">muteVideo</span><span style="color: #000000">();</span>
    412. 

  412. <span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`stream&#039;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>
    413. 

  413. </code></pre>
    414. 

  414. 									</dd>
    415. 

  415. 								</dl>
    416. 

  416. 							</div>
    417. 

  417. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
    418. 

  418. 							<p>操作是否成功</p>
    419. 

  419. 						</li>
    420. 

  420. 					</ul>
    421. 

  421. 				</section>
    422. 

  422. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
    423. 

  423. 					<a name="off" class="tsd-anchor"></a>
    424. 

  424. 					<h3>off</h3>
    425. 

  425. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
    426. 

  426. 						<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>
    427. 

  427. 					</ul>
    428. 

  428. 					<ul class="tsd-descriptions">
    429. 

  429. 						<li class="tsd-description">
    430. 

  430. 							<aside class="tsd-sources">
    431. 

  431. 								<p>Inherited from EventEmitter.off</p>
    432. 

  432. 							</aside>
    433. 

  433. 							<div class="tsd-comment tsd-typography">
    434. 

  434. 								<div class="lead">
    435. 

  435. 									<p>取消监听流对象事件</p>
    436. 

  436. 								</div>
    437. 

  437. 							</div>
    438. 

  438. 							<h4 class="tsd-type-parameters-title">Type parameters</h4>
    439. 

  439. 							<ul class="tsd-type-parameters">
    440. 

  440. 								<li>
    441. 

  441. 									<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;user-joined&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;user-left&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;kick-off&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;stream-added&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;stream-removed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;stream-subscribed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;stream-published&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;mute-audio&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;unmute-audio&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;mute-video&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;unmute-video&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;first-key-frame&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;screenshare-stopped&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;connection-state-changed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;player-status-change&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;*&quot;</span></h4>
    442. 

  442. 								</li>
    443. 

  443. 							</ul>
    444. 

  444. 							<h4 class="tsd-parameters-title">Parameters</h4>
    445. 

  445. 							<ul class="tsd-parameters">
    446. 

  446. 								<li>
    447. 

  447. 									<h5>type: <span class="tsd-signature-type">T</span></h5>
    448. 

  448. 									<div class="tsd-comment tsd-typography">
    449. 

  449. 										<p>流对象事件类型，特别的，当为 &#39;*&#39; 时，取消监听所有事件</p>
    450. 

  450. 									</div>
    451. 

  451. 								</li>
    452. 

  452. 								<li>
    453. 

  453. 									<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>
    454. 

  454. 									<div class="tsd-comment tsd-typography">
    455. 

  455. 										<p>流对象事件监听函数</p>
    456. 

  456. 									</div>
    457. 

  457. 								</li>
    458. 

  458. 							</ul>
    459. 

  459. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventEmitter</span></h4>
    460. 

  460. 						</li>
    461. 

  461. 					</ul>
    462. 

  462. 				</section>
    463. 

  463. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
    464. 

  464. 					<a name="on" class="tsd-anchor"></a>
    465. 

  465. 					<h3>on</h3>
    466. 

  466. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
    467. 

  467. 						<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>
    468. 

  468. 					</ul>
    469. 

  469. 					<ul class="tsd-descriptions">
    470. 

  470. 						<li class="tsd-description">
    471. 

  471. 							<aside class="tsd-sources">
    472. 

  472. 								<p>Inherited from EventEmitter.on</p>
    473. 

  473. 							</aside>
    474. 

  474. 							<div class="tsd-comment tsd-typography">
    475. 

  475. 								<div class="lead">
    476. 

  476. 									<p>监听流对象事件</p>
    477. 

  477. 								</div>
    478. 

  478. 							</div>
    479. 

  479. 							<h4 class="tsd-type-parameters-title">Type parameters</h4>
    480. 

  480. 							<ul class="tsd-type-parameters">
    481. 

  481. 								<li>
    482. 

  482. 									<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>
    483. 

  483. 								</li>
    484. 

  484. 							</ul>
    485. 

  485. 							<h4 class="tsd-parameters-title">Parameters</h4>
    486. 

  486. 							<ul class="tsd-parameters">
    487. 

  487. 								<li>
    488. 

  488. 									<h5>type: <span class="tsd-signature-type">T</span></h5>
    489. 

  489. 									<div class="tsd-comment tsd-typography">
    490. 

  490. 										<p>流事件类型</p>
    491. 

  491. 									</div>
    492. 

  492. 								</li>
    493. 

  493. 								<li>
    494. 

  494. 									<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>
    495. 

  495. 									<div class="tsd-comment tsd-typography">
    496. 

  496. 										<p>流事件监听函数</p>
    497. 

  497. 									</div>
    498. 

  498. 								</li>
    499. 

  499. 							</ul>
    500. 

  500. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventEmitter</span></h4>
    501. 

  501. 						</li>
    502. 

  502. 					</ul>
    503. 

  503. 				</section>
    504. 

  504. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    505. 

  505. 					<a name="play" class="tsd-anchor"></a>
    506. 

  506. 					<h3>play</h3>
    507. 

  507. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    508. 

  508. 						<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>
    509. 

  509. 					</ul>
    510. 

  510. 					<ul class="tsd-descriptions">
    511. 

  511. 						<li class="tsd-description">
    512. 

  512. 							<aside class="tsd-sources">
    513. 

  513. 							</aside>
    514. 

  514. 							<div class="tsd-comment tsd-typography">
    515. 

  515. 								<div class="lead">
    516. 

  516. 									<p>播放当前流</p>
    517. 

  517. 								</div>
    518. 

  518. 								<dl class="tsd-comment-tags">
    519. 

  519. 									<dt>example</dt>
    520. 

  520. 									<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>
    521. 

  521. <span style="color: #001080">stream</span>
    522. 

  522. <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>
    523. 

  523. <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>
    524. 

  524. <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>
    525. 

  525. <span style="color: #000000">  });</span>
    526. 

  526. </code></pre>
    527. 

  527. 									</dd>
    528. 

  528. 									<dt>reject</dt>
    529. 

  529. 									<dd><p><a href="rtcerror.html">RtcError</a></p>
    530. 

  530. 									</dd>
    531. 

  531. 								</dl>
    532. 

  532. 							</div>
    533. 

  533. 							<h4 class="tsd-parameters-title">Parameters</h4>
    534. 

  534. 							<ul class="tsd-parameters">
    535. 

  535. 								<li>
    536. 

  536. 									<h5>container: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></h5>
    537. 

  537. 									<div class="tsd-comment tsd-typography">
    538. 

  538. 										<p>播放音视频时，包裹 video 标签所用的容器元素或容器元素的 ID</p>
    539. 

  539. 									</div>
    540. 

  540. 								</li>
    541. 

  541. 								<li>
    542. 

  542. 									<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>
    543. 

  543. 									<div class="tsd-comment tsd-typography">
    544. 

  544. 										<p>其他播放参数，参见<a href="../interfaces/playoptions.html">PlayOptions</a></p>
    545. 

  545. 									</div>
    546. 

  546. 								</li>
    547. 

  547. 							</ul>
    548. 

  548. 							<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>
    549. 

  549. 						</li>
    550. 

  550. 					</ul>
    551. 

  551. 				</section>
    552. 

  552. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    553. 

  553. 					<a name="resume" class="tsd-anchor"></a>
    554. 

  554. 					<h3>resume</h3>
    555. 

  555. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    556. 

  556. 						<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>
    557. 

  557. 					</ul>
    558. 

  558. 					<ul class="tsd-descriptions">
    559. 

  559. 						<li class="tsd-description">
    560. 

  560. 							<aside class="tsd-sources">
    561. 

  561. 							</aside>
    562. 

  562. 							<div class="tsd-comment tsd-typography">
    563. 

  563. 								<div class="lead">
    564. 

  564. 									<p>恢复播放流，一般由于浏览器限制无法自动播放时，可提示用户手动触发该方法进行恢复播放</p>
    565. 

  565. 								</div>
    566. 

  566. 								<dl class="tsd-comment-tags">
    567. 

  567. 									<dt>example</dt>
    568. 

  568. 									<dd><pre><code class="language-js"><span style="color: #001080">stream</span>
    569. 

  569. <span style="color: #000000">  .</span><span style="color: #795E26">resume</span><span style="color: #000000">()</span>
    570. 

  570. <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>
    571. 

  571. <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>
    572. 

  572. <span style="color: #000000">  });</span>
    573. 

  573. </code></pre>
    574. 

  574. 									</dd>
    575. 

  575. 								</dl>
    576. 

  576. 							</div>
    577. 

  577. 							<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>
    578. 

  578. 						</li>
    579. 

  579. 					</ul>
    580. 

  580. 				</section>
    581. 

  581. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    582. 

  582. 					<a name="snapshot" class="tsd-anchor"></a>
    583. 

  583. 					<h3>snapshot</h3>
    584. 

  584. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    585. 

  585. 						<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>
    586. 

  586. 					</ul>
    587. 

  587. 					<ul class="tsd-descriptions">
    588. 

  588. 						<li class="tsd-description">
    589. 

  589. 							<aside class="tsd-sources">
    590. 

  590. 							</aside>
    591. 

  591. 							<div class="tsd-comment tsd-typography">
    592. 

  592. 								<div class="lead">
    593. 

  593. 									<p>对当前流进行截屏，可用于页面展示或下载保存</p>
    594. 

  594. 								</div>
    595. 

  595. 								<dl class="tsd-comment-tags">
    596. 

  596. 									<dt>example</dt>
    597. 

  597. 									<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>
    598. 

  598. <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>
    599. 

  599. <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>
    600. 

  600. <span style="color: #000000">  })</span>
    601. 

  601. <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>
    602. 

  602. <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>
    603. 

  603. <span style="color: #000000">  });</span>
    604. 

  604. </code></pre>
    605. 

  605. 									</dd>
    606. 

  606. 								</dl>
    607. 

  607. 							</div>
    608. 

  608. 							<h4 class="tsd-parameters-title">Parameters</h4>
    609. 

  609. 							<ul class="tsd-parameters">
    610. 

  610. 								<li>
    611. 

  611. 									<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>
    612. 

  612. 									<div class="tsd-comment tsd-typography">
    613. 

  613. 										<p>截屏参数，选传，参见<a href="../interfaces/snapshotoptions.html">SnapshotOptions</a></p>
    614. 

  614. 									</div>
    615. 

  615. 								</li>
    616. 

  616. 							</ul>
    617. 

  617. 							<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>
    618. 

  618. 						</li>
    619. 

  619. 					</ul>
    620. 

  620. 				</section>
    621. 

  621. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    622. 

  622. 					<a name="stop" class="tsd-anchor"></a>
    623. 

  623. 					<h3>stop</h3>
    624. 

  624. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    625. 

  625. 						<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>
    626. 

  626. 					</ul>
    627. 

  627. 					<ul class="tsd-descriptions">
    628. 

  628. 						<li class="tsd-description">
    629. 

  629. 							<aside class="tsd-sources">
    630. 

  630. 							</aside>
    631. 

  631. 							<div class="tsd-comment tsd-typography">
    632. 

  632. 								<div class="lead">
    633. 

  633. 									<p>停止播放当前流</p>
    634. 

  634. 								</div>
    635. 

  635. 								<dl class="tsd-comment-tags">
    636. 

  636. 									<dt>example</dt>
    637. 

  637. 									<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>
    638. 

  638. </code></pre>
    639. 

  639. 									</dd>
    640. 

  640. 								</dl>
    641. 

  641. 							</div>
    642. 

  642. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
    643. 

  643. 						</li>
    644. 

  644. 					</ul>
    645. 

  645. 				</section>
    646. 

  646. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    647. 

  647. 					<a name="unmuteaudio" class="tsd-anchor"></a>
    648. 

  648. 					<h3>unmute<wbr>Audio</h3>
    649. 

  649. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    650. 

  650. 						<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>
    651. 

  651. 					</ul>
    652. 

  652. 					<ul class="tsd-descriptions">
    653. 

  653. 						<li class="tsd-description">
    654. 

  654. 							<aside class="tsd-sources">
    655. 

  655. 							</aside>
    656. 

  656. 							<div class="tsd-comment tsd-typography">
    657. 

  657. 								<div class="lead">
    658. 

  658. 									<p>unmute 当前流的音频</p>
    659. 

  659. 									<ul>
    660. 

  660. 										<li>本地流调用此方法时，将向服务器推送音频数据，远端用户将收到 <code>unmute-audio</code> 的事件通知</li>
    661. 

  661. 										<li>远端流调用此方法时，会从服务器拉取音频数据，并无事件通知远端用户</li>
    662. 

  662. 									</ul>
    663. 

  663. 								</div>
    664. 

  664. 								<dl class="tsd-comment-tags">
    665. 

  665. 									<dt>example</dt>
    666. 

  666. 									<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>
    667. 

  667. <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>
    668. 

  668. </code></pre>
    669. 

  669. 									</dd>
    670. 

  670. 								</dl>
    671. 

  671. 							</div>
    672. 

  672. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
    673. 

  673. 							<p>操作是否成功</p>
    674. 

  674. 						</li>
    675. 

  675. 					</ul>
    676. 

  676. 				</section>
    677. 

  677. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    678. 

  678. 					<a name="unmutevideo" class="tsd-anchor"></a>
    679. 

  679. 					<h3>unmute<wbr>Video</h3>
    680. 

  680. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    681. 

  681. 						<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>
    682. 

  682. 					</ul>
    683. 

  683. 					<ul class="tsd-descriptions">
    684. 

  684. 						<li class="tsd-description">
    685. 

  685. 							<aside class="tsd-sources">
    686. 

  686. 							</aside>
    687. 

  687. 							<div class="tsd-comment tsd-typography">
    688. 

  688. 								<div class="lead">
    689. 

  689. 									<p>unmute 当前流的视频</p>
    690. 

  690. 									<ul>
    691. 

  691. 										<li>本地流调用此方法时，将向服务器推送视频数据，远端用户将收到 <code>unmute-video</code> 的事件通知</li>
    692. 

  692. 										<li>远端流调用此方法时，会从服务器拉取视频数据，并无事件通知远端用户</li>
    693. 

  693. 									</ul>
    694. 

  694. 								</div>
    695. 

  695. 								<dl class="tsd-comment-tags">
    696. 

  696. 									<dt>example</dt>
    697. 

  697. 									<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>
    698. 

  698. <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>
    699. 

  699. </code></pre>
    700. 

  700. 									</dd>
    701. 

  701. 								</dl>
    702. 

  702. 							</div>
    703. 

  703. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
    704. 

  704. 							<p>操作是否成功</p>
    705. 

  705. 						</li>
    706. 

  706. 					</ul>
    707. 

  707. 				</section>
    708. 

  708. 			</section>
    709. 

  709. 		</div>
    710. 

  710. 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
    711. 

  711. 			<nav class="tsd-navigation primary">
    712. 

  712. 				<ul>
    713. 

  713. 					<li class=" ">
    714. 

  714. 						<a href="../index.html">Exports</a>
    715. 

  715. 					</li>
    716. 

  716. 				</ul>
    717. 

  717. 			</nav>
    718. 

  718. 			<nav class="tsd-navigation secondary menu-sticky">
    719. 

  719. 				<ul class="before-current">
    720. 

  720. 				</ul>
    721. 

  721. 				<ul class="current">
    722. 

  722. 					<li class="current tsd-kind-class">
    723. 

  723. 						<a href="stream.html" class="tsd-kind-icon">Stream</a>
    724. 

  724. 						<ul>
    725. 

  725. 							<li class=" tsd-kind-property tsd-parent-kind-class">
    726. 

  726. 								<a href="stream.html#audiomuted" class="tsd-kind-icon">audio<wbr>Muted</a>
    727. 

  727. 							</li>
    728. 

  728. 							<li class=" tsd-kind-property tsd-parent-kind-class">
    729. 

  729. 								<a href="stream.html#id" class="tsd-kind-icon">id</a>
    730. 

  730. 							</li>
    731. 

  731. 							<li class=" tsd-kind-property tsd-parent-kind-class">
    732. 

  732. 								<a href="stream.html#mediastream" class="tsd-kind-icon">media<wbr>Stream</a>
    733. 

  733. 							</li>
    734. 

  734. 							<li class=" tsd-kind-property tsd-parent-kind-class">
    735. 

  735. 								<a href="stream.html#userid" class="tsd-kind-icon">user<wbr>Id</a>
    736. 

  736. 							</li>
    737. 

  737. 							<li class=" tsd-kind-property tsd-parent-kind-class">
    738. 

  738. 								<a href="stream.html#videomuted" class="tsd-kind-icon">video<wbr>Muted</a>
    739. 

  739. 							</li>
    740. 

  740. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    741. 

  741. 								<a href="stream.html#destroy" class="tsd-kind-icon">destroy</a>
    742. 

  742. 							</li>
    743. 

  743. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    744. 

  744. 								<a href="stream.html#getaudiolevel" class="tsd-kind-icon">get<wbr>Audio<wbr>Level</a>
    745. 

  745. 							</li>
    746. 

  746. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    747. 

  747. 								<a href="stream.html#getmediatype" class="tsd-kind-icon">get<wbr>Media<wbr>Type</a>
    748. 

  748. 							</li>
    749. 

  749. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    750. 

  750. 								<a href="stream.html#getstats" class="tsd-kind-icon">get<wbr>Stats</a>
    751. 

  751. 							</li>
    752. 

  752. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    753. 

  753. 								<a href="stream.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a>
    754. 

  754. 							</li>
    755. 

  755. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    756. 

  756. 								<a href="stream.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a>
    757. 

  757. 							</li>
    758. 

  758. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    759. 

  759. 								<a href="stream.html#muteaudio" class="tsd-kind-icon">mute<wbr>Audio</a>
    760. 

  760. 							</li>
    761. 

  761. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    762. 

  762. 								<a href="stream.html#mutevideo" class="tsd-kind-icon">mute<wbr>Video</a>
    763. 

  763. 							</li>
    764. 

  764. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
    765. 

  765. 								<a href="stream.html#off" class="tsd-kind-icon">off</a>
    766. 

  766. 							</li>
    767. 

  767. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
    768. 

  768. 								<a href="stream.html#on" class="tsd-kind-icon">on</a>
    769. 

  769. 							</li>
    770. 

  770. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    771. 

  771. 								<a href="stream.html#play" class="tsd-kind-icon">play</a>
    772. 

  772. 							</li>
    773. 

  773. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    774. 

  774. 								<a href="stream.html#resume" class="tsd-kind-icon">resume</a>
    775. 

  775. 							</li>
    776. 

  776. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    777. 

  777. 								<a href="stream.html#snapshot" class="tsd-kind-icon">snapshot</a>
    778. 

  778. 							</li>
    779. 

  779. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    780. 

  780. 								<a href="stream.html#stop" class="tsd-kind-icon">stop</a>
    781. 

  781. 							</li>
    782. 

  782. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    783. 

  783. 								<a href="stream.html#unmuteaudio" class="tsd-kind-icon">unmute<wbr>Audio</a>
    784. 

  784. 							</li>
    785. 

  785. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    786. 

  786. 								<a href="stream.html#unmutevideo" class="tsd-kind-icon">unmute<wbr>Video</a>
    787. 

  787. 							</li>
    788. 

  788. 						</ul>
    789. 

  789. 					</li>
    790. 

  790. 				</ul>
    791. 

  791. 				<ul class="after-current">
    792. 

  792. 				</ul>
    793. 

  793. 			</nav>
    794. 

  794. 		</div>
    795. 

  795. 	</div>
    796. 

  796. </div>
    797. 

  797. <footer class="with-border-bottom">
    798. 

  798. 	<div class="container">
    799. 

  799. 		<h2>Legend</h2>
    800. 

  800. 		<div class="tsd-legend-group">
    801. 

  801. 			<ul class="tsd-legend">
    802. 

  802. 				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
    803. 

  803. 				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
    804. 

  804. 				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
    805. 

  805. 			</ul>
    806. 

  806. 			<ul class="tsd-legend">
    807. 

  807. 				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
    808. 

  808. 				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
    809. 

  809. 			</ul>
    810. 

  810. 			<ul class="tsd-legend">
    811. 

  811. 				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
    812. 

  812. 				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
    813. 

  813. 			</ul>
    814. 

  814. 			<ul class="tsd-legend">
    815. 

  815. 				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
    816. 

  816. 			</ul>
    817. 

  817. 		</div>
    818. 

  818. 	</div>
    819. 

  819. </footer>
    820. 

  820. <div class="container tsd-generator">
    821. 

  821. 	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
    822. 

  822. </div>
    823. 

  823. <div class="overlay"></div>
    824. 

  824. <script src="../assets/js/main.js"></script>
    825. 

  825. </body>
    826. 

  826. </html>
    827.