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

localstream.html 63 KB
履歴 Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124 
  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>LocalStream | @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. </head>
    11. 

  11. <body>
    12. 

  12. <header>
    13. 

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

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

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

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

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

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

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

  20. 					</div>
    21. 

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

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

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

  24. 					</ul>
    25. 

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

  26. 				</div>
    27. 

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

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

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

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

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

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

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

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

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

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

  37. 								</ul>
    38. 

  38. 							</div>
    39. 

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

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

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

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

  43. 						</div>
    44. 

  44. 					</div>
    45. 

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

  46. 				</div>
    47. 

  47. 			</div>
    48. 

  48. 		</div>
    49. 

  49. 	</div>
    50. 

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

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

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

  53. 				<li>
    54. 

  54. 					<a href="../index.html">Globals</a>
    55. 

  55. 				</li>
    56. 

  56. 				<li>
    57. 

  57. 					<a href="localstream.html">LocalStream</a>
    58. 

  58. 				</li>
    59. 

  59. 			</ul>
    60. 

  60. 			<h1>Class LocalStream</h1>
    61. 

  61. 		</div>
    62. 

  62. 	</div>
    63. 

  63. </header>
    64. 

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

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

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

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

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

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

  70. 						<p>本地流，可用于本地预览，也可用 client 进行发布</p>
    71. 

  71. 					</div>
    72. 

  72. 				</div>
    73. 

  73. 			</section>
    74. 

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

  75. 				<h3>Hierarchy</h3>
    76. 

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

  77. 					<li>
    78. 

  78. 						<a href="stream.html" class="tsd-signature-type">Stream</a>
    79. 

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

  80. 							<li>
    81. 

  81. 								<span class="target">LocalStream</span>
    82. 

  82. 							</li>
    83. 

  83. 						</ul>
    84. 

  84. 					</li>
    85. 

  85. 				</ul>
    86. 

  86. 			</section>
    87. 

  87. 			<section class="tsd-panel-group tsd-index-group">
    88. 

  88. 				<h2>Index</h2>
    89. 

  89. 				<section class="tsd-panel tsd-index-panel">
    90. 

  90. 					<div class="tsd-index-content">
    91. 

  91. 						<section class="tsd-index-section tsd-is-inherited tsd-is-external">
    92. 

  92. 							<h3>Properties</h3>
    93. 

  93. 							<ul class="tsd-index-list">
    94. 

  94. 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#audiomuted" class="tsd-kind-icon">audio<wbr>Muted</a></li>
    95. 

  95. 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#id" class="tsd-kind-icon">id</a></li>
    96. 

  96. 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#mediastream" class="tsd-kind-icon">media<wbr>Stream</a></li>
    97. 

  97. 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#videomuted" class="tsd-kind-icon">video<wbr>Muted</a></li>
    98. 

  98. 							</ul>
    99. 

  99. 						</section>
    100. 

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

  101. 							<h3>Methods</h3>
    102. 

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

  103. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="localstream.html#addtrack" class="tsd-kind-icon">add<wbr>Track</a></li>
    104. 

  104. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#destroy" class="tsd-kind-icon">destroy</a></li>
    105. 

  105. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#getaudiolevel" class="tsd-kind-icon">get<wbr>Audio<wbr>Level</a></li>
    106. 

  106. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#getmediatype" class="tsd-kind-icon">get<wbr>Media<wbr>Type</a></li>
    107. 

  107. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#getstats" class="tsd-kind-icon">get<wbr>Stats</a></li>
    108. 

  108. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a></li>
    109. 

  109. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a></li>
    110. 

  110. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="localstream.html#init" class="tsd-kind-icon">init</a></li>
    111. 

  111. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#muteaudio" class="tsd-kind-icon">mute<wbr>Audio</a></li>
    112. 

  112. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#mutevideo" class="tsd-kind-icon">mute<wbr>Video</a></li>
    113. 

  113. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="localstream.html#off" class="tsd-kind-icon">off</a></li>
    114. 

  114. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="localstream.html#on" class="tsd-kind-icon">on</a></li>
    115. 

  115. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="localstream.html#play" class="tsd-kind-icon">play</a></li>
    116. 

  116. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="localstream.html#removetrack" class="tsd-kind-icon">remove<wbr>Track</a></li>
    117. 

  117. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="localstream.html#replacetrack" class="tsd-kind-icon">replace<wbr>Track</a></li>
    118. 

  118. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#resume" class="tsd-kind-icon">resume</a></li>
    119. 

  119. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="localstream.html#setscreenprofile" class="tsd-kind-icon">set<wbr>Screen<wbr>Profile</a></li>
    120. 

  120. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="localstream.html#setvideoprofile" class="tsd-kind-icon">set<wbr>Video<wbr>Profile</a></li>
    121. 

  121. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#stop" class="tsd-kind-icon">stop</a></li>
    122. 

  122. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="localstream.html#switchdevice" class="tsd-kind-icon">switch<wbr>Device</a></li>
    123. 

  123. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="localstream.html#switchimage" class="tsd-kind-icon">switch<wbr>Image</a></li>
    124. 

  124. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#unmuteaudio" class="tsd-kind-icon">unmute<wbr>Audio</a></li>
    125. 

  125. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="localstream.html#unmutevideo" class="tsd-kind-icon">unmute<wbr>Video</a></li>
    126. 

  126. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="localstream.html#use" class="tsd-kind-icon">use</a></li>
    127. 

  127. 							</ul>
    128. 

  128. 						</section>
    129. 

  129. 					</div>
    130. 

  130. 				</section>
    131. 

  131. 			</section>
    132. 

  132. 			<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external">
    133. 

  133. 				<h2>Properties</h2>
    134. 

  134. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    135. 

  135. 					<a name="audiomuted" class="tsd-anchor"></a>
    136. 

  136. 					<h3>audio<wbr>Muted</h3>
    137. 

  137. 					<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>
    138. 

  138. 					<aside class="tsd-sources">
    139. 

  139. 						<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#audiomuted">audioMuted</a></p>
    140. 

  140. 					</aside>
    141. 

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

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

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

  144. 						</div>
    145. 

  145. 					</div>
    146. 

  146. 				</section>
    147. 

  147. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    148. 

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

  149. 					<h3>id</h3>
    150. 

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

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

  152. 						<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#id">id</a></p>
    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 tsd-is-inherited tsd-is-external">
    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. 						<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#mediastream">mediaStream</a></p>
    166. 

  166. 					</aside>
    167. 

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

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

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

  170. 						</div>
    171. 

  171. 					</div>
    172. 

  172. 				</section>
    173. 

  173. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    174. 

  174. 					<a name="videomuted" class="tsd-anchor"></a>
    175. 

  175. 					<h3>video<wbr>Muted</h3>
    176. 

  176. 					<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>
    177. 

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

  178. 						<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#videomuted">videoMuted</a></p>
    179. 

  179. 					</aside>
    180. 

  180. 					<div class="tsd-comment tsd-typography">
    181. 

  181. 						<div class="lead">
    182. 

  182. 							<p>当前流是否 mute 了视频</p>
    183. 

  183. 						</div>
    184. 

  184. 					</div>
    185. 

  185. 				</section>
    186. 

  186. 			</section>
    187. 

  187. 			<section class="tsd-panel-group tsd-member-group tsd-is-external">
    188. 

  188. 				<h2>Methods</h2>
    189. 

  189. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
    190. 

  190. 					<a name="addtrack" class="tsd-anchor"></a>
    191. 

  191. 					<h3>add<wbr>Track</h3>
    192. 

  192. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    193. 

  193. 						<li class="tsd-signature tsd-kind-icon">add<wbr>Track<span class="tsd-signature-symbol">(</span>track<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
    194. 

  194. 					</ul>
    195. 

  195. 					<ul class="tsd-descriptions">
    196. 

  196. 						<li class="tsd-description">
    197. 

  197. 							<aside class="tsd-sources">
    198. 

  198. 							</aside>
    199. 

  199. 							<div class="tsd-comment tsd-typography">
    200. 

  200. 								<div class="lead">
    201. 

  201. 									<p>添加一条媒体轨道（音轨或视轨）到当前流</p>
    202. 

  202. 									<blockquote>
    203. 

  203. 										<p>注：</p>
    204. 

  204. 										<ol>
    205. 

  205. 											<li>若创建本地流时，audio 为 false，不可添加音轨，video 为 false 时，不可添加视轨</li>
    206. 

  206. 										</ol>
    207. 

  207. 									</blockquote>
    208. 

  208. 								</div>
    209. 

  209. 								<dl class="tsd-comment-tags">
    210. 

  210. 									<dt>example</dt>
    211. 

  211. 									<dd><pre><code class="language-js">stream.addTrack(track);</code></pre>
    212. 

  212. 									</dd>
    213. 

  213. 								</dl>
    214. 

  214. 							</div>
    215. 

  215. 							<h4 class="tsd-parameters-title">Parameters</h4>
    216. 

  216. 							<ul class="tsd-parameters">
    217. 

  217. 								<li>
    218. 

  218. 									<h5>track: <span class="tsd-signature-type">MediaStreamTrack</span></h5>
    219. 

  219. 									<div class="tsd-comment tsd-typography">
    220. 

  220. 										<p>媒体轨道</p>
    221. 

  221. 									</div>
    222. 

  222. 								</li>
    223. 

  223. 							</ul>
    224. 

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

  225. 						</li>
    226. 

  226. 					</ul>
    227. 

  227. 				</section>
    228. 

  228. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    229. 

  229. 					<a name="destroy" class="tsd-anchor"></a>
    230. 

  230. 					<h3>destroy</h3>
    231. 

  231. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    232. 

  232. 						<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>
    233. 

  233. 					</ul>
    234. 

  234. 					<ul class="tsd-descriptions">
    235. 

  235. 						<li class="tsd-description">
    236. 

  236. 							<aside class="tsd-sources">
    237. 

  237. 								<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#destroy">destroy</a></p>
    238. 

  238. 							</aside>
    239. 

  239. 							<div class="tsd-comment tsd-typography">
    240. 

  240. 								<div class="lead">
    241. 

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

  242. 									<blockquote>
    243. 

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

  244. 									</blockquote>
    245. 

  245. 								</div>
    246. 

  246. 								<dl class="tsd-comment-tags">
    247. 

  247. 									<dt>example</dt>
    248. 

  248. 									<dd><pre><code class="language-js">stream.destroy();</code></pre>
    249. 

  249. 									</dd>
    250. 

  250. 								</dl>
    251. 

  251. 							</div>
    252. 

  252. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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 tsd-is-inherited tsd-is-external">
    257. 

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

  258. 					<h3>get<wbr>Audio<wbr>Level</h3>
    259. 

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

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

  261. 					</ul>
    262. 

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

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

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

  265. 								<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#getaudiolevel">getAudioLevel</a></p>
    266. 

  266. 							</aside>
    267. 

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

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

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

  270. 								</div>
    271. 

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

  272. 									<dt>example</dt>
    273. 

  273. 									<dd><pre><code class="language-js"><span class="hljs-built_in">setInterval</span>(<span class="hljs-function">() =&gt;</span> {
    274. 

  274.   <span class="hljs-keyword">const</span> level = stream.getAudioLevel();
    275. 

  275.   <span class="hljs-keyword">if</span> (level &gt; <span class="hljs-number">0</span>) {
    276. 

  276.     <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`user <span class="hljs-subst">${stream.userId}</span> is speaking`</span>);
    277. 

  277.   }
    278. 

  278. }, <span class="hljs-number">200</span>);</code></pre>
    279. 

  279. 									</dd>
    280. 

  280. 								</dl>
    281. 

  281. 							</div>
    282. 

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

  283. 						</li>
    284. 

  284. 					</ul>
    285. 

  285. 				</section>
    286. 

  286. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    287. 

  287. 					<a name="getmediatype" class="tsd-anchor"></a>
    288. 

  288. 					<h3>get<wbr>Media<wbr>Type</h3>
    289. 

  289. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    290. 

  290. 						<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">MediaType</a></li>
    291. 

  291. 					</ul>
    292. 

  292. 					<ul class="tsd-descriptions">
    293. 

  293. 						<li class="tsd-description">
    294. 

  294. 							<aside class="tsd-sources">
    295. 

  295. 								<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#getmediatype">getMediaType</a></p>
    296. 

  296. 							</aside>
    297. 

  297. 							<div class="tsd-comment tsd-typography">
    298. 

  298. 								<div class="lead">
    299. 

  299. 									<p>获取流的媒体类型</p>
    300. 

  300. 								</div>
    301. 

  301. 								<dl class="tsd-comment-tags">
    302. 

  302. 									<dt>example</dt>
    303. 

  303. 									<dd><pre><code class="language-js"><span class="hljs-keyword">const</span> type = stream.getMediaType();</code></pre>
    304. 

  304. 									</dd>
    305. 

  305. 								</dl>
    306. 

  306. 							</div>
    307. 

  307. 							<h4 class="tsd-returns-title">Returns <a href="../index.html#mediatype" class="tsd-signature-type">MediaType</a></h4>
    308. 

  308. 						</li>
    309. 

  309. 					</ul>
    310. 

  310. 				</section>
    311. 

  311. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    312. 

  312. 					<a name="getstats" class="tsd-anchor"></a>
    313. 

  313. 					<h3>get<wbr>Stats</h3>
    314. 

  314. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    315. 

  315. 						<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">StreamStats</a><span class="tsd-signature-symbol">&gt;</span></li>
    316. 

  316. 					</ul>
    317. 

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

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

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

  320. 								<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#getstats">getStats</a></p>
    321. 

  321. 							</aside>
    322. 

  322. 							<div class="tsd-comment tsd-typography">
    323. 

  323. 								<div class="lead">
    324. 

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

  325. 								</div>
    326. 

  326. 								<dl class="tsd-comment-tags">
    327. 

  327. 									<dt>example</dt>
    328. 

  328. 									<dd><pre><code class="language-js">stream
    329. 

  329.   .getStats()
    330. 

  330.   .then(<span class="hljs-function">(<span class="hljs-params">stats</span>) =&gt;</span> {
    331. 

  331.     <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;当前流的统计数据为: &#x27;</span>, stats);
    332. 

  332.   });</code></pre>
    333. 

  333. 									</dd>
    334. 

  334. 								</dl>
    335. 

  335. 							</div>
    336. 

  336. 							<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">StreamStats</a><span class="tsd-signature-symbol">&gt;</span></h4>
    337. 

  337. 						</li>
    338. 

  338. 					</ul>
    339. 

  339. 				</section>
    340. 

  340. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    341. 

  341. 					<a name="hasaudio" class="tsd-anchor"></a>
    342. 

  342. 					<h3>has<wbr>Audio</h3>
    343. 

  343. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    344. 

  344. 						<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>
    345. 

  345. 					</ul>
    346. 

  346. 					<ul class="tsd-descriptions">
    347. 

  347. 						<li class="tsd-description">
    348. 

  348. 							<aside class="tsd-sources">
    349. 

  349. 								<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#hasaudio">hasAudio</a></p>
    350. 

  350. 							</aside>
    351. 

  351. 							<div class="tsd-comment tsd-typography">
    352. 

  352. 								<div class="lead">
    353. 

  353. 									<p>判断当前流是否有音频</p>
    354. 

  354. 								</div>
    355. 

  355. 								<dl class="tsd-comment-tags">
    356. 

  356. 									<dt>example</dt>
    357. 

  357. 									<dd><pre><code class="language-js"><span class="hljs-keyword">const</span> result = stream.hasAudio();</code></pre>
    358. 

  358. 									</dd>
    359. 

  359. 								</dl>
    360. 

  360. 							</div>
    361. 

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

  362. 						</li>
    363. 

  363. 					</ul>
    364. 

  364. 				</section>
    365. 

  365. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    366. 

  366. 					<a name="hasvideo" class="tsd-anchor"></a>
    367. 

  367. 					<h3>has<wbr>Video</h3>
    368. 

  368. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    369. 

  369. 						<li class="tsd-signature tsd-kind-icon">has<wbr>Video<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
    370. 

  370. 					</ul>
    371. 

  371. 					<ul class="tsd-descriptions">
    372. 

  372. 						<li class="tsd-description">
    373. 

  373. 							<aside class="tsd-sources">
    374. 

  374. 								<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#hasvideo">hasVideo</a></p>
    375. 

  375. 							</aside>
    376. 

  376. 							<div class="tsd-comment tsd-typography">
    377. 

  377. 								<div class="lead">
    378. 

  378. 									<p>判断当前流是否有视频</p>
    379. 

  379. 								</div>
    380. 

  380. 								<dl class="tsd-comment-tags">
    381. 

  381. 									<dt>example</dt>
    382. 

  382. 									<dd><pre><code class="language-js"><span class="hljs-keyword">const</span> result = stream.hasVideo();</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. 						</li>
    388. 

  388. 					</ul>
    389. 

  389. 				</section>
    390. 

  390. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
    391. 

  391. 					<a name="init" class="tsd-anchor"></a>
    392. 

  392. 					<h3>init</h3>
    393. 

  393. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    394. 

  394. 						<li class="tsd-signature tsd-kind-icon">init<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>
    395. 

  395. 					</ul>
    396. 

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

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

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

  399. 							</aside>
    400. 

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

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

  402. 									<p>初始化本地流对象，将读取麦克风、摄像头、屏幕共享等来初始化媒体流</p>
    403. 

  403. 								</div>
    404. 

  404. 								<dl class="tsd-comment-tags">
    405. 

  405. 									<dt>example</dt>
    406. 

  406. 									<dd><pre><code class="language-js"><span class="hljs-keyword">const</span> stream = createStream({<span class="hljs-attr">audio</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">video</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">screen</span>: <span class="hljs-literal">false</span>});
    407. 

  407. stream
    408. 

  408.   .init()
    409. 

  409.   .then(<span class="hljs-function">() =&gt;</span> {
    410. 

  410.     client.publish(stream); <span class="hljs-comment">// 发布本地流</span>
    411. 

  411.   })
    412. 

  412.   .catch(<span class="hljs-function">(<span class="hljs-params">err</span>) =&gt;</span> {
    413. 

  413.     <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`初始化本地流失败 <span class="hljs-subst">${err}</span>`</span>);
    414. 

  414.   })</code></pre>
    415. 

  415. 									</dd>
    416. 

  416. 								</dl>
    417. 

  417. 							</div>
    418. 

  418. 							<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>
    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-is-inherited tsd-is-external">
    423. 

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

  424. 					<h3>mute<wbr>Audio</h3>
    425. 

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

  426. 						<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>
    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 <a href="localstream.html">LocalStream</a>.<a href="localstream.html#muteaudio">muteAudio</a></p>
    432. 

  432. 							</aside>
    433. 

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

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

  435. 									<p>mute 当前流的音频</p>
    436. 

  436. 									<ul>
    437. 

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

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

  439. 									</ul>
    440. 

  440. 								</div>
    441. 

  441. 								<dl class="tsd-comment-tags">
    442. 

  442. 									<dt>example</dt>
    443. 

  443. 									<dd><pre><code class="language-js"><span class="hljs-keyword">const</span> result = stream.muteAudio();
    444. 

  444. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`stream&#x27;audio is muted <span class="hljs-subst">${stream.audioMuted}</span>`</span>);</code></pre>
    445. 

  445. 									</dd>
    446. 

  446. 								</dl>
    447. 

  447. 							</div>
    448. 

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

  449. 							<p>操作是否成功</p>
    450. 

  450. 						</li>
    451. 

  451. 					</ul>
    452. 

  452. 				</section>
    453. 

  453. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    454. 

  454. 					<a name="mutevideo" class="tsd-anchor"></a>
    455. 

  455. 					<h3>mute<wbr>Video</h3>
    456. 

  456. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    457. 

  457. 						<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>
    458. 

  458. 					</ul>
    459. 

  459. 					<ul class="tsd-descriptions">
    460. 

  460. 						<li class="tsd-description">
    461. 

  461. 							<aside class="tsd-sources">
    462. 

  462. 								<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#mutevideo">muteVideo</a></p>
    463. 

  463. 							</aside>
    464. 

  464. 							<div class="tsd-comment tsd-typography">
    465. 

  465. 								<div class="lead">
    466. 

  466. 									<p>mute 当前流的视频</p>
    467. 

  467. 									<ul>
    468. 

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

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

  470. 									</ul>
    471. 

  471. 								</div>
    472. 

  472. 								<dl class="tsd-comment-tags">
    473. 

  473. 									<dt>example</dt>
    474. 

  474. 									<dd><pre><code class="language-js"><span class="hljs-keyword">const</span> result = stream.muteVideo();
    475. 

  475. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`stream&#x27;s video is muted <span class="hljs-subst">${stream.videoMuted}</span>`</span>);</code></pre>
    476. 

  476. 									</dd>
    477. 

  477. 								</dl>
    478. 

  478. 							</div>
    479. 

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

  480. 							<p>操作是否成功</p>
    481. 

  481. 						</li>
    482. 

  482. 					</ul>
    483. 

  483. 				</section>
    484. 

  484. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
    485. 

  485. 					<a name="off" class="tsd-anchor"></a>
    486. 

  486. 					<h3>off</h3>
    487. 

  487. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
    488. 

  488. 						<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><a href="../interfaces/listener.html" class="tsd-signature-type">Listener</a><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>
    489. 

  489. 					</ul>
    490. 

  490. 					<ul class="tsd-descriptions">
    491. 

  491. 						<li class="tsd-description">
    492. 

  492. 							<aside class="tsd-sources">
    493. 

  493. 								<p>Inherited from EventEmitter.off</p>
    494. 

  494. 							</aside>
    495. 

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

  496. 								<div class="lead">
    497. 

  497. 									<p>取消监听流对象事件</p>
    498. 

  498. 								</div>
    499. 

  499. 							</div>
    500. 

  500. 							<h4 class="tsd-type-parameters-title">Type parameters</h4>
    501. 

  501. 							<ul class="tsd-type-parameters">
    502. 

  502. 								<li>
    503. 

  503. 									<h4>T<span class="tsd-signature-symbol">: </span><a href="../index.html#rtceventtype" class="tsd-signature-type">RtcEventType</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"*"</span></h4>
    504. 

  504. 								</li>
    505. 

  505. 							</ul>
    506. 

  506. 							<h4 class="tsd-parameters-title">Parameters</h4>
    507. 

  507. 							<ul class="tsd-parameters">
    508. 

  508. 								<li>
    509. 

  509. 									<h5>type: <span class="tsd-signature-type">T</span></h5>
    510. 

  510. 									<div class="tsd-comment tsd-typography">
    511. 

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

  512. 									</div>
    513. 

  513. 								</li>
    514. 

  514. 								<li>
    515. 

  515. 									<h5>listener: <a href="../interfaces/listener.html" class="tsd-signature-type">Listener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
    516. 

  516. 									<div class="tsd-comment tsd-typography">
    517. 

  517. 										<p>流对象事件监听函数</p>
    518. 

  518. 									</div>
    519. 

  519. 								</li>
    520. 

  520. 							</ul>
    521. 

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

  522. 						</li>
    523. 

  523. 					</ul>
    524. 

  524. 				</section>
    525. 

  525. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
    526. 

  526. 					<a name="on" class="tsd-anchor"></a>
    527. 

  527. 					<h3>on</h3>
    528. 

  528. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
    529. 

  529. 						<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><a href="../interfaces/listener.html" class="tsd-signature-type">Listener</a><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>
    530. 

  530. 					</ul>
    531. 

  531. 					<ul class="tsd-descriptions">
    532. 

  532. 						<li class="tsd-description">
    533. 

  533. 							<aside class="tsd-sources">
    534. 

  534. 								<p>Inherited from EventEmitter.on</p>
    535. 

  535. 							</aside>
    536. 

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

  537. 								<div class="lead">
    538. 

  538. 									<p>监听流对象事件</p>
    539. 

  539. 								</div>
    540. 

  540. 							</div>
    541. 

  541. 							<h4 class="tsd-type-parameters-title">Type parameters</h4>
    542. 

  542. 							<ul class="tsd-type-parameters">
    543. 

  543. 								<li>
    544. 

  544. 									<h4>T<span class="tsd-signature-symbol">: </span><a href="../index.html#rtceventtype" class="tsd-signature-type">RtcEventType</a></h4>
    545. 

  545. 								</li>
    546. 

  546. 							</ul>
    547. 

  547. 							<h4 class="tsd-parameters-title">Parameters</h4>
    548. 

  548. 							<ul class="tsd-parameters">
    549. 

  549. 								<li>
    550. 

  550. 									<h5>type: <span class="tsd-signature-type">T</span></h5>
    551. 

  551. 									<div class="tsd-comment tsd-typography">
    552. 

  552. 										<p>流事件类型</p>
    553. 

  553. 									</div>
    554. 

  554. 								</li>
    555. 

  555. 								<li>
    556. 

  556. 									<h5>listener: <a href="../interfaces/listener.html" class="tsd-signature-type">Listener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
    557. 

  557. 									<div class="tsd-comment tsd-typography">
    558. 

  558. 										<p>流事件监听函数</p>
    559. 

  559. 									</div>
    560. 

  560. 								</li>
    561. 

  561. 							</ul>
    562. 

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

  563. 						</li>
    564. 

  564. 					</ul>
    565. 

  565. 				</section>
    566. 

  566. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
    567. 

  567. 					<a name="play" class="tsd-anchor"></a>
    568. 

  568. 					<h3>play</h3>
    569. 

  569. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
    570. 

  570. 						<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">HTMLElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/playoptions.html" class="tsd-signature-type">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>
    571. 

  571. 					</ul>
    572. 

  572. 					<ul class="tsd-descriptions">
    573. 

  573. 						<li class="tsd-description">
    574. 

  574. 							<aside class="tsd-sources">
    575. 

  575. 								<p>Overrides <a href="remotestream.html">RemoteStream</a>.<a href="remotestream.html#play">play</a></p>
    576. 

  576. 							</aside>
    577. 

  577. 							<div class="tsd-comment tsd-typography">
    578. 

  578. 								<div class="lead">
    579. 

  579. 									<p>播放当前流</p>
    580. 

  580. 								</div>
    581. 

  581. 								<dl class="tsd-comment-tags">
    582. 

  582. 									<dt>example</dt>
    583. 

  583. 									<dd><pre><code class="language-js"><span class="hljs-keyword">const</span> container = <span class="hljs-string">&#x27;xxx&#x27;</span>; <span class="hljs-comment">// 比如 id 为 xxx 的 div 元素</span>
    584. 

  584. stream
    585. 

  585.   .play(container)
    586. 

  586.   .catch(<span class="hljs-function">(<span class="hljs-params">err</span>) =&gt;</span> {
    587. 

  587.     <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`播放失败: <span class="hljs-subst">${err}</span>`</span>); <span class="hljs-comment">// 一般由于浏览器对自动播放的限制导致播放失败</span>
    588. 

  588.   });</code></pre>
    589. 

  589. 									</dd>
    590. 

  590. 									<dt>reject</dt>
    591. 

  591. 									<dd><p><a href="rtcerror.html">RtcError</a></p>
    592. 

  592. 									</dd>
    593. 

  593. 								</dl>
    594. 

  594. 							</div>
    595. 

  595. 							<h4 class="tsd-parameters-title">Parameters</h4>
    596. 

  596. 							<ul class="tsd-parameters">
    597. 

  597. 								<li>
    598. 

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

  599. 									<div class="tsd-comment tsd-typography">
    600. 

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

  601. 									</div>
    602. 

  602. 								</li>
    603. 

  603. 								<li>
    604. 

  604. 									<h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="../interfaces/playoptions.html" class="tsd-signature-type">PlayOptions</a></h5>
    605. 

  605. 									<div class="tsd-comment tsd-typography">
    606. 

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

  607. 									</div>
    608. 

  608. 								</li>
    609. 

  609. 							</ul>
    610. 

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

  611. 						</li>
    612. 

  612. 					</ul>
    613. 

  613. 				</section>
    614. 

  614. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
    615. 

  615. 					<a name="removetrack" class="tsd-anchor"></a>
    616. 

  616. 					<h3>remove<wbr>Track</h3>
    617. 

  617. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    618. 

  618. 						<li class="tsd-signature tsd-kind-icon">remove<wbr>Track<span class="tsd-signature-symbol">(</span>track<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
    619. 

  619. 					</ul>
    620. 

  620. 					<ul class="tsd-descriptions">
    621. 

  621. 						<li class="tsd-description">
    622. 

  622. 							<aside class="tsd-sources">
    623. 

  623. 							</aside>
    624. 

  624. 							<div class="tsd-comment tsd-typography">
    625. 

  625. 								<div class="lead">
    626. 

  626. 									<p>从当前流中删除一条媒体轨道（音轨或视轨）</p>
    627. 

  627. 								</div>
    628. 

  628. 								<dl class="tsd-comment-tags">
    629. 

  629. 									<dt>example</dt>
    630. 

  630. 									<dd><pre><code class="language-js">stream.removeTrack(track);</code></pre>
    631. 

  631. 									</dd>
    632. 

  632. 								</dl>
    633. 

  633. 							</div>
    634. 

  634. 							<h4 class="tsd-parameters-title">Parameters</h4>
    635. 

  635. 							<ul class="tsd-parameters">
    636. 

  636. 								<li>
    637. 

  637. 									<h5>track: <span class="tsd-signature-type">MediaStreamTrack</span></h5>
    638. 

  638. 									<div class="tsd-comment tsd-typography">
    639. 

  639. 										<p>媒体轨道</p>
    640. 

  640. 									</div>
    641. 

  641. 								</li>
    642. 

  642. 							</ul>
    643. 

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

  644. 						</li>
    645. 

  645. 					</ul>
    646. 

  646. 				</section>
    647. 

  647. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
    648. 

  648. 					<a name="replacetrack" class="tsd-anchor"></a>
    649. 

  649. 					<h3>replace<wbr>Track</h3>
    650. 

  650. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    651. 

  651. 						<li class="tsd-signature tsd-kind-icon">replace<wbr>Track<span class="tsd-signature-symbol">(</span>track<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
    652. 

  652. 					</ul>
    653. 

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

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

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

  656. 							</aside>
    657. 

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

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

  659. 									<p>替换当前流中的媒体轨道</p>
    660. 

  660. 									<blockquote>
    661. 

  661. 										<p>注：</p>
    662. 

  662. 										<ol>
    663. 

  663. 											<li>替换视频时，请使用与原轨道相同的分辨率的媒体轨道</li>
    664. 

  664. 											<li>返回值为当前流中相同类型的媒体轨道，此媒体轨道仍可用（占用音频设备或视频设备），请自行决定是否调用其 stop 方法释放设备</li>
    665. 

  665. 										</ol>
    666. 

  666. 									</blockquote>
    667. 

  667. 								</div>
    668. 

  668. 								<dl class="tsd-comment-tags">
    669. 

  669. 									<dt>example</dt>
    670. 

  670. 									<dd><pre><code class="language-js"><span class="hljs-keyword">const</span> oldTrack = stream.replaceTrack(track);
    671. 

  671. oldTrack.stop();</code></pre>
    672. 

  672. 									</dd>
    673. 

  673. 								</dl>
    674. 

  674. 							</div>
    675. 

  675. 							<h4 class="tsd-parameters-title">Parameters</h4>
    676. 

  676. 							<ul class="tsd-parameters">
    677. 

  677. 								<li>
    678. 

  678. 									<h5>track: <span class="tsd-signature-type">MediaStreamTrack</span></h5>
    679. 

  679. 									<div class="tsd-comment tsd-typography">
    680. 

  680. 										<p>新媒体轨道</p>
    681. 

  681. 									</div>
    682. 

  682. 								</li>
    683. 

  683. 							</ul>
    684. 

  684. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
    685. 

  685. 						</li>
    686. 

  686. 					</ul>
    687. 

  687. 				</section>
    688. 

  688. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    689. 

  689. 					<a name="resume" class="tsd-anchor"></a>
    690. 

  690. 					<h3>resume</h3>
    691. 

  691. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    692. 

  692. 						<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>
    693. 

  693. 					</ul>
    694. 

  694. 					<ul class="tsd-descriptions">
    695. 

  695. 						<li class="tsd-description">
    696. 

  696. 							<aside class="tsd-sources">
    697. 

  697. 								<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#resume">resume</a></p>
    698. 

  698. 							</aside>
    699. 

  699. 							<div class="tsd-comment tsd-typography">
    700. 

  700. 								<div class="lead">
    701. 

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

  702. 								</div>
    703. 

  703. 								<dl class="tsd-comment-tags">
    704. 

  704. 									<dt>example</dt>
    705. 

  705. 									<dd><pre><code class="language-js">stream
    706. 

  706.   .resume()
    707. 

  707.   .catch(<span class="hljs-function">(<span class="hljs-params">err</span>) =&gt;</span> {
    708. 

  708.     <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`恢复播放失败：<span class="hljs-subst">${err}</span>`</span>);
    709. 

  709.   });</code></pre>
    710. 

  710. 									</dd>
    711. 

  711. 								</dl>
    712. 

  712. 							</div>
    713. 

  713. 							<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>
    714. 

  714. 						</li>
    715. 

  715. 					</ul>
    716. 

  716. 				</section>
    717. 

  717. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
    718. 

  718. 					<a name="setscreenprofile" class="tsd-anchor"></a>
    719. 

  719. 					<h3>set<wbr>Screen<wbr>Profile</h3>
    720. 

  720. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    721. 

  721. 						<li class="tsd-signature tsd-kind-icon">set<wbr>Screen<wbr>Profile<span class="tsd-signature-symbol">(</span>profile<span class="tsd-signature-symbol">: </span><a href="../index.html#screenprofile" class="tsd-signature-type">ScreenProfile</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/customvideoprofile.html" class="tsd-signature-type">CustomVideoProfile</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
    722. 

  722. 					</ul>
    723. 

  723. 					<ul class="tsd-descriptions">
    724. 

  724. 						<li class="tsd-description">
    725. 

  725. 							<aside class="tsd-sources">
    726. 

  726. 							</aside>
    727. 

  727. 							<div class="tsd-comment tsd-typography">
    728. 

  728. 								<div class="lead">
    729. 

  729. 									<p>设置当前流（屏幕共享时）视频的 Profile，默认 &#39;1080p&#39;
    730. 

  730. 									注：请务必在调用 init 方法之前，设置屏幕共享流的 Profile，否则无法生效。</p>
    731. 

  731. 								</div>
    732. 

  732. 								<dl class="tsd-comment-tags">
    733. 

  733. 									<dt>example</dt>
    734. 

  734. 									<dd><pre><code class="language-js">stream.setScreenProfile(<span class="hljs-string">&#x27;720p&#x27;</span>);
    735. 

  735. stream.init().catch(<span class="hljs-function">(<span class="hljs-params">err</span>) =&gt;</span> {
    736. 

  736.   <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`初始化屏幕共享流失败 <span class="hljs-subst">${err}</span>`</span>);
    737. 

  737. });</code></pre>
    738. 

  738. 									</dd>
    739. 

  739. 								</dl>
    740. 

  740. 							</div>
    741. 

  741. 							<h4 class="tsd-parameters-title">Parameters</h4>
    742. 

  742. 							<ul class="tsd-parameters">
    743. 

  743. 								<li>
    744. 

  744. 									<h5>profile: <a href="../index.html#screenprofile" class="tsd-signature-type">ScreenProfile</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/customvideoprofile.html" class="tsd-signature-type">CustomVideoProfile</a></h5>
    745. 

  745. 									<div class="tsd-comment tsd-typography">
    746. 

  746. 										<p>视频 Profile</p>
    747. 

  747. 									</div>
    748. 

  748. 								</li>
    749. 

  749. 							</ul>
    750. 

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

  751. 						</li>
    752. 

  752. 					</ul>
    753. 

  753. 				</section>
    754. 

  754. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
    755. 

  755. 					<a name="setvideoprofile" class="tsd-anchor"></a>
    756. 

  756. 					<h3>set<wbr>Video<wbr>Profile</h3>
    757. 

  757. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    758. 

  758. 						<li class="tsd-signature tsd-kind-icon">set<wbr>Video<wbr>Profile<span class="tsd-signature-symbol">(</span>profile<span class="tsd-signature-symbol">: </span><a href="../index.html#videoprofile" class="tsd-signature-type">VideoProfile</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/customvideoprofile.html" class="tsd-signature-type">CustomVideoProfile</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
    759. 

  759. 					</ul>
    760. 

  760. 					<ul class="tsd-descriptions">
    761. 

  761. 						<li class="tsd-description">
    762. 

  762. 							<aside class="tsd-sources">
    763. 

  763. 							</aside>
    764. 

  764. 							<div class="tsd-comment tsd-typography">
    765. 

  765. 								<div class="lead">
    766. 

  766. 									<p>设置当前流视频的 Profile，默认 &#39;480p&#39;</p>
    767. 

  767. 								</div>
    768. 

  768. 								<dl class="tsd-comment-tags">
    769. 

  769. 									<dt>example</dt>
    770. 

  770. 									<dd><pre><code class="language-js">stream.setVideoProfile(<span class="hljs-string">&#x27;720p&#x27;</span>);</code></pre>
    771. 

  771. 										<p>或</p>
    772. 

  772. 										<pre><code class="language-js">stream.setVideoProfile({<span class="hljs-attr">width</span>: <span class="hljs-number">640</span>, <span class="hljs-attr">height</span>: <span class="hljs-number">480</span>, <span class="hljs-attr">framerate</span>: <span class="hljs-number">15</span>, <span class="hljs-attr">bitrate</span>: <span class="hljs-number">500</span>});</code></pre>
    773. 

  773. 									</dd>
    774. 

  774. 								</dl>
    775. 

  775. 							</div>
    776. 

  776. 							<h4 class="tsd-parameters-title">Parameters</h4>
    777. 

  777. 							<ul class="tsd-parameters">
    778. 

  778. 								<li>
    779. 

  779. 									<h5>profile: <a href="../index.html#videoprofile" class="tsd-signature-type">VideoProfile</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/customvideoprofile.html" class="tsd-signature-type">CustomVideoProfile</a></h5>
    780. 

  780. 									<div class="tsd-comment tsd-typography">
    781. 

  781. 										<p>视频 Profile</p>
    782. 

  782. 									</div>
    783. 

  783. 								</li>
    784. 

  784. 							</ul>
    785. 

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

  786. 						</li>
    787. 

  787. 					</ul>
    788. 

  788. 				</section>
    789. 

  789. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    790. 

  790. 					<a name="stop" class="tsd-anchor"></a>
    791. 

  791. 					<h3>stop</h3>
    792. 

  792. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    793. 

  793. 						<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>
    794. 

  794. 					</ul>
    795. 

  795. 					<ul class="tsd-descriptions">
    796. 

  796. 						<li class="tsd-description">
    797. 

  797. 							<aside class="tsd-sources">
    798. 

  798. 								<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#stop">stop</a></p>
    799. 

  799. 							</aside>
    800. 

  800. 							<div class="tsd-comment tsd-typography">
    801. 

  801. 								<div class="lead">
    802. 

  802. 									<p>停止播放当前流</p>
    803. 

  803. 								</div>
    804. 

  804. 								<dl class="tsd-comment-tags">
    805. 

  805. 									<dt>example</dt>
    806. 

  806. 									<dd><pre><code class="language-js">stream.stop();</code></pre>
    807. 

  807. 									</dd>
    808. 

  808. 								</dl>
    809. 

  809. 							</div>
    810. 

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

  811. 						</li>
    812. 

  812. 					</ul>
    813. 

  813. 				</section>
    814. 

  814. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
    815. 

  815. 					<a name="switchdevice" class="tsd-anchor"></a>
    816. 

  816. 					<h3>switch<wbr>Device</h3>
    817. 

  817. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    818. 

  818. 						<li class="tsd-signature tsd-kind-icon">switch<wbr>Device<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../index.html#switchdevicetype" class="tsd-signature-type">SwitchDeviceType</a>, deviceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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>
    819. 

  819. 					</ul>
    820. 

  820. 					<ul class="tsd-descriptions">
    821. 

  821. 						<li class="tsd-description">
    822. 

  822. 							<aside class="tsd-sources">
    823. 

  823. 							</aside>
    824. 

  824. 							<div class="tsd-comment tsd-typography">
    825. 

  825. 								<div class="lead">
    826. 

  826. 									<p>切换音视频设备</p>
    827. 

  827. 								</div>
    828. 

  828. 								<dl class="tsd-comment-tags">
    829. 

  829. 									<dt>example</dt>
    830. 

  830. 									<dd><pre><code class="language-js">stream.switchDevice(<span class="hljs-string">&#x27;audio&#x27;</span>, <span class="hljs-string">&#x27;xxxxxxx&#x27;</span>)
    831. 

  831.   .then(<span class="hljs-function">() =&gt;</span> {
    832. 

  832.     <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;切换设备成功&#x27;</span>);
    833. 

  833.   })
    834. 

  834.   .catch(<span class="hljs-function">(<span class="hljs-params">err</span>) =&gt;</span> {
    835. 

  835.     <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`切换设备失败：<span class="hljs-subst">${err}</span>`</span>);
    836. 

  836.   });</code></pre>
    837. 

  837. 									</dd>
    838. 

  838. 									<dt>reject</dt>
    839. 

  839. 									<dd><p><a href="rtcerror.html">RtcError</a></p>
    840. 

  840. 									</dd>
    841. 

  841. 								</dl>
    842. 

  842. 							</div>
    843. 

  843. 							<h4 class="tsd-parameters-title">Parameters</h4>
    844. 

  844. 							<ul class="tsd-parameters">
    845. 

  845. 								<li>
    846. 

  846. 									<h5>type: <a href="../index.html#switchdevicetype" class="tsd-signature-type">SwitchDeviceType</a></h5>
    847. 

  847. 									<div class="tsd-comment tsd-typography">
    848. 

  848. 										<p>设备类型</p>
    849. 

  849. 									</div>
    850. 

  850. 								</li>
    851. 

  851. 								<li>
    852. 

  852. 									<h5>deviceId: <span class="tsd-signature-type">string</span></h5>
    853. 

  853. 									<div class="tsd-comment tsd-typography">
    854. 

  854. 										<p>设备 ID</p>
    855. 

  855. 									</div>
    856. 

  856. 								</li>
    857. 

  857. 							</ul>
    858. 

  858. 							<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>
    859. 

  859. 						</li>
    860. 

  860. 					</ul>
    861. 

  861. 				</section>
    862. 

  862. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
    863. 

  863. 					<a name="switchimage" class="tsd-anchor"></a>
    864. 

  864. 					<h3>switch<wbr>Image</h3>
    865. 

  865. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    866. 

  866. 						<li class="tsd-signature tsd-kind-icon">switch<wbr>Image<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">File</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>
    867. 

  867. 					</ul>
    868. 

  868. 					<ul class="tsd-descriptions">
    869. 

  869. 						<li class="tsd-description">
    870. 

  870. 							<aside class="tsd-sources">
    871. 

  871. 							</aside>
    872. 

  872. 							<div class="tsd-comment tsd-typography">
    873. 

  873. 								<div class="lead">
    874. 

  874. 									<p>切换图片 - 使用图片生成视频，并将当前流的视频使用其代替</p>
    875. 

  875. 								</div>
    876. 

  876. 								<dl class="tsd-comment-tags">
    877. 

  877. 									<dt>example</dt>
    878. 

  878. 									<dd><pre><code class="language-js"><span class="hljs-keyword">const</span> imgAddr = <span class="hljs-string">&#x27;https://a.b.c/d.jpg&#x27;</span>;
    879. 

  879. stream.switchImage(imgAddr)
    880. 

  880.   .then(<span class="hljs-function">() =&gt;</span> {
    881. 

  881.     <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;切换图片成功&#x27;</span>)
    882. 

  882.   })
    883. 

  883.   .catch(<span class="hljs-function">(<span class="hljs-params">err</span>) =&gt;</span> {
    884. 

  884.     <span class="hljs-built_in">console</span>.error(<span class="hljs-string">`切换图片失败：<span class="hljs-subst">${err}</span>`</span>);
    885. 

  885.   });</code></pre>
    886. 

  886. 									</dd>
    887. 

  887. 									<dt>reject</dt>
    888. 

  888. 									<dd><p><a href="rtcerror.html">RtcError</a></p>
    889. 

  889. 									</dd>
    890. 

  890. 								</dl>
    891. 

  891. 							</div>
    892. 

  892. 							<h4 class="tsd-parameters-title">Parameters</h4>
    893. 

  893. 							<ul class="tsd-parameters">
    894. 

  894. 								<li>
    895. 

  895. 									<h5>file: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">File</span></h5>
    896. 

  896. 									<div class="tsd-comment tsd-typography">
    897. 

  897. 										<p>图片地址或图片文件</p>
    898. 

  898. 									</div>
    899. 

  899. 								</li>
    900. 

  900. 							</ul>
    901. 

  901. 							<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>
    902. 

  902. 						</li>
    903. 

  903. 					</ul>
    904. 

  904. 				</section>
    905. 

  905. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    906. 

  906. 					<a name="unmuteaudio" class="tsd-anchor"></a>
    907. 

  907. 					<h3>unmute<wbr>Audio</h3>
    908. 

  908. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    909. 

  909. 						<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>
    910. 

  910. 					</ul>
    911. 

  911. 					<ul class="tsd-descriptions">
    912. 

  912. 						<li class="tsd-description">
    913. 

  913. 							<aside class="tsd-sources">
    914. 

  914. 								<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#unmuteaudio">unmuteAudio</a></p>
    915. 

  915. 							</aside>
    916. 

  916. 							<div class="tsd-comment tsd-typography">
    917. 

  917. 								<div class="lead">
    918. 

  918. 									<p>unmute 当前流的音频</p>
    919. 

  919. 									<ul>
    920. 

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

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

  922. 									</ul>
    923. 

  923. 								</div>
    924. 

  924. 								<dl class="tsd-comment-tags">
    925. 

  925. 									<dt>example</dt>
    926. 

  926. 									<dd><pre><code class="language-js"><span class="hljs-keyword">const</span> result = stream.unmuteAudio();
    927. 

  927. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`stream&#x27;s audio is muted <span class="hljs-subst">${stream.audioMuted}</span>`</span>);</code></pre>
    928. 

  928. 									</dd>
    929. 

  929. 								</dl>
    930. 

  930. 							</div>
    931. 

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

  932. 							<p>操作是否成功</p>
    933. 

  933. 						</li>
    934. 

  934. 					</ul>
    935. 

  935. 				</section>
    936. 

  936. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    937. 

  937. 					<a name="unmutevideo" class="tsd-anchor"></a>
    938. 

  938. 					<h3>unmute<wbr>Video</h3>
    939. 

  939. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    940. 

  940. 						<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>
    941. 

  941. 					</ul>
    942. 

  942. 					<ul class="tsd-descriptions">
    943. 

  943. 						<li class="tsd-description">
    944. 

  944. 							<aside class="tsd-sources">
    945. 

  945. 								<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#unmutevideo">unmuteVideo</a></p>
    946. 

  946. 							</aside>
    947. 

  947. 							<div class="tsd-comment tsd-typography">
    948. 

  948. 								<div class="lead">
    949. 

  949. 									<p>unmute 当前流的视频</p>
    950. 

  950. 									<ul>
    951. 

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

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

  953. 									</ul>
    954. 

  954. 								</div>
    955. 

  955. 								<dl class="tsd-comment-tags">
    956. 

  956. 									<dt>example</dt>
    957. 

  957. 									<dd><pre><code class="language-js"><span class="hljs-keyword">const</span> result = stream.unmuteVideo();
    958. 

  958. <span class="hljs-built_in">console</span>.log(<span class="hljs-string">`stream&#x27;s video is muted <span class="hljs-subst">${stream.videoMuted}</span>`</span>);</code></pre>
    959. 

  959. 									</dd>
    960. 

  960. 								</dl>
    961. 

  961. 							</div>
    962. 

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

  963. 							<p>操作是否成功</p>
    964. 

  964. 						</li>
    965. 

  965. 					</ul>
    966. 

  966. 				</section>
    967. 

  967. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
    968. 

  968. 					<a name="use" class="tsd-anchor"></a>
    969. 

  969. 					<h3><span class="tsd-flag ts-flagStatic">Static</span> use</h3>
    970. 

  970. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
    971. 

  971. 						<li class="tsd-signature tsd-kind-icon">use<span class="tsd-signature-symbol">(</span>plugin<span class="tsd-signature-symbol">: </span><a href="../interfaces/streamplugin.html" class="tsd-signature-type">StreamPlugin</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
    972. 

  972. 					</ul>
    973. 

  973. 					<ul class="tsd-descriptions">
    974. 

  974. 						<li class="tsd-description">
    975. 

  975. 							<aside class="tsd-sources">
    976. 

  976. 							</aside>
    977. 

  977. 							<div class="tsd-comment tsd-typography">
    978. 

  978. 								<div class="lead">
    979. 

  979. 									<p>加载流插件，使用插件功能</p>
    980. 

  980. 								</div>
    981. 

  981. 							</div>
    982. 

  982. 							<h4 class="tsd-parameters-title">Parameters</h4>
    983. 

  983. 							<ul class="tsd-parameters">
    984. 

  984. 								<li>
    985. 

  985. 									<h5>plugin: <a href="../interfaces/streamplugin.html" class="tsd-signature-type">StreamPlugin</a></h5>
    986. 

  986. 									<div class="tsd-comment tsd-typography">
    987. 

  987. 										<p>插件</p>
    988. 

  988. 									</div>
    989. 

  989. 								</li>
    990. 

  990. 								<li>
    991. 

  991. 									<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
    992. 

  992. 									<div class="tsd-comment tsd-typography">
    993. 

  993. 										<p>插件初始化参数</p>
    994. 

  994. 									</div>
    995. 

  995. 								</li>
    996. 

  996. 							</ul>
    997. 

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

  998. 						</li>
    999. 

  999. 					</ul>
    1000. 

  1000. 				</section>
    1001. 

  1001. 			</section>
    1002. 

  1002. 		</div>
    1003. 

  1003. 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
    1004. 

  1004. 			<nav class="tsd-navigation primary">
    1005. 

  1005. 				<ul>
    1006. 

  1006. 					<li class="globals  ">
    1007. 

  1007. 						<a href="../index.html"><em>Globals</em></a>
    1008. 

  1008. 					</li>
    1009. 

  1009. 				</ul>
    1010. 

  1010. 			</nav>
    1011. 

  1011. 			<nav class="tsd-navigation secondary menu-sticky">
    1012. 

  1012. 				<ul class="before-current">
    1013. 

  1013. 				</ul>
    1014. 

  1014. 				<ul class="current">
    1015. 

  1015. 					<li class="current tsd-kind-class tsd-is-external">
    1016. 

  1016. 						<a href="localstream.html" class="tsd-kind-icon">Local<wbr>Stream</a>
    1017. 

  1017. 						<ul>
    1018. 

  1018. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1019. 

  1019. 								<a href="localstream.html#audiomuted" class="tsd-kind-icon">audio<wbr>Muted</a>
    1020. 

  1020. 							</li>
    1021. 

  1021. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1022. 

  1022. 								<a href="localstream.html#id" class="tsd-kind-icon">id</a>
    1023. 

  1023. 							</li>
    1024. 

  1024. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1025. 

  1025. 								<a href="localstream.html#mediastream" class="tsd-kind-icon">media<wbr>Stream</a>
    1026. 

  1026. 							</li>
    1027. 

  1027. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1028. 

  1028. 								<a href="localstream.html#videomuted" class="tsd-kind-icon">video<wbr>Muted</a>
    1029. 

  1029. 							</li>
    1030. 

  1030. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
    1031. 

  1031. 								<a href="localstream.html#addtrack" class="tsd-kind-icon">add<wbr>Track</a>
    1032. 

  1032. 							</li>
    1033. 

  1033. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1034. 

  1034. 								<a href="localstream.html#destroy" class="tsd-kind-icon">destroy</a>
    1035. 

  1035. 							</li>
    1036. 

  1036. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1037. 

  1037. 								<a href="localstream.html#getaudiolevel" class="tsd-kind-icon">get<wbr>Audio<wbr>Level</a>
    1038. 

  1038. 							</li>
    1039. 

  1039. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1040. 

  1040. 								<a href="localstream.html#getmediatype" class="tsd-kind-icon">get<wbr>Media<wbr>Type</a>
    1041. 

  1041. 							</li>
    1042. 

  1042. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1043. 

  1043. 								<a href="localstream.html#getstats" class="tsd-kind-icon">get<wbr>Stats</a>
    1044. 

  1044. 							</li>
    1045. 

  1045. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1046. 

  1046. 								<a href="localstream.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a>
    1047. 

  1047. 							</li>
    1048. 

  1048. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1049. 

  1049. 								<a href="localstream.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a>
    1050. 

  1050. 							</li>
    1051. 

  1051. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
    1052. 

  1052. 								<a href="localstream.html#init" class="tsd-kind-icon">init</a>
    1053. 

  1053. 							</li>
    1054. 

  1054. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1055. 

  1055. 								<a href="localstream.html#muteaudio" class="tsd-kind-icon">mute<wbr>Audio</a>
    1056. 

  1056. 							</li>
    1057. 

  1057. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1058. 

  1058. 								<a href="localstream.html#mutevideo" class="tsd-kind-icon">mute<wbr>Video</a>
    1059. 

  1059. 							</li>
    1060. 

  1060. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
    1061. 

  1061. 								<a href="localstream.html#off" class="tsd-kind-icon">off</a>
    1062. 

  1062. 							</li>
    1063. 

  1063. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external">
    1064. 

  1064. 								<a href="localstream.html#on" class="tsd-kind-icon">on</a>
    1065. 

  1065. 							</li>
    1066. 

  1066. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
    1067. 

  1067. 								<a href="localstream.html#play" class="tsd-kind-icon">play</a>
    1068. 

  1068. 							</li>
    1069. 

  1069. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
    1070. 

  1070. 								<a href="localstream.html#removetrack" class="tsd-kind-icon">remove<wbr>Track</a>
    1071. 

  1071. 							</li>
    1072. 

  1072. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
    1073. 

  1073. 								<a href="localstream.html#replacetrack" class="tsd-kind-icon">replace<wbr>Track</a>
    1074. 

  1074. 							</li>
    1075. 

  1075. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1076. 

  1076. 								<a href="localstream.html#resume" class="tsd-kind-icon">resume</a>
    1077. 

  1077. 							</li>
    1078. 

  1078. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
    1079. 

  1079. 								<a href="localstream.html#setscreenprofile" class="tsd-kind-icon">set<wbr>Screen<wbr>Profile</a>
    1080. 

  1080. 							</li>
    1081. 

  1081. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
    1082. 

  1082. 								<a href="localstream.html#setvideoprofile" class="tsd-kind-icon">set<wbr>Video<wbr>Profile</a>
    1083. 

  1083. 							</li>
    1084. 

  1084. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1085. 

  1085. 								<a href="localstream.html#stop" class="tsd-kind-icon">stop</a>
    1086. 

  1086. 							</li>
    1087. 

  1087. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
    1088. 

  1088. 								<a href="localstream.html#switchdevice" class="tsd-kind-icon">switch<wbr>Device</a>
    1089. 

  1089. 							</li>
    1090. 

  1090. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
    1091. 

  1091. 								<a href="localstream.html#switchimage" class="tsd-kind-icon">switch<wbr>Image</a>
    1092. 

  1092. 							</li>
    1093. 

  1093. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1094. 

  1094. 								<a href="localstream.html#unmuteaudio" class="tsd-kind-icon">unmute<wbr>Audio</a>
    1095. 

  1095. 							</li>
    1096. 

  1096. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1097. 

  1097. 								<a href="localstream.html#unmutevideo" class="tsd-kind-icon">unmute<wbr>Video</a>
    1098. 

  1098. 							</li>
    1099. 

  1099. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
    1100. 

  1100. 								<a href="localstream.html#use" class="tsd-kind-icon">use</a>
    1101. 

  1101. 							</li>
    1102. 

  1102. 						</ul>
    1103. 

  1103. 					</li>
    1104. 

  1104. 				</ul>
    1105. 

  1105. 				<ul class="after-current">
    1106. 

  1106. 				</ul>
    1107. 

  1107. 			</nav>
    1108. 

  1108. 		</div>
    1109. 

  1109. 	</div>
    1110. 

  1110. </div>
    1111. 

  1111. <footer class="with-border-bottom">
    1112. 

  1112. 	<div class="container">
    1113. 

  1113. 		<h2>Legend</h2>
    1114. 

  1114. 		<div class="tsd-legend-group">
    1115. 

  1115. 		</div>
    1116. 

  1116. 	</div>
    1117. 

  1117. </footer>
    1118. 

  1118. <div class="container tsd-generator">
    1119. 

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

  1120. </div>
    1121. 

  1121. <div class="overlay"></div>
    1122. 

  1122. <script src="../assets/js/main.js"></script>
    1123. 

  1123. </body>
    1124. 

  1124. </html>
    1125.