Home Explore Help
Sign In
githab
/
urtc-sdk-web
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 34fc6ff30f
Branches Tags
urtc-sdk-web
/
docs
/
classes
/
localstream.html

localstream.html 64 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132 
  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>添加一条媒体轨道（音轨或视轨）到当前流
    202. 

  202. 									注：</p>
    203. 

  203. 									<ol>
    204. 

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

  205. 									</ol>
    206. 

  206. 								</div>
    207. 

  207. 								<dl class="tsd-comment-tags">
    208. 

  208. 									<dt>example</dt>
    209. 

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

  210. 									</dd>
    211. 

  211. 								</dl>
    212. 

  212. 							</div>
    213. 

  213. 							<h4 class="tsd-parameters-title">Parameters</h4>
    214. 

  214. 							<ul class="tsd-parameters">
    215. 

  215. 								<li>
    216. 

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

  217. 									<div class="tsd-comment tsd-typography">
    218. 

  218. 										<p>媒体轨道</p>
    219. 

  219. 									</div>
    220. 

  220. 								</li>
    221. 

  221. 							</ul>
    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 tsd-is-inherited tsd-is-external">
    227. 

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

  228. 					<h3>destroy</h3>
    229. 

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

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

  231. 					</ul>
    232. 

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

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

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

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

  236. 							</aside>
    237. 

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

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

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

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

  241. 								</div>
    242. 

  242. 								<dl class="tsd-comment-tags">
    243. 

  243. 									<dt>example</dt>
    244. 

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

  245. 									</dd>
    246. 

  246. 								</dl>
    247. 

  247. 							</div>
    248. 

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

  249. 						</li>
    250. 

  250. 					</ul>
    251. 

  251. 				</section>
    252. 

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

  253. 					<a name="getaudiolevel" class="tsd-anchor"></a>
    254. 

  254. 					<h3>get<wbr>Audio<wbr>Level</h3>
    255. 

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

  256. 						<li class="tsd-signature tsd-kind-icon">get<wbr>Audio<wbr>Level<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
    257. 

  257. 					</ul>
    258. 

  258. 					<ul class="tsd-descriptions">
    259. 

  259. 						<li class="tsd-description">
    260. 

  260. 							<aside class="tsd-sources">
    261. 

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

  262. 							</aside>
    263. 

  263. 							<div class="tsd-comment tsd-typography">
    264. 

  264. 								<div class="lead">
    265. 

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

  266. 								</div>
    267. 

  267. 								<dl class="tsd-comment-tags">
    268. 

  268. 									<dt>example</dt>
    269. 

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

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

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

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

  273.   }
    274. 

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

  275. 									</dd>
    276. 

  276. 								</dl>
    277. 

  277. 							</div>
    278. 

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

  279. 						</li>
    280. 

  280. 					</ul>
    281. 

  281. 				</section>
    282. 

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

  283. 					<a name="getmediatype" class="tsd-anchor"></a>
    284. 

  284. 					<h3>get<wbr>Media<wbr>Type</h3>
    285. 

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

  286. 						<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>
    287. 

  287. 					</ul>
    288. 

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

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

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

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

  292. 							</aside>
    293. 

  293. 							<div class="tsd-comment tsd-typography">
    294. 

  294. 								<div class="lead">
    295. 

  295. 									<p>获取流的媒体类型</p>
    296. 

  296. 								</div>
    297. 

  297. 								<dl class="tsd-comment-tags">
    298. 

  298. 									<dt>example</dt>
    299. 

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

  300. 									</dd>
    301. 

  301. 								</dl>
    302. 

  302. 							</div>
    303. 

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

  304. 						</li>
    305. 

  305. 					</ul>
    306. 

  306. 				</section>
    307. 

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

  308. 					<a name="getstats" class="tsd-anchor"></a>
    309. 

  309. 					<h3>get<wbr>Stats</h3>
    310. 

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

  311. 						<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>
    312. 

  312. 					</ul>
    313. 

  313. 					<ul class="tsd-descriptions">
    314. 

  314. 						<li class="tsd-description">
    315. 

  315. 							<aside class="tsd-sources">
    316. 

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

  317. 							</aside>
    318. 

  318. 							<div class="tsd-comment tsd-typography">
    319. 

  319. 								<div class="lead">
    320. 

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

  321. 								</div>
    322. 

  322. 								<dl class="tsd-comment-tags">
    323. 

  323. 									<dt>example</dt>
    324. 

  324. 									<dd><pre><code class="language-js">stream
    325. 

  325.   .getStats()
    326. 

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

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

  328.   });</code></pre>
    329. 

  329. 									</dd>
    330. 

  330. 								</dl>
    331. 

  331. 							</div>
    332. 

  332. 							<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>
    333. 

  333. 						</li>
    334. 

  334. 					</ul>
    335. 

  335. 				</section>
    336. 

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

  337. 					<a name="hasaudio" class="tsd-anchor"></a>
    338. 

  338. 					<h3>has<wbr>Audio</h3>
    339. 

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

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

  341. 					</ul>
    342. 

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

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

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

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

  346. 							</aside>
    347. 

  347. 							<div class="tsd-comment tsd-typography">
    348. 

  348. 								<div class="lead">
    349. 

  349. 									<p>判断当前流是否有音频</p>
    350. 

  350. 								</div>
    351. 

  351. 								<dl class="tsd-comment-tags">
    352. 

  352. 									<dt>example</dt>
    353. 

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

  354. 									</dd>
    355. 

  355. 								</dl>
    356. 

  356. 							</div>
    357. 

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

  358. 						</li>
    359. 

  359. 					</ul>
    360. 

  360. 				</section>
    361. 

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

  362. 					<a name="hasvideo" class="tsd-anchor"></a>
    363. 

  363. 					<h3>has<wbr>Video</h3>
    364. 

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

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

  366. 					</ul>
    367. 

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

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

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

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

  371. 							</aside>
    372. 

  372. 							<div class="tsd-comment tsd-typography">
    373. 

  373. 								<div class="lead">
    374. 

  374. 									<p>判断当前流是否有视频</p>
    375. 

  375. 								</div>
    376. 

  376. 								<dl class="tsd-comment-tags">
    377. 

  377. 									<dt>example</dt>
    378. 

  378. 									<dd><pre><code class="language-js"><span class="hljs-keyword">const</span> result = stream.hasVideo();</code></pre>
    379. 

  379. 									</dd>
    380. 

  380. 								</dl>
    381. 

  381. 							</div>
    382. 

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

  383. 						</li>
    384. 

  384. 					</ul>
    385. 

  385. 				</section>
    386. 

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

  387. 					<a name="init" class="tsd-anchor"></a>
    388. 

  388. 					<h3>init</h3>
    389. 

  389. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    390. 

  390. 						<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>
    391. 

  391. 					</ul>
    392. 

  392. 					<ul class="tsd-descriptions">
    393. 

  393. 						<li class="tsd-description">
    394. 

  394. 							<aside class="tsd-sources">
    395. 

  395. 							</aside>
    396. 

  396. 							<div class="tsd-comment tsd-typography">
    397. 

  397. 								<div class="lead">
    398. 

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

  399. 								</div>
    400. 

  400. 								<dl class="tsd-comment-tags">
    401. 

  401. 									<dt>example</dt>
    402. 

  402. 									<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>});
    403. 

  403. stream
    404. 

  404.   .init()
    405. 

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

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

  407.   })
    408. 

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

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

  410.   })</code></pre>
    411. 

  411. 									</dd>
    412. 

  412. 								</dl>
    413. 

  413. 							</div>
    414. 

  414. 							<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>
    415. 

  415. 						</li>
    416. 

  416. 					</ul>
    417. 

  417. 				</section>
    418. 

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

  419. 					<a name="muteaudio" class="tsd-anchor"></a>
    420. 

  420. 					<h3>mute<wbr>Audio</h3>
    421. 

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

  422. 						<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>
    423. 

  423. 					</ul>
    424. 

  424. 					<ul class="tsd-descriptions">
    425. 

  425. 						<li class="tsd-description">
    426. 

  426. 							<aside class="tsd-sources">
    427. 

  427. 								<p>Inherited from <a href="localstream.html">LocalStream</a>.<a href="localstream.html#muteaudio">muteAudio</a></p>
    428. 

  428. 							</aside>
    429. 

  429. 							<div class="tsd-comment tsd-typography">
    430. 

  430. 								<div class="lead">
    431. 

  431. 									<p>mute 当前流的音频</p>
    432. 

  432. 									<ul>
    433. 

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

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

  435. 									</ul>
    436. 

  436. 								</div>
    437. 

  437. 								<dl class="tsd-comment-tags">
    438. 

  438. 									<dt>example</dt>
    439. 

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

  440. <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>
    441. 

  441. 									</dd>
    442. 

  442. 								</dl>
    443. 

  443. 							</div>
    444. 

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

  445. 							<p>操作是否成功</p>
    446. 

  446. 						</li>
    447. 

  447. 					</ul>
    448. 

  448. 				</section>
    449. 

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

  450. 					<a name="mutevideo" class="tsd-anchor"></a>
    451. 

  451. 					<h3>mute<wbr>Video</h3>
    452. 

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

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

  454. 					</ul>
    455. 

  455. 					<ul class="tsd-descriptions">
    456. 

  456. 						<li class="tsd-description">
    457. 

  457. 							<aside class="tsd-sources">
    458. 

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

  459. 							</aside>
    460. 

  460. 							<div class="tsd-comment tsd-typography">
    461. 

  461. 								<div class="lead">
    462. 

  462. 									<p>mute 当前流的视频</p>
    463. 

  463. 									<ul>
    464. 

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

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

  466. 									</ul>
    467. 

  467. 								</div>
    468. 

  468. 								<dl class="tsd-comment-tags">
    469. 

  469. 									<dt>example</dt>
    470. 

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

  471. <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>
    472. 

  472. 									</dd>
    473. 

  473. 								</dl>
    474. 

  474. 							</div>
    475. 

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

  476. 							<p>操作是否成功</p>
    477. 

  477. 						</li>
    478. 

  478. 					</ul>
    479. 

  479. 				</section>
    480. 

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

  481. 					<a name="off" class="tsd-anchor"></a>
    482. 

  482. 					<h3>off</h3>
    483. 

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

  484. 						<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>
    485. 

  485. 					</ul>
    486. 

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

  487. 						<li class="tsd-description">
    488. 

  488. 							<aside class="tsd-sources">
    489. 

  489. 								<p>Inherited from EventEmitter.off</p>
    490. 

  490. 							</aside>
    491. 

  491. 							<div class="tsd-comment tsd-typography">
    492. 

  492. 								<div class="lead">
    493. 

  493. 									<p>取消监听流对象事件</p>
    494. 

  494. 								</div>
    495. 

  495. 							</div>
    496. 

  496. 							<h4 class="tsd-type-parameters-title">Type parameters</h4>
    497. 

  497. 							<ul class="tsd-type-parameters">
    498. 

  498. 								<li>
    499. 

  499. 									<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>
    500. 

  500. 								</li>
    501. 

  501. 							</ul>
    502. 

  502. 							<h4 class="tsd-parameters-title">Parameters</h4>
    503. 

  503. 							<ul class="tsd-parameters">
    504. 

  504. 								<li>
    505. 

  505. 									<h5>type: <span class="tsd-signature-type">T</span></h5>
    506. 

  506. 									<div class="tsd-comment tsd-typography">
    507. 

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

  508. 									</div>
    509. 

  509. 								</li>
    510. 

  510. 								<li>
    511. 

  511. 									<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>
    512. 

  512. 									<div class="tsd-comment tsd-typography">
    513. 

  513. 										<p>流对象事件监听函数</p>
    514. 

  514. 									</div>
    515. 

  515. 								</li>
    516. 

  516. 							</ul>
    517. 

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

  518. 						</li>
    519. 

  519. 					</ul>
    520. 

  520. 				</section>
    521. 

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

  522. 					<a name="on" class="tsd-anchor"></a>
    523. 

  523. 					<h3>on</h3>
    524. 

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

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

  526. 					</ul>
    527. 

  527. 					<ul class="tsd-descriptions">
    528. 

  528. 						<li class="tsd-description">
    529. 

  529. 							<aside class="tsd-sources">
    530. 

  530. 								<p>Inherited from EventEmitter.on</p>
    531. 

  531. 							</aside>
    532. 

  532. 							<div class="tsd-comment tsd-typography">
    533. 

  533. 								<div class="lead">
    534. 

  534. 									<p>监听流对象事件</p>
    535. 

  535. 								</div>
    536. 

  536. 							</div>
    537. 

  537. 							<h4 class="tsd-type-parameters-title">Type parameters</h4>
    538. 

  538. 							<ul class="tsd-type-parameters">
    539. 

  539. 								<li>
    540. 

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

  541. 								</li>
    542. 

  542. 							</ul>
    543. 

  543. 							<h4 class="tsd-parameters-title">Parameters</h4>
    544. 

  544. 							<ul class="tsd-parameters">
    545. 

  545. 								<li>
    546. 

  546. 									<h5>type: <span class="tsd-signature-type">T</span></h5>
    547. 

  547. 									<div class="tsd-comment tsd-typography">
    548. 

  548. 										<p>流事件类型</p>
    549. 

  549. 									</div>
    550. 

  550. 								</li>
    551. 

  551. 								<li>
    552. 

  552. 									<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>
    553. 

  553. 									<div class="tsd-comment tsd-typography">
    554. 

  554. 										<p>流事件监听函数</p>
    555. 

  555. 									</div>
    556. 

  556. 								</li>
    557. 

  557. 							</ul>
    558. 

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

  559. 						</li>
    560. 

  560. 					</ul>
    561. 

  561. 				</section>
    562. 

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

  563. 					<a name="play" class="tsd-anchor"></a>
    564. 

  564. 					<h3>play</h3>
    565. 

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

  566. 						<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>
    567. 

  567. 					</ul>
    568. 

  568. 					<ul class="tsd-descriptions">
    569. 

  569. 						<li class="tsd-description">
    570. 

  570. 							<aside class="tsd-sources">
    571. 

  571. 								<p>Overrides <a href="remotestream.html">RemoteStream</a>.<a href="remotestream.html#play">play</a></p>
    572. 

  572. 							</aside>
    573. 

  573. 							<div class="tsd-comment tsd-typography">
    574. 

  574. 								<div class="lead">
    575. 

  575. 									<p>播放当前流</p>
    576. 

  576. 								</div>
    577. 

  577. 								<dl class="tsd-comment-tags">
    578. 

  578. 									<dt>example</dt>
    579. 

  579. 									<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>
    580. 

  580. stream
    581. 

  581.   .play(container)
    582. 

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

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

  584.   });</code></pre>
    585. 

  585. 									</dd>
    586. 

  586. 									<dt>reject</dt>
    587. 

  587. 									<dd><p><a href="rtcerror.html">RtcError</a></p>
    588. 

  588. 									</dd>
    589. 

  589. 								</dl>
    590. 

  590. 							</div>
    591. 

  591. 							<h4 class="tsd-parameters-title">Parameters</h4>
    592. 

  592. 							<ul class="tsd-parameters">
    593. 

  593. 								<li>
    594. 

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

  595. 									<div class="tsd-comment tsd-typography">
    596. 

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

  597. 									</div>
    598. 

  598. 								</li>
    599. 

  599. 								<li>
    600. 

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

  601. 									<div class="tsd-comment tsd-typography">
    602. 

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

  603. 									</div>
    604. 

  604. 								</li>
    605. 

  605. 							</ul>
    606. 

  606. 							<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>
    607. 

  607. 						</li>
    608. 

  608. 					</ul>
    609. 

  609. 				</section>
    610. 

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

  611. 					<a name="removetrack" class="tsd-anchor"></a>
    612. 

  612. 					<h3>remove<wbr>Track</h3>
    613. 

  613. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    614. 

  614. 						<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>
    615. 

  615. 					</ul>
    616. 

  616. 					<ul class="tsd-descriptions">
    617. 

  617. 						<li class="tsd-description">
    618. 

  618. 							<aside class="tsd-sources">
    619. 

  619. 							</aside>
    620. 

  620. 							<div class="tsd-comment tsd-typography">
    621. 

  621. 								<div class="lead">
    622. 

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

  623. 								</div>
    624. 

  624. 								<dl class="tsd-comment-tags">
    625. 

  625. 									<dt>example</dt>
    626. 

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

  627. 									</dd>
    628. 

  628. 								</dl>
    629. 

  629. 							</div>
    630. 

  630. 							<h4 class="tsd-parameters-title">Parameters</h4>
    631. 

  631. 							<ul class="tsd-parameters">
    632. 

  632. 								<li>
    633. 

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

  634. 									<div class="tsd-comment tsd-typography">
    635. 

  635. 										<p>媒体轨道</p>
    636. 

  636. 									</div>
    637. 

  637. 								</li>
    638. 

  638. 							</ul>
    639. 

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

  640. 						</li>
    641. 

  641. 					</ul>
    642. 

  642. 				</section>
    643. 

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

  644. 					<a name="replacetrack" class="tsd-anchor"></a>
    645. 

  645. 					<h3>replace<wbr>Track</h3>
    646. 

  646. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    647. 

  647. 						<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>
    648. 

  648. 					</ul>
    649. 

  649. 					<ul class="tsd-descriptions">
    650. 

  650. 						<li class="tsd-description">
    651. 

  651. 							<aside class="tsd-sources">
    652. 

  652. 							</aside>
    653. 

  653. 							<div class="tsd-comment tsd-typography">
    654. 

  654. 								<div class="lead">
    655. 

  655. 									<p>替换当前流中的媒体轨道
    656. 

  656. 									注：</p>
    657. 

  657. 									<ol>
    658. 

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

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

  660. 									</ol>
    661. 

  661. 								</div>
    662. 

  662. 								<dl class="tsd-comment-tags">
    663. 

  663. 									<dt>example</dt>
    664. 

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

  665. oldTrack.stop();</code></pre>
    666. 

  666. 									</dd>
    667. 

  667. 								</dl>
    668. 

  668. 							</div>
    669. 

  669. 							<h4 class="tsd-parameters-title">Parameters</h4>
    670. 

  670. 							<ul class="tsd-parameters">
    671. 

  671. 								<li>
    672. 

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

  673. 									<div class="tsd-comment tsd-typography">
    674. 

  674. 										<p>新媒体轨道</p>
    675. 

  675. 									</div>
    676. 

  676. 								</li>
    677. 

  677. 							</ul>
    678. 

  678. 							<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>
    679. 

  679. 						</li>
    680. 

  680. 					</ul>
    681. 

  681. 				</section>
    682. 

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

  683. 					<a name="resume" class="tsd-anchor"></a>
    684. 

  684. 					<h3>resume</h3>
    685. 

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

  686. 						<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>
    687. 

  687. 					</ul>
    688. 

  688. 					<ul class="tsd-descriptions">
    689. 

  689. 						<li class="tsd-description">
    690. 

  690. 							<aside class="tsd-sources">
    691. 

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

  692. 							</aside>
    693. 

  693. 							<div class="tsd-comment tsd-typography">
    694. 

  694. 								<div class="lead">
    695. 

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

  696. 								</div>
    697. 

  697. 								<dl class="tsd-comment-tags">
    698. 

  698. 									<dt>example</dt>
    699. 

  699. 									<dd><pre><code class="language-js">stream
    700. 

  700.   .resume()
    701. 

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

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

  703.   });</code></pre>
    704. 

  704. 									</dd>
    705. 

  705. 								</dl>
    706. 

  706. 							</div>
    707. 

  707. 							<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>
    708. 

  708. 						</li>
    709. 

  709. 					</ul>
    710. 

  710. 				</section>
    711. 

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

  712. 					<a name="setscreenprofile" class="tsd-anchor"></a>
    713. 

  713. 					<h3>set<wbr>Screen<wbr>Profile</h3>
    714. 

  714. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    715. 

  715. 						<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>
    716. 

  716. 					</ul>
    717. 

  717. 					<ul class="tsd-descriptions">
    718. 

  718. 						<li class="tsd-description">
    719. 

  719. 							<aside class="tsd-sources">
    720. 

  720. 							</aside>
    721. 

  721. 							<div class="tsd-comment tsd-typography">
    722. 

  722. 								<div class="lead">
    723. 

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

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

  725. 								</div>
    726. 

  726. 								<dl class="tsd-comment-tags">
    727. 

  727. 									<dt>example</dt>
    728. 

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

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

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

  731. });</code></pre>
    732. 

  732. 									</dd>
    733. 

  733. 								</dl>
    734. 

  734. 							</div>
    735. 

  735. 							<h4 class="tsd-parameters-title">Parameters</h4>
    736. 

  736. 							<ul class="tsd-parameters">
    737. 

  737. 								<li>
    738. 

  738. 									<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>
    739. 

  739. 									<div class="tsd-comment tsd-typography">
    740. 

  740. 										<p>视频 Profile</p>
    741. 

  741. 									</div>
    742. 

  742. 								</li>
    743. 

  743. 							</ul>
    744. 

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

  745. 						</li>
    746. 

  746. 					</ul>
    747. 

  747. 				</section>
    748. 

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

  749. 					<a name="setvideoprofile" class="tsd-anchor"></a>
    750. 

  750. 					<h3>set<wbr>Video<wbr>Profile</h3>
    751. 

  751. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    752. 

  752. 						<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
    753. 

  753. 					</ul>
    754. 

  754. 					<ul class="tsd-descriptions">
    755. 

  755. 						<li class="tsd-description">
    756. 

  756. 							<aside class="tsd-sources">
    757. 

  757. 							</aside>
    758. 

  758. 							<div class="tsd-comment tsd-typography">
    759. 

  759. 								<div class="lead">
    760. 

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

  761. 								</div>
    762. 

  762. 								<dl class="tsd-comment-tags">
    763. 

  763. 									<dt>example</dt>
    764. 

  764. 									<dd><pre><code class="language-js">stream
    765. 

  765.   .setVideoProfile(<span class="hljs-string">&#x27;720p&#x27;</span>)
    766. 

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

  767.     <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;set video profile success&#x27;</span>);
    768. 

  768.   })
    769. 

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

  770.     <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;set video profile failed &#x27;</span>, err);
    771. 

  771.   });</code></pre>
    772. 

  772. 										<p>或</p>
    773. 

  773. 										<pre><code class="language-js">stream
    774. 

  774.   .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>});
    775. 

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

  776.     <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;set video profile success&#x27;</span>);
    777. 

  777.   })
    778. 

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

  779.     <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;set video profile failed &#x27;</span>, err);
    780. 

  780.   });</code></pre>
    781. 

  781. 									</dd>
    782. 

  782. 								</dl>
    783. 

  783. 							</div>
    784. 

  784. 							<h4 class="tsd-parameters-title">Parameters</h4>
    785. 

  785. 							<ul class="tsd-parameters">
    786. 

  786. 								<li>
    787. 

  787. 									<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>
    788. 

  788. 									<div class="tsd-comment tsd-typography">
    789. 

  789. 										<p>视频 Profile</p>
    790. 

  790. 									</div>
    791. 

  791. 								</li>
    792. 

  792. 							</ul>
    793. 

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

  794. 						</li>
    795. 

  795. 					</ul>
    796. 

  796. 				</section>
    797. 

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

  798. 					<a name="stop" class="tsd-anchor"></a>
    799. 

  799. 					<h3>stop</h3>
    800. 

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

  801. 						<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>
    802. 

  802. 					</ul>
    803. 

  803. 					<ul class="tsd-descriptions">
    804. 

  804. 						<li class="tsd-description">
    805. 

  805. 							<aside class="tsd-sources">
    806. 

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

  807. 							</aside>
    808. 

  808. 							<div class="tsd-comment tsd-typography">
    809. 

  809. 								<div class="lead">
    810. 

  810. 									<p>停止播放当前流</p>
    811. 

  811. 								</div>
    812. 

  812. 								<dl class="tsd-comment-tags">
    813. 

  813. 									<dt>example</dt>
    814. 

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

  815. 									</dd>
    816. 

  816. 								</dl>
    817. 

  817. 							</div>
    818. 

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

  819. 						</li>
    820. 

  820. 					</ul>
    821. 

  821. 				</section>
    822. 

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

  823. 					<a name="switchdevice" class="tsd-anchor"></a>
    824. 

  824. 					<h3>switch<wbr>Device</h3>
    825. 

  825. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    826. 

  826. 						<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>
    827. 

  827. 					</ul>
    828. 

  828. 					<ul class="tsd-descriptions">
    829. 

  829. 						<li class="tsd-description">
    830. 

  830. 							<aside class="tsd-sources">
    831. 

  831. 							</aside>
    832. 

  832. 							<div class="tsd-comment tsd-typography">
    833. 

  833. 								<div class="lead">
    834. 

  834. 									<p>切换音视频设备</p>
    835. 

  835. 								</div>
    836. 

  836. 								<dl class="tsd-comment-tags">
    837. 

  837. 									<dt>example</dt>
    838. 

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

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

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

  841.   })
    842. 

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

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

  844.   });</code></pre>
    845. 

  845. 									</dd>
    846. 

  846. 									<dt>reject</dt>
    847. 

  847. 									<dd><p><a href="rtcerror.html">RtcError</a></p>
    848. 

  848. 									</dd>
    849. 

  849. 								</dl>
    850. 

  850. 							</div>
    851. 

  851. 							<h4 class="tsd-parameters-title">Parameters</h4>
    852. 

  852. 							<ul class="tsd-parameters">
    853. 

  853. 								<li>
    854. 

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

  855. 									<div class="tsd-comment tsd-typography">
    856. 

  856. 										<p>设备类型</p>
    857. 

  857. 									</div>
    858. 

  858. 								</li>
    859. 

  859. 								<li>
    860. 

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

  861. 									<div class="tsd-comment tsd-typography">
    862. 

  862. 										<p>设备 ID</p>
    863. 

  863. 									</div>
    864. 

  864. 								</li>
    865. 

  865. 							</ul>
    866. 

  866. 							<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>
    867. 

  867. 						</li>
    868. 

  868. 					</ul>
    869. 

  869. 				</section>
    870. 

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

  871. 					<a name="switchimage" class="tsd-anchor"></a>
    872. 

  872. 					<h3>switch<wbr>Image</h3>
    873. 

  873. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
    874. 

  874. 						<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>
    875. 

  875. 					</ul>
    876. 

  876. 					<ul class="tsd-descriptions">
    877. 

  877. 						<li class="tsd-description">
    878. 

  878. 							<aside class="tsd-sources">
    879. 

  879. 							</aside>
    880. 

  880. 							<div class="tsd-comment tsd-typography">
    881. 

  881. 								<div class="lead">
    882. 

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

  883. 								</div>
    884. 

  884. 								<dl class="tsd-comment-tags">
    885. 

  885. 									<dt>example</dt>
    886. 

  886. 									<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>;
    887. 

  887. stream.switchImage(imgAddr)
    888. 

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

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

  890.   })
    891. 

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

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

  893.   });</code></pre>
    894. 

  894. 									</dd>
    895. 

  895. 									<dt>reject</dt>
    896. 

  896. 									<dd><p><a href="rtcerror.html">RtcError</a></p>
    897. 

  897. 									</dd>
    898. 

  898. 								</dl>
    899. 

  899. 							</div>
    900. 

  900. 							<h4 class="tsd-parameters-title">Parameters</h4>
    901. 

  901. 							<ul class="tsd-parameters">
    902. 

  902. 								<li>
    903. 

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

  904. 									<div class="tsd-comment tsd-typography">
    905. 

  905. 										<p>图片地址或图片文件</p>
    906. 

  906. 									</div>
    907. 

  907. 								</li>
    908. 

  908. 							</ul>
    909. 

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

  910. 						</li>
    911. 

  911. 					</ul>
    912. 

  912. 				</section>
    913. 

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

  914. 					<a name="unmuteaudio" class="tsd-anchor"></a>
    915. 

  915. 					<h3>unmute<wbr>Audio</h3>
    916. 

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

  917. 						<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>
    918. 

  918. 					</ul>
    919. 

  919. 					<ul class="tsd-descriptions">
    920. 

  920. 						<li class="tsd-description">
    921. 

  921. 							<aside class="tsd-sources">
    922. 

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

  923. 							</aside>
    924. 

  924. 							<div class="tsd-comment tsd-typography">
    925. 

  925. 								<div class="lead">
    926. 

  926. 									<p>unmute 当前流的音频</p>
    927. 

  927. 									<ul>
    928. 

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

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

  930. 									</ul>
    931. 

  931. 								</div>
    932. 

  932. 								<dl class="tsd-comment-tags">
    933. 

  933. 									<dt>example</dt>
    934. 

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

  935. <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>
    936. 

  936. 									</dd>
    937. 

  937. 								</dl>
    938. 

  938. 							</div>
    939. 

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

  940. 							<p>操作是否成功</p>
    941. 

  941. 						</li>
    942. 

  942. 					</ul>
    943. 

  943. 				</section>
    944. 

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

  945. 					<a name="unmutevideo" class="tsd-anchor"></a>
    946. 

  946. 					<h3>unmute<wbr>Video</h3>
    947. 

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

  948. 						<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>
    949. 

  949. 					</ul>
    950. 

  950. 					<ul class="tsd-descriptions">
    951. 

  951. 						<li class="tsd-description">
    952. 

  952. 							<aside class="tsd-sources">
    953. 

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

  954. 							</aside>
    955. 

  955. 							<div class="tsd-comment tsd-typography">
    956. 

  956. 								<div class="lead">
    957. 

  957. 									<p>unmute 当前流的视频</p>
    958. 

  958. 									<ul>
    959. 

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

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

  961. 									</ul>
    962. 

  962. 								</div>
    963. 

  963. 								<dl class="tsd-comment-tags">
    964. 

  964. 									<dt>example</dt>
    965. 

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

  966. <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>
    967. 

  967. 									</dd>
    968. 

  968. 								</dl>
    969. 

  969. 							</div>
    970. 

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

  971. 							<p>操作是否成功</p>
    972. 

  972. 						</li>
    973. 

  973. 					</ul>
    974. 

  974. 				</section>
    975. 

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

  976. 					<a name="use" class="tsd-anchor"></a>
    977. 

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

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

  979. 						<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>
    980. 

  980. 					</ul>
    981. 

  981. 					<ul class="tsd-descriptions">
    982. 

  982. 						<li class="tsd-description">
    983. 

  983. 							<aside class="tsd-sources">
    984. 

  984. 							</aside>
    985. 

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

  986. 								<div class="lead">
    987. 

  987. 									<p>加载流插件，使用插件功能</p>
    988. 

  988. 								</div>
    989. 

  989. 							</div>
    990. 

  990. 							<h4 class="tsd-parameters-title">Parameters</h4>
    991. 

  991. 							<ul class="tsd-parameters">
    992. 

  992. 								<li>
    993. 

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

  994. 									<div class="tsd-comment tsd-typography">
    995. 

  995. 										<p>插件</p>
    996. 

  996. 									</div>
    997. 

  997. 								</li>
    998. 

  998. 								<li>
    999. 

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

  1000. 									<div class="tsd-comment tsd-typography">
    1001. 

  1001. 										<p>插件初始化参数</p>
    1002. 

  1002. 									</div>
    1003. 

  1003. 								</li>
    1004. 

  1004. 							</ul>
    1005. 

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

  1006. 						</li>
    1007. 

  1007. 					</ul>
    1008. 

  1008. 				</section>
    1009. 

  1009. 			</section>
    1010. 

  1010. 		</div>
    1011. 

  1011. 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
    1012. 

  1012. 			<nav class="tsd-navigation primary">
    1013. 

  1013. 				<ul>
    1014. 

  1014. 					<li class="globals  ">
    1015. 

  1015. 						<a href="../index.html"><em>Globals</em></a>
    1016. 

  1016. 					</li>
    1017. 

  1017. 				</ul>
    1018. 

  1018. 			</nav>
    1019. 

  1019. 			<nav class="tsd-navigation secondary menu-sticky">
    1020. 

  1020. 				<ul class="before-current">
    1021. 

  1021. 				</ul>
    1022. 

  1022. 				<ul class="current">
    1023. 

  1023. 					<li class="current tsd-kind-class tsd-is-external">
    1024. 

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

  1025. 						<ul>
    1026. 

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

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

  1028. 							</li>
    1029. 

  1029. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1030. 

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

  1031. 							</li>
    1032. 

  1032. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1033. 

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

  1034. 							</li>
    1035. 

  1035. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1036. 

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

  1037. 							</li>
    1038. 

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

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

  1040. 							</li>
    1041. 

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

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

  1043. 							</li>
    1044. 

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

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

  1046. 							</li>
    1047. 

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

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

  1049. 							</li>
    1050. 

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

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

  1052. 							</li>
    1053. 

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

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

  1055. 							</li>
    1056. 

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

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

  1058. 							</li>
    1059. 

  1059. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
    1060. 

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

  1061. 							</li>
    1062. 

  1062. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1063. 

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

  1064. 							</li>
    1065. 

  1065. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1066. 

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

  1067. 							</li>
    1068. 

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

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

  1070. 							</li>
    1071. 

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

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

  1073. 							</li>
    1074. 

  1074. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
    1075. 

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

  1076. 							</li>
    1077. 

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

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

  1079. 							</li>
    1080. 

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

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

  1082. 							</li>
    1083. 

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

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

  1085. 							</li>
    1086. 

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

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

  1088. 							</li>
    1089. 

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

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

  1091. 							</li>
    1092. 

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

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

  1094. 							</li>
    1095. 

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

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

  1097. 							</li>
    1098. 

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

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

  1100. 							</li>
    1101. 

  1101. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1102. 

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

  1103. 							</li>
    1104. 

  1104. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
    1105. 

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

  1106. 							</li>
    1107. 

  1107. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
    1108. 

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

  1109. 							</li>
    1110. 

  1110. 						</ul>
    1111. 

  1111. 					</li>
    1112. 

  1112. 				</ul>
    1113. 

  1113. 				<ul class="after-current">
    1114. 

  1114. 				</ul>
    1115. 

  1115. 			</nav>
    1116. 

  1116. 		</div>
    1117. 

  1117. 	</div>
    1118. 

  1118. </div>
    1119. 

  1119. <footer class="with-border-bottom">
    1120. 

  1120. 	<div class="container">
    1121. 

  1121. 		<h2>Legend</h2>
    1122. 

  1122. 		<div class="tsd-legend-group">
    1123. 

  1123. 		</div>
    1124. 

  1124. 	</div>
    1125. 

  1125. </footer>
    1126. 

  1126. <div class="container tsd-generator">
    1127. 

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

  1128. </div>
    1129. 

  1129. <div class="overlay"></div>
    1130. 

  1130. <script src="../assets/js/main.js"></script>
    1131. 

  1131. </body>
    1132. 

  1132. </html>
    1133.