首页 发现 帮助
登录
githab
/
urtc-sdk-web
2
0
派生 0
文件 工单管理 0 合并请求 0 Wiki
目录树: 4c76b99fb7
分支列表 标签列表
urtc-sdk-web
/
docs
/
classes
/
localstream.html

localstream.html 89 KB
文件历史 原始文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269 
  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. 	<script async src="../assets/js/search.js" id="search-script"></script>
    11. 

  11. </head>
    12. 

  12. <body>
    13. 

  13. <header>
    14. 

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

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

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

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

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

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

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

  21. 					</div>
    22. 

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

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

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

  25. 					</ul>
    26. 

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

  27. 				</div>
    28. 

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

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

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

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

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

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

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

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

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

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

  38. 								</ul>
    39. 

  39. 							</div>
    40. 

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

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

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

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

  44. 						</div>
    45. 

  45. 					</div>
    46. 

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

  47. 				</div>
    48. 

  48. 			</div>
    49. 

  49. 		</div>
    50. 

  50. 	</div>
    51. 

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

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

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

  54. 				<li>
    55. 

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

  56. 				</li>
    57. 

  57. 				<li>
    58. 

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

  59. 				</li>
    60. 

  60. 			</ul>
    61. 

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

  62. 		</div>
    63. 

  63. 	</div>
    64. 

  64. </header>
    65. 

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

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

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

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

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

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

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

  72. 					</div>
    73. 

  73. 				</div>
    74. 

  74. 			</section>
    75. 

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

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

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

  78. 					<li>
    79. 

  79. 						<a href="stream.html" class="tsd-signature-type" data-tsd-kind="Class">Stream</a>
    80. 

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

  81. 							<li>
    82. 

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

  83. 							</li>
    84. 

  84. 						</ul>
    85. 

  85. 					</li>
    86. 

  86. 				</ul>
    87. 

  87. 			</section>
    88. 

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

  89. 				<h2>Index</h2>
    90. 

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

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

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

  93. 							<h3>Properties</h3>
    94. 

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

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

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

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

  98. 								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#userid" class="tsd-kind-icon">user<wbr>Id</a></li>
    99. 

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

  100. 							</ul>
    101. 

  101. 						</section>
    102. 

  102. 						<section class="tsd-index-section ">
    103. 

  103. 							<h3>Methods</h3>
    104. 

  104. 							<ul class="tsd-index-list">
    105. 

  105. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#addtrack" class="tsd-kind-icon">add<wbr>Track</a></li>
    106. 

  106. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#destroy" class="tsd-kind-icon">destroy</a></li>
    107. 

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

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

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

  110. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="localstream.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a></li>
    111. 

  111. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="localstream.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a></li>
    112. 

  112. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#init" class="tsd-kind-icon">init</a></li>
    113. 

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

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

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

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

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

  118. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#removetrack" class="tsd-kind-icon">remove<wbr>Track</a></li>
    119. 

  119. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#replacetrack" class="tsd-kind-icon">replace<wbr>Track</a></li>
    120. 

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

  121. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#setaudiolevel" class="tsd-kind-icon">set<wbr>Audio<wbr>Level</a></li>
    122. 

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

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

  124. 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#snapshot" class="tsd-kind-icon">snapshot</a></li>
    125. 

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

  126. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#switchdevice" class="tsd-kind-icon">switch<wbr>Device</a></li>
    127. 

  127. 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#switchimage" class="tsd-kind-icon">switch<wbr>Image</a></li>
    128. 

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

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

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

  131. 							</ul>
    132. 

  132. 						</section>
    133. 

  133. 					</div>
    134. 

  134. 				</section>
    135. 

  135. 			</section>
    136. 

  136. 			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
    137. 

  137. 				<h2>Properties</h2>
    138. 

  138. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
    139. 

  139. 					<a name="audiomuted" class="tsd-anchor"></a>
    140. 

  140. 					<h3>audio<wbr>Muted</h3>
    141. 

  141. 					<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>
    142. 

  142. 					<aside class="tsd-sources">
    143. 

  143. 						<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#audiomuted">audioMuted</a></p>
    144. 

  144. 					</aside>
    145. 

  145. 					<div class="tsd-comment tsd-typography">
    146. 

  146. 						<div class="lead">
    147. 

  147. 							<p>当前流是否 mute 了音频</p>
    148. 

  148. 						</div>
    149. 

  149. 					</div>
    150. 

  150. 				</section>
    151. 

  151. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
    152. 

  152. 					<a name="id" class="tsd-anchor"></a>
    153. 

  153. 					<h3>id</h3>
    154. 

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

  155. 					<aside class="tsd-sources">
    156. 

  156. 						<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#id">id</a></p>
    157. 

  157. 					</aside>
    158. 

  158. 					<div class="tsd-comment tsd-typography">
    159. 

  159. 						<div class="lead">
    160. 

  160. 							<p>当前流ID</p>
    161. 

  161. 						</div>
    162. 

  162. 					</div>
    163. 

  163. 				</section>
    164. 

  164. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
    165. 

  165. 					<a name="mediastream" class="tsd-anchor"></a>
    166. 

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

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

  168. 					<aside class="tsd-sources">
    169. 

  169. 						<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#mediastream">mediaStream</a></p>
    170. 

  170. 					</aside>
    171. 

  171. 					<div class="tsd-comment tsd-typography">
    172. 

  172. 						<div class="lead">
    173. 

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

  174. 						</div>
    175. 

  175. 					</div>
    176. 

  176. 				</section>
    177. 

  177. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
    178. 

  178. 					<a name="userid" class="tsd-anchor"></a>
    179. 

  179. 					<h3>user<wbr>Id</h3>
    180. 

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

  181. 					<aside class="tsd-sources">
    182. 

  182. 						<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#userid">userId</a></p>
    183. 

  183. 					</aside>
    184. 

  184. 					<div class="tsd-comment tsd-typography">
    185. 

  185. 						<div class="lead">
    186. 

  186. 							<p>当前流所属用户的ID
    187. 

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

  188. 						</div>
    189. 

  189. 					</div>
    190. 

  190. 				</section>
    191. 

  191. 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
    192. 

  192. 					<a name="videomuted" class="tsd-anchor"></a>
    193. 

  193. 					<h3>video<wbr>Muted</h3>
    194. 

  194. 					<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>
    195. 

  195. 					<aside class="tsd-sources">
    196. 

  196. 						<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#videomuted">videoMuted</a></p>
    197. 

  197. 					</aside>
    198. 

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

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

  200. 							<p>当前流是否 mute 了视频</p>
    201. 

  201. 						</div>
    202. 

  202. 					</div>
    203. 

  203. 				</section>
    204. 

  204. 			</section>
    205. 

  205. 			<section class="tsd-panel-group tsd-member-group ">
    206. 

  206. 				<h2>Methods</h2>
    207. 

  207. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    208. 

  208. 					<a name="addtrack" class="tsd-anchor"></a>
    209. 

  209. 					<h3>add<wbr>Track</h3>
    210. 

  210. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    211. 

  211. 						<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>
    212. 

  212. 					</ul>
    213. 

  213. 					<ul class="tsd-descriptions">
    214. 

  214. 						<li class="tsd-description">
    215. 

  215. 							<aside class="tsd-sources">
    216. 

  216. 							</aside>
    217. 

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

  218. 								<div class="lead">
    219. 

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

  220. 									<blockquote>
    221. 

  221. 										<p>注：</p>
    222. 

  222. 										<ol>
    223. 

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

  224. 										</ol>
    225. 

  225. 									</blockquote>
    226. 

  226. 								</div>
    227. 

  227. 								<dl class="tsd-comment-tags">
    228. 

  228. 									<dt>example</dt>
    229. 

  229. 									<dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">addTrack</span><span style="color: #000000">(</span><span style="color: #001080">track</span><span style="color: #000000">);</span>
    230. 

  230. </code></pre>
    231. 

  231. 									</dd>
    232. 

  232. 								</dl>
    233. 

  233. 							</div>
    234. 

  234. 							<h4 class="tsd-parameters-title">Parameters</h4>
    235. 

  235. 							<ul class="tsd-parameters">
    236. 

  236. 								<li>
    237. 

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

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

  239. 										<p>媒体轨道</p>
    240. 

  240. 									</div>
    241. 

  241. 								</li>
    242. 

  242. 							</ul>
    243. 

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

  244. 						</li>
    245. 

  245. 					</ul>
    246. 

  246. 				</section>
    247. 

  247. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    248. 

  248. 					<a name="destroy" class="tsd-anchor"></a>
    249. 

  249. 					<h3>destroy</h3>
    250. 

  250. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    251. 

  251. 						<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>
    252. 

  252. 					</ul>
    253. 

  253. 					<ul class="tsd-descriptions">
    254. 

  254. 						<li class="tsd-description">
    255. 

  255. 							<aside class="tsd-sources">
    256. 

  256. 							</aside>
    257. 

  257. 							<div class="tsd-comment tsd-typography">
    258. 

  258. 								<div class="lead">
    259. 

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

  260. 								</div>
    261. 

  261. 								<dl class="tsd-comment-tags">
    262. 

  262. 									<dt>example</dt>
    263. 

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

  264. </code></pre>
    265. 

  265. 									</dd>
    266. 

  266. 								</dl>
    267. 

  267. 							</div>
    268. 

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

  269. 						</li>
    270. 

  270. 					</ul>
    271. 

  271. 				</section>
    272. 

  272. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    273. 

  273. 					<a name="getaudiolevel" class="tsd-anchor"></a>
    274. 

  274. 					<h3>get<wbr>Audio<wbr>Level</h3>
    275. 

  275. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    276. 

  276. 						<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>
    277. 

  277. 					</ul>
    278. 

  278. 					<ul class="tsd-descriptions">
    279. 

  279. 						<li class="tsd-description">
    280. 

  280. 							<aside class="tsd-sources">
    281. 

  281. 								<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#getaudiolevel">getAudioLevel</a></p>
    282. 

  282. 							</aside>
    283. 

  283. 							<div class="tsd-comment tsd-typography">
    284. 

  284. 								<div class="lead">
    285. 

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

  286. 								</div>
    287. 

  287. 								<dl class="tsd-comment-tags">
    288. 

  288. 									<dt>example</dt>
    289. 

  289. 									<dd><pre><code class="language-js"><span style="color: #795E26">setInterval</span><span style="color: #000000">(() </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    290. 

  290. <span style="color: #000000">  </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">level</span><span style="color: #000000"> = </span><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">getAudioLevel</span><span style="color: #000000">();</span>
    291. 

  291. <span style="color: #000000">  </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">level</span><span style="color: #000000"> &gt; </span><span style="color: #098658">0</span><span style="color: #000000">) {</span>
    292. 

  292. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`user </span><span style="color: #0000FF">${</span><span style="color: #001080">stream</span><span style="color: #000000FF">.</span><span style="color: #001080">userId</span><span style="color: #0000FF">}</span><span style="color: #A31515"> is speaking`</span><span style="color: #000000">);</span>
    293. 

  293. <span style="color: #000000">  }</span>
    294. 

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

  295. </code></pre>
    296. 

  296. 									</dd>
    297. 

  297. 								</dl>
    298. 

  298. 							</div>
    299. 

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

  300. 						</li>
    301. 

  301. 					</ul>
    302. 

  302. 				</section>
    303. 

  303. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    304. 

  304. 					<a name="getmediatype" class="tsd-anchor"></a>
    305. 

  305. 					<h3>get<wbr>Media<wbr>Type</h3>
    306. 

  306. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    307. 

  307. 						<li class="tsd-signature tsd-kind-icon">get<wbr>Media<wbr>Type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#mediatype" class="tsd-signature-type" data-tsd-kind="Type alias">MediaType</a></li>
    308. 

  308. 					</ul>
    309. 

  309. 					<ul class="tsd-descriptions">
    310. 

  310. 						<li class="tsd-description">
    311. 

  311. 							<aside class="tsd-sources">
    312. 

  312. 								<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#getmediatype">getMediaType</a></p>
    313. 

  313. 							</aside>
    314. 

  314. 							<div class="tsd-comment tsd-typography">
    315. 

  315. 								<div class="lead">
    316. 

  316. 									<p>获取流的媒体类型</p>
    317. 

  317. 								</div>
    318. 

  318. 								<dl class="tsd-comment-tags">
    319. 

  319. 									<dt>example</dt>
    320. 

  320. 									<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">type</span><span style="color: #000000"> = </span><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">getMediaType</span><span style="color: #000000">();</span>
    321. 

  321. </code></pre>
    322. 

  322. 									</dd>
    323. 

  323. 								</dl>
    324. 

  324. 							</div>
    325. 

  325. 							<h4 class="tsd-returns-title">Returns <a href="../index.html#mediatype" class="tsd-signature-type" data-tsd-kind="Type alias">MediaType</a></h4>
    326. 

  326. 						</li>
    327. 

  327. 					</ul>
    328. 

  328. 				</section>
    329. 

  329. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    330. 

  330. 					<a name="getstats" class="tsd-anchor"></a>
    331. 

  331. 					<h3>get<wbr>Stats</h3>
    332. 

  332. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    333. 

  333. 						<li class="tsd-signature tsd-kind-icon">get<wbr>Stats<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/streamstats.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamStats</a><span class="tsd-signature-symbol">&gt;</span></li>
    334. 

  334. 					</ul>
    335. 

  335. 					<ul class="tsd-descriptions">
    336. 

  336. 						<li class="tsd-description">
    337. 

  337. 							<aside class="tsd-sources">
    338. 

  338. 								<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#getstats">getStats</a></p>
    339. 

  339. 							</aside>
    340. 

  340. 							<div class="tsd-comment tsd-typography">
    341. 

  341. 								<div class="lead">
    342. 

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

  343. 								</div>
    344. 

  344. 								<dl class="tsd-comment-tags">
    345. 

  345. 									<dt>example</dt>
    346. 

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

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

  348. <span style="color: #000000">  .</span><span style="color: #795E26">then</span><span style="color: #000000">((</span><span style="color: #001080">stats</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    349. 

  349. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;当前流的统计数据为: &#039;</span><span style="color: #000000">, </span><span style="color: #001080">stats</span><span style="color: #000000">);</span>
    350. 

  350. <span style="color: #000000">  });</span>
    351. 

  351. </code></pre>
    352. 

  352. 									</dd>
    353. 

  353. 								</dl>
    354. 

  354. 							</div>
    355. 

  355. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/streamstats.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamStats</a><span class="tsd-signature-symbol">&gt;</span></h4>
    356. 

  356. 						</li>
    357. 

  357. 					</ul>
    358. 

  358. 				</section>
    359. 

  359. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
    360. 

  360. 					<a name="hasaudio" class="tsd-anchor"></a>
    361. 

  361. 					<h3>has<wbr>Audio</h3>
    362. 

  362. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
    363. 

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

  364. 					</ul>
    365. 

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

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

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

  368. 								<p>Overrides <a href="stream.html">Stream</a>.<a href="stream.html#hasaudio">hasAudio</a></p>
    369. 

  369. 							</aside>
    370. 

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

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

  372. 									<p>判断当前流是否有音频</p>
    373. 

  373. 								</div>
    374. 

  374. 								<dl class="tsd-comment-tags">
    375. 

  375. 									<dt>example</dt>
    376. 

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

  377. </code></pre>
    378. 

  378. 									</dd>
    379. 

  379. 								</dl>
    380. 

  380. 							</div>
    381. 

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

  382. 						</li>
    383. 

  383. 					</ul>
    384. 

  384. 				</section>
    385. 

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

  386. 					<a name="hasvideo" class="tsd-anchor"></a>
    387. 

  387. 					<h3>has<wbr>Video</h3>
    388. 

  388. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
    389. 

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

  390. 					</ul>
    391. 

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

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

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

  394. 								<p>Overrides <a href="stream.html">Stream</a>.<a href="stream.html#hasvideo">hasVideo</a></p>
    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 style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">result</span><span style="color: #000000"> = </span><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">hasVideo</span><span style="color: #000000">();</span>
    403. 

  403. </code></pre>
    404. 

  404. 									</dd>
    405. 

  405. 								</dl>
    406. 

  406. 							</div>
    407. 

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

  408. 						</li>
    409. 

  409. 					</ul>
    410. 

  410. 				</section>
    411. 

  411. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    412. 

  412. 					<a name="init" class="tsd-anchor"></a>
    413. 

  413. 					<h3>init</h3>
    414. 

  414. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    415. 

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

  416. 					</ul>
    417. 

  417. 					<ul class="tsd-descriptions">
    418. 

  418. 						<li class="tsd-description">
    419. 

  419. 							<aside class="tsd-sources">
    420. 

  420. 							</aside>
    421. 

  421. 							<div class="tsd-comment tsd-typography">
    422. 

  422. 								<div class="lead">
    423. 

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

  424. 								</div>
    425. 

  425. 								<dl class="tsd-comment-tags">
    426. 

  426. 									<dt>example</dt>
    427. 

  427. 									<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">stream</span><span style="color: #000000"> = </span><span style="color: #795E26">createStream</span><span style="color: #000000">({</span><span style="color: #001080">audio:</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span><span style="color: #000000">, </span><span style="color: #001080">video:</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span><span style="color: #000000">, </span><span style="color: #001080">screen:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span><span style="color: #000000">});</span>
    428. 

  428. <span style="color: #001080">stream</span>
    429. 

  429. <span style="color: #000000">  .</span><span style="color: #795E26">init</span><span style="color: #000000">()</span>
    430. 

  430. <span style="color: #000000">  .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    431. 

  431. <span style="color: #000000">    </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">publish</span><span style="color: #000000">(</span><span style="color: #001080">stream</span><span style="color: #000000">); </span><span style="color: #008000">// 发布本地流</span>
    432. 

  432. <span style="color: #000000">  })</span>
    433. 

  433. <span style="color: #000000">  .</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    434. 

  434. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`初始化本地流失败 </span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    435. 

  435. <span style="color: #000000">  })</span>
    436. 

  436. </code></pre>
    437. 

  437. 									</dd>
    438. 

  438. 								</dl>
    439. 

  439. 							</div>
    440. 

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

  441. 						</li>
    442. 

  442. 					</ul>
    443. 

  443. 				</section>
    444. 

  444. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    445. 

  445. 					<a name="muteaudio" class="tsd-anchor"></a>
    446. 

  446. 					<h3>mute<wbr>Audio</h3>
    447. 

  447. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    448. 

  448. 						<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>
    449. 

  449. 					</ul>
    450. 

  450. 					<ul class="tsd-descriptions">
    451. 

  451. 						<li class="tsd-description">
    452. 

  452. 							<aside class="tsd-sources">
    453. 

  453. 								<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#muteaudio">muteAudio</a></p>
    454. 

  454. 							</aside>
    455. 

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

  456. 								<div class="lead">
    457. 

  457. 									<p>mute 当前流的音频</p>
    458. 

  458. 									<ul>
    459. 

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

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

  461. 									</ul>
    462. 

  462. 								</div>
    463. 

  463. 								<dl class="tsd-comment-tags">
    464. 

  464. 									<dt>example</dt>
    465. 

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

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

  467. </code></pre>
    468. 

  468. 									</dd>
    469. 

  469. 								</dl>
    470. 

  470. 							</div>
    471. 

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

  472. 							<p>操作是否成功</p>
    473. 

  473. 						</li>
    474. 

  474. 					</ul>
    475. 

  475. 				</section>
    476. 

  476. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    477. 

  477. 					<a name="mutevideo" class="tsd-anchor"></a>
    478. 

  478. 					<h3>mute<wbr>Video</h3>
    479. 

  479. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    480. 

  480. 						<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>
    481. 

  481. 					</ul>
    482. 

  482. 					<ul class="tsd-descriptions">
    483. 

  483. 						<li class="tsd-description">
    484. 

  484. 							<aside class="tsd-sources">
    485. 

  485. 								<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#mutevideo">muteVideo</a></p>
    486. 

  486. 							</aside>
    487. 

  487. 							<div class="tsd-comment tsd-typography">
    488. 

  488. 								<div class="lead">
    489. 

  489. 									<p>mute 当前流的视频</p>
    490. 

  490. 									<ul>
    491. 

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

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

  493. 									</ul>
    494. 

  494. 								</div>
    495. 

  495. 								<dl class="tsd-comment-tags">
    496. 

  496. 									<dt>example</dt>
    497. 

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

  498. <span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`stream&#039;s video is muted </span><span style="color: #0000FF">${</span><span style="color: #001080">stream</span><span style="color: #000000FF">.</span><span style="color: #001080">videoMuted</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    499. 

  499. </code></pre>
    500. 

  500. 									</dd>
    501. 

  501. 								</dl>
    502. 

  502. 							</div>
    503. 

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

  504. 							<p>操作是否成功</p>
    505. 

  505. 						</li>
    506. 

  506. 					</ul>
    507. 

  507. 				</section>
    508. 

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

  509. 					<a name="off" class="tsd-anchor"></a>
    510. 

  510. 					<h3>off</h3>
    511. 

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

  512. 						<li class="tsd-signature tsd-kind-icon">off&lt;T&gt;<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Listener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span></li>
    513. 

  513. 					</ul>
    514. 

  514. 					<ul class="tsd-descriptions">
    515. 

  515. 						<li class="tsd-description">
    516. 

  516. 							<aside class="tsd-sources">
    517. 

  517. 								<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#off">off</a></p>
    518. 

  518. 							</aside>
    519. 

  519. 							<div class="tsd-comment tsd-typography">
    520. 

  520. 								<div class="lead">
    521. 

  521. 									<p>取消监听流对象事件</p>
    522. 

  522. 								</div>
    523. 

  523. 							</div>
    524. 

  524. 							<h4 class="tsd-type-parameters-title">Type parameters</h4>
    525. 

  525. 							<ul class="tsd-type-parameters">
    526. 

  526. 								<li>
    527. 

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

  528. 								</li>
    529. 

  529. 							</ul>
    530. 

  530. 							<h4 class="tsd-parameters-title">Parameters</h4>
    531. 

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

  532. 								<li>
    533. 

  533. 									<h5>type: <span class="tsd-signature-type">T</span></h5>
    534. 

  534. 									<div class="tsd-comment tsd-typography">
    535. 

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

  536. 									</div>
    537. 

  537. 								</li>
    538. 

  538. 								<li>
    539. 

  539. 									<h5>listener: <span class="tsd-signature-type">Listener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
    540. 

  540. 									<div class="tsd-comment tsd-typography">
    541. 

  541. 										<p>流对象事件监听函数</p>
    542. 

  542. 									</div>
    543. 

  543. 								</li>
    544. 

  544. 							</ul>
    545. 

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

  546. 						</li>
    547. 

  547. 					</ul>
    548. 

  548. 				</section>
    549. 

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

  550. 					<a name="on" class="tsd-anchor"></a>
    551. 

  551. 					<h3>on</h3>
    552. 

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

  553. 						<li class="tsd-signature tsd-kind-icon">on&lt;T&gt;<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Listener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span></li>
    554. 

  554. 					</ul>
    555. 

  555. 					<ul class="tsd-descriptions">
    556. 

  556. 						<li class="tsd-description">
    557. 

  557. 							<aside class="tsd-sources">
    558. 

  558. 								<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#on">on</a></p>
    559. 

  559. 							</aside>
    560. 

  560. 							<div class="tsd-comment tsd-typography">
    561. 

  561. 								<div class="lead">
    562. 

  562. 									<p>监听流对象事件</p>
    563. 

  563. 								</div>
    564. 

  564. 							</div>
    565. 

  565. 							<h4 class="tsd-type-parameters-title">Type parameters</h4>
    566. 

  566. 							<ul class="tsd-type-parameters">
    567. 

  567. 								<li>
    568. 

  568. 									<h4>T<span class="tsd-signature-symbol">: </span><a href="../index.html#rtceventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcEventType</a></h4>
    569. 

  569. 								</li>
    570. 

  570. 							</ul>
    571. 

  571. 							<h4 class="tsd-parameters-title">Parameters</h4>
    572. 

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

  573. 								<li>
    574. 

  574. 									<h5>type: <span class="tsd-signature-type">T</span></h5>
    575. 

  575. 									<div class="tsd-comment tsd-typography">
    576. 

  576. 										<p>流事件类型</p>
    577. 

  577. 									</div>
    578. 

  578. 								</li>
    579. 

  579. 								<li>
    580. 

  580. 									<h5>listener: <span class="tsd-signature-type">Listener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
    581. 

  581. 									<div class="tsd-comment tsd-typography">
    582. 

  582. 										<p>流事件监听函数</p>
    583. 

  583. 									</div>
    584. 

  584. 								</li>
    585. 

  585. 							</ul>
    586. 

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

  587. 						</li>
    588. 

  588. 					</ul>
    589. 

  589. 				</section>
    590. 

  590. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    591. 

  591. 					<a name="play" class="tsd-anchor"></a>
    592. 

  592. 					<h3>play</h3>
    593. 

  593. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    594. 

  594. 						<li class="tsd-signature tsd-kind-icon">play<span class="tsd-signature-symbol">(</span>container<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/playoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PlayOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
    595. 

  595. 					</ul>
    596. 

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

  597. 						<li class="tsd-description">
    598. 

  598. 							<aside class="tsd-sources">
    599. 

  599. 								<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#play">play</a></p>
    600. 

  600. 							</aside>
    601. 

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

  602. 								<div class="lead">
    603. 

  603. 									<p>播放当前流</p>
    604. 

  604. 								</div>
    605. 

  605. 								<dl class="tsd-comment-tags">
    606. 

  606. 									<dt>example</dt>
    607. 

  607. 									<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">container</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;xxx&#039;</span><span style="color: #000000">; </span><span style="color: #008000">// 比如 id 为 xxx 的 div 元素</span>
    608. 

  608. <span style="color: #001080">stream</span>
    609. 

  609. <span style="color: #000000">  .</span><span style="color: #795E26">play</span><span style="color: #000000">(</span><span style="color: #001080">container</span><span style="color: #000000">)</span>
    610. 

  610. <span style="color: #000000">  .</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    611. 

  611. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`播放失败: </span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">); </span><span style="color: #008000">// 一般由于浏览器对自动播放的限制导致播放失败</span>
    612. 

  612. <span style="color: #000000">  });</span>
    613. 

  613. </code></pre>
    614. 

  614. 									</dd>
    615. 

  615. 									<dt>reject</dt>
    616. 

  616. 									<dd><p><a href="rtcerror.html">RtcError</a></p>
    617. 

  617. 									</dd>
    618. 

  618. 								</dl>
    619. 

  619. 							</div>
    620. 

  620. 							<h4 class="tsd-parameters-title">Parameters</h4>
    621. 

  621. 							<ul class="tsd-parameters">
    622. 

  622. 								<li>
    623. 

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

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

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

  626. 									</div>
    627. 

  627. 								</li>
    628. 

  628. 								<li>
    629. 

  629. 									<h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="../interfaces/playoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PlayOptions</a></h5>
    630. 

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

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

  632. 									</div>
    633. 

  633. 								</li>
    634. 

  634. 							</ul>
    635. 

  635. 							<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>
    636. 

  636. 						</li>
    637. 

  637. 					</ul>
    638. 

  638. 				</section>
    639. 

  639. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    640. 

  640. 					<a name="removetrack" class="tsd-anchor"></a>
    641. 

  641. 					<h3>remove<wbr>Track</h3>
    642. 

  642. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    643. 

  643. 						<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>
    644. 

  644. 					</ul>
    645. 

  645. 					<ul class="tsd-descriptions">
    646. 

  646. 						<li class="tsd-description">
    647. 

  647. 							<aside class="tsd-sources">
    648. 

  648. 							</aside>
    649. 

  649. 							<div class="tsd-comment tsd-typography">
    650. 

  650. 								<div class="lead">
    651. 

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

  652. 								</div>
    653. 

  653. 								<dl class="tsd-comment-tags">
    654. 

  654. 									<dt>example</dt>
    655. 

  655. 									<dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">removeTrack</span><span style="color: #000000">(</span><span style="color: #001080">track</span><span style="color: #000000">);</span>
    656. 

  656. </code></pre>
    657. 

  657. 									</dd>
    658. 

  658. 								</dl>
    659. 

  659. 							</div>
    660. 

  660. 							<h4 class="tsd-parameters-title">Parameters</h4>
    661. 

  661. 							<ul class="tsd-parameters">
    662. 

  662. 								<li>
    663. 

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

  664. 									<div class="tsd-comment tsd-typography">
    665. 

  665. 										<p>媒体轨道</p>
    666. 

  666. 									</div>
    667. 

  667. 								</li>
    668. 

  668. 							</ul>
    669. 

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

  670. 						</li>
    671. 

  671. 					</ul>
    672. 

  672. 				</section>
    673. 

  673. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    674. 

  674. 					<a name="replacetrack" class="tsd-anchor"></a>
    675. 

  675. 					<h3>replace<wbr>Track</h3>
    676. 

  676. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    677. 

  677. 						<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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MediaStreamTrack</span></li>
    678. 

  678. 					</ul>
    679. 

  679. 					<ul class="tsd-descriptions">
    680. 

  680. 						<li class="tsd-description">
    681. 

  681. 							<aside class="tsd-sources">
    682. 

  682. 							</aside>
    683. 

  683. 							<div class="tsd-comment tsd-typography">
    684. 

  684. 								<div class="lead">
    685. 

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

  686. 									<blockquote>
    687. 

  687. 										<p>注：</p>
    688. 

  688. 										<ol>
    689. 

  689. 											<li>替换视频时，建议使用与原轨道相同的分辨率的视频轨道，若不相同，请在替换后及时设置流的 profile 来调整到合适的码率等</li>
    690. 

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

  691. 											<li>若是切换不同的摄像头或麦克风设备，建议使用 switchDevice 方法，若是切换静态图片为视频流，建立使用 switchImage 方法</li>
    692. 

  692. 										</ol>
    693. 

  693. 									</blockquote>
    694. 

  694. 								</div>
    695. 

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

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

  697. 									<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">oldTrack</span><span style="color: #000000"> = </span><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">replaceTrack</span><span style="color: #000000">(</span><span style="color: #001080">track</span><span style="color: #000000">);</span>
    698. 

  698. <span style="color: #001080">oldTrack</span><span style="color: #000000">.</span><span style="color: #795E26">stop</span><span style="color: #000000">();</span>
    699. 

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

  700. 									</dd>
    701. 

  701. 								</dl>
    702. 

  702. 							</div>
    703. 

  703. 							<h4 class="tsd-parameters-title">Parameters</h4>
    704. 

  704. 							<ul class="tsd-parameters">
    705. 

  705. 								<li>
    706. 

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

  707. 									<div class="tsd-comment tsd-typography">
    708. 

  708. 										<p>新媒体轨道</p>
    709. 

  709. 									</div>
    710. 

  710. 								</li>
    711. 

  711. 							</ul>
    712. 

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

  713. 						</li>
    714. 

  714. 					</ul>
    715. 

  715. 				</section>
    716. 

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

  717. 					<a name="resume" class="tsd-anchor"></a>
    718. 

  718. 					<h3>resume</h3>
    719. 

  719. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    720. 

  720. 						<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>
    721. 

  721. 					</ul>
    722. 

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

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

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

  725. 								<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#resume">resume</a></p>
    726. 

  726. 							</aside>
    727. 

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

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

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

  730. 								</div>
    731. 

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

  732. 									<dt>example</dt>
    733. 

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

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

  735. <span style="color: #000000">  .</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    736. 

  736. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`恢复播放失败：</span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    737. 

  737. <span style="color: #000000">  });</span>
    738. 

  738. </code></pre>
    739. 

  739. 									</dd>
    740. 

  740. 								</dl>
    741. 

  741. 							</div>
    742. 

  742. 							<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>
    743. 

  743. 						</li>
    744. 

  744. 					</ul>
    745. 

  745. 				</section>
    746. 

  746. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    747. 

  747. 					<a name="setaudiolevel" class="tsd-anchor"></a>
    748. 

  748. 					<h3>set<wbr>Audio<wbr>Level</h3>
    749. 

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

  750. 						<li class="tsd-signature tsd-kind-icon">set<wbr>Audio<wbr>Level<span class="tsd-signature-symbol">(</span>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
    751. 

  751. 					</ul>
    752. 

  752. 					<ul class="tsd-descriptions">
    753. 

  753. 						<li class="tsd-description">
    754. 

  754. 							<aside class="tsd-sources">
    755. 

  755. 							</aside>
    756. 

  756. 							<div class="tsd-comment tsd-typography">
    757. 

  757. 								<div class="lead">
    758. 

  758. 									<p>设置音频能量大小，默认 100</p>
    759. 

  759. 								</div>
    760. 

  760. 							</div>
    761. 

  761. 							<h4 class="tsd-parameters-title">Parameters</h4>
    762. 

  762. 							<ul class="tsd-parameters">
    763. 

  763. 								<li>
    764. 

  764. 									<h5>level: <span class="tsd-signature-type">number</span></h5>
    765. 

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

  766. 										<p>能量大小，取值范围 [0-300]</p>
    767. 

  767. 									</div>
    768. 

  768. 								</li>
    769. 

  769. 							</ul>
    770. 

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

  771. 						</li>
    772. 

  772. 					</ul>
    773. 

  773. 				</section>
    774. 

  774. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    775. 

  775. 					<a name="setscreenprofile" class="tsd-anchor"></a>
    776. 

  776. 					<h3>set<wbr>Screen<wbr>Profile</h3>
    777. 

  777. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    778. 

  778. 						<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><span class="tsd-signature-type">&quot;480p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CustomVideoProfile</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;480p_2&quot;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
    779. 

  779. 					</ul>
    780. 

  780. 					<ul class="tsd-descriptions">
    781. 

  781. 						<li class="tsd-description">
    782. 

  782. 							<aside class="tsd-sources">
    783. 

  783. 							</aside>
    784. 

  784. 							<div class="tsd-comment tsd-typography">
    785. 

  785. 								<div class="lead">
    786. 

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

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

  788. 								</div>
    789. 

  789. 								<dl class="tsd-comment-tags">
    790. 

  790. 									<dt>example</dt>
    791. 

  791. 									<dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">setScreenProfile</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;720p&#039;</span><span style="color: #000000">);</span>
    792. 

  792. <span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">init</span><span style="color: #000000">().</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    793. 

  793. <span style="color: #000000">  </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`初始化屏幕共享流失败 </span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    794. 

  794. <span style="color: #000000">});</span>
    795. 

  795. </code></pre>
    796. 

  796. 									</dd>
    797. 

  797. 								</dl>
    798. 

  798. 							</div>
    799. 

  799. 							<h4 class="tsd-parameters-title">Parameters</h4>
    800. 

  800. 							<ul class="tsd-parameters">
    801. 

  801. 								<li>
    802. 

  802. 									<h5>profile: <span class="tsd-signature-type">&quot;480p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CustomVideoProfile</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;480p_2&quot;</span></h5>
    803. 

  803. 									<div class="tsd-comment tsd-typography">
    804. 

  804. 										<p>视频 Profile</p>
    805. 

  805. 									</div>
    806. 

  806. 								</li>
    807. 

  807. 							</ul>
    808. 

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

  809. 						</li>
    810. 

  810. 					</ul>
    811. 

  811. 				</section>
    812. 

  812. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    813. 

  813. 					<a name="setvideoprofile" class="tsd-anchor"></a>
    814. 

  814. 					<h3>set<wbr>Video<wbr>Profile</h3>
    815. 

  815. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    816. 

  816. 						<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><span class="tsd-signature-type">&quot;180p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;180p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;240p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;360p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;360p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;480p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p_3&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p_3&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CustomVideoProfile</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>
    817. 

  817. 					</ul>
    818. 

  818. 					<ul class="tsd-descriptions">
    819. 

  819. 						<li class="tsd-description">
    820. 

  820. 							<aside class="tsd-sources">
    821. 

  821. 							</aside>
    822. 

  822. 							<div class="tsd-comment tsd-typography">
    823. 

  823. 								<div class="lead">
    824. 

  824. 									<p>设置当前流视频的 Profile，默认 &#39;360p_2&#39;</p>
    825. 

  825. 								</div>
    826. 

  826. 								<dl class="tsd-comment-tags">
    827. 

  827. 									<dt>example</dt>
    828. 

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

  829. <span style="color: #000000">  .</span><span style="color: #795E26">setVideoProfile</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;720p&#039;</span><span style="color: #000000">)</span>
    830. 

  830. <span style="color: #000000">  .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    831. 

  831. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;set video profile success&#039;</span><span style="color: #000000">);</span>
    832. 

  832. <span style="color: #000000">  })</span>
    833. 

  833. <span style="color: #000000">  .</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    834. 

  834. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;set video profile failed &#039;</span><span style="color: #000000">, </span><span style="color: #001080">err</span><span style="color: #000000">);</span>
    835. 

  835. <span style="color: #000000">  });</span>
    836. 

  836. </code></pre>
    837. 

  837. 										<p>或</p>
    838. 

  838. 										<pre><code class="language-js"><span style="color: #001080">stream</span>
    839. 

  839. <span style="color: #000000">  .</span><span style="color: #795E26">setVideoProfile</span><span style="color: #000000">({</span><span style="color: #001080">width:</span><span style="color: #000000"> </span><span style="color: #098658">640</span><span style="color: #000000">, </span><span style="color: #001080">height:</span><span style="color: #000000"> </span><span style="color: #098658">480</span><span style="color: #000000">, </span><span style="color: #001080">framerate:</span><span style="color: #000000"> </span><span style="color: #098658">15</span><span style="color: #000000">, </span><span style="color: #001080">bitrate:</span><span style="color: #000000"> </span><span style="color: #098658">500</span><span style="color: #000000">});</span>
    840. 

  840. <span style="color: #000000">  .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    841. 

  841. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;set video profile success&#039;</span><span style="color: #000000">);</span>
    842. 

  842. <span style="color: #000000">  })</span>
    843. 

  843. <span style="color: #000000">  .</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    844. 

  844. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;set video profile failed &#039;</span><span style="color: #000000">, </span><span style="color: #001080">err</span><span style="color: #000000">);</span>
    845. 

  845. <span style="color: #000000">  });</span>
    846. 

  846. </code></pre>
    847. 

  847. 									</dd>
    848. 

  848. 								</dl>
    849. 

  849. 							</div>
    850. 

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

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

  852. 								<li>
    853. 

  853. 									<h5>profile: <span class="tsd-signature-type">&quot;180p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;180p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;240p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;360p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;360p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;480p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;720p_3&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p_2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;1080p_3&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CustomVideoProfile</span></h5>
    854. 

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

  855. 										<p>视频 Profile</p>
    856. 

  856. 									</div>
    857. 

  857. 								</li>
    858. 

  858. 							</ul>
    859. 

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

  860. 						</li>
    861. 

  861. 					</ul>
    862. 

  862. 				</section>
    863. 

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

  864. 					<a name="snapshot" class="tsd-anchor"></a>
    865. 

  865. 					<h3>snapshot</h3>
    866. 

  866. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    867. 

  867. 						<li class="tsd-signature tsd-kind-icon">snapshot<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/snapshotoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SnapshotOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
    868. 

  868. 					</ul>
    869. 

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

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

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

  872. 								<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#snapshot">snapshot</a></p>
    873. 

  873. 							</aside>
    874. 

  874. 							<div class="tsd-comment tsd-typography">
    875. 

  875. 								<div class="lead">
    876. 

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

  877. 								</div>
    878. 

  878. 								<dl class="tsd-comment-tags">
    879. 

  879. 									<dt>example</dt>
    880. 

  880. 									<dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">snapshot</span><span style="color: #000000">({</span><span style="color: #001080">filename:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;xxx.jpg&#039;</span><span style="color: #000000">})</span>
    881. 

  881. <span style="color: #000000">  .</span><span style="color: #795E26">then</span><span style="color: #000000">((</span><span style="color: #001080">pic</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    882. 

  882. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;截屏图像&#039;</span><span style="color: #000000">, </span><span style="color: #001080">pic</span><span style="color: #000000">);</span>
    883. 

  883. <span style="color: #000000">  })</span>
    884. 

  884. <span style="color: #000000">  .</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    885. 

  885. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;截屏失败&#039;</span><span style="color: #000000">, </span><span style="color: #001080">err</span><span style="color: #000000">);</span>
    886. 

  886. <span style="color: #000000">  });</span>
    887. 

  887. </code></pre>
    888. 

  888. 									</dd>
    889. 

  889. 								</dl>
    890. 

  890. 							</div>
    891. 

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

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

  893. 								<li>
    894. 

  894. 									<h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="../interfaces/snapshotoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SnapshotOptions</a></h5>
    895. 

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

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

  897. 									</div>
    898. 

  898. 								</li>
    899. 

  899. 							</ul>
    900. 

  900. 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
    901. 

  901. 						</li>
    902. 

  902. 					</ul>
    903. 

  903. 				</section>
    904. 

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

  905. 					<a name="stop" class="tsd-anchor"></a>
    906. 

  906. 					<h3>stop</h3>
    907. 

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

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

  909. 					</ul>
    910. 

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

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

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

  913. 								<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#stop">stop</a></p>
    914. 

  914. 							</aside>
    915. 

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

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

  917. 									<p>停止播放当前流</p>
    918. 

  918. 								</div>
    919. 

  919. 								<dl class="tsd-comment-tags">
    920. 

  920. 									<dt>example</dt>
    921. 

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

  922. </code></pre>
    923. 

  923. 									</dd>
    924. 

  924. 								</dl>
    925. 

  925. 							</div>
    926. 

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

  927. 						</li>
    928. 

  928. 					</ul>
    929. 

  929. 				</section>
    930. 

  930. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    931. 

  931. 					<a name="switchdevice" class="tsd-anchor"></a>
    932. 

  932. 					<h3>switch<wbr>Device</h3>
    933. 

  933. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    934. 

  934. 						<li class="tsd-signature tsd-kind-icon">switch<wbr>Device<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;audio&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;video&quot;</span>, 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>
    935. 

  935. 					</ul>
    936. 

  936. 					<ul class="tsd-descriptions">
    937. 

  937. 						<li class="tsd-description">
    938. 

  938. 							<aside class="tsd-sources">
    939. 

  939. 							</aside>
    940. 

  940. 							<div class="tsd-comment tsd-typography">
    941. 

  941. 								<div class="lead">
    942. 

  942. 									<p>切换音视频设备</p>
    943. 

  943. 								</div>
    944. 

  944. 								<dl class="tsd-comment-tags">
    945. 

  945. 									<dt>example</dt>
    946. 

  946. 									<dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">switchDevice</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;audio&#039;</span><span style="color: #000000">, </span><span style="color: #A31515">&#039;xxxxxxx&#039;</span><span style="color: #000000">)</span>
    947. 

  947. <span style="color: #000000">  .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    948. 

  948. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;切换设备成功&#039;</span><span style="color: #000000">);</span>
    949. 

  949. <span style="color: #000000">  })</span>
    950. 

  950. <span style="color: #000000">  .</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    951. 

  951. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`切换设备失败：</span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    952. 

  952. <span style="color: #000000">  });</span>
    953. 

  953. </code></pre>
    954. 

  954. 									</dd>
    955. 

  955. 									<dt>reject</dt>
    956. 

  956. 									<dd><p><a href="rtcerror.html">RtcError</a></p>
    957. 

  957. 									</dd>
    958. 

  958. 								</dl>
    959. 

  959. 							</div>
    960. 

  960. 							<h4 class="tsd-parameters-title">Parameters</h4>
    961. 

  961. 							<ul class="tsd-parameters">
    962. 

  962. 								<li>
    963. 

  963. 									<h5>type: <span class="tsd-signature-type">&quot;audio&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;video&quot;</span></h5>
    964. 

  964. 									<div class="tsd-comment tsd-typography">
    965. 

  965. 										<p>设备类型</p>
    966. 

  966. 									</div>
    967. 

  967. 								</li>
    968. 

  968. 								<li>
    969. 

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

  970. 									<div class="tsd-comment tsd-typography">
    971. 

  971. 										<p>设备 ID</p>
    972. 

  972. 									</div>
    973. 

  973. 								</li>
    974. 

  974. 							</ul>
    975. 

  975. 							<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>
    976. 

  976. 						</li>
    977. 

  977. 					</ul>
    978. 

  978. 				</section>
    979. 

  979. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
    980. 

  980. 					<a name="switchimage" class="tsd-anchor"></a>
    981. 

  981. 					<h3>switch<wbr>Image</h3>
    982. 

  982. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
    983. 

  983. 						<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>
    984. 

  984. 					</ul>
    985. 

  985. 					<ul class="tsd-descriptions">
    986. 

  986. 						<li class="tsd-description">
    987. 

  987. 							<aside class="tsd-sources">
    988. 

  988. 							</aside>
    989. 

  989. 							<div class="tsd-comment tsd-typography">
    990. 

  990. 								<div class="lead">
    991. 

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

  992. 								</div>
    993. 

  993. 								<dl class="tsd-comment-tags">
    994. 

  994. 									<dt>example</dt>
    995. 

  995. 									<dd><pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">imgAddr</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;https://a.b.c/d.jpg&#039;</span><span style="color: #000000">;</span>
    996. 

  996. <span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">switchImage</span><span style="color: #000000">(</span><span style="color: #001080">imgAddr</span><span style="color: #000000">)</span>
    997. 

  997. <span style="color: #000000">  .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    998. 

  998. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;切换图片成功&#039;</span><span style="color: #000000">)</span>
    999. 

  999. <span style="color: #000000">  })</span>
    1000. 

  1000. <span style="color: #000000">  .</span><span style="color: #795E26">catch</span><span style="color: #000000">((</span><span style="color: #001080">err</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
    1001. 

  1001. <span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">error</span><span style="color: #000000">(</span><span style="color: #A31515">`切换图片失败：</span><span style="color: #0000FF">${</span><span style="color: #001080">err</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    1002. 

  1002. <span style="color: #000000">  });</span>
    1003. 

  1003. </code></pre>
    1004. 

  1004. 									</dd>
    1005. 

  1005. 									<dt>reject</dt>
    1006. 

  1006. 									<dd><p><a href="rtcerror.html">RtcError</a></p>
    1007. 

  1007. 									</dd>
    1008. 

  1008. 								</dl>
    1009. 

  1009. 							</div>
    1010. 

  1010. 							<h4 class="tsd-parameters-title">Parameters</h4>
    1011. 

  1011. 							<ul class="tsd-parameters">
    1012. 

  1012. 								<li>
    1013. 

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

  1014. 									<div class="tsd-comment tsd-typography">
    1015. 

  1015. 										<p>图片地址或图片文件</p>
    1016. 

  1016. 									</div>
    1017. 

  1017. 								</li>
    1018. 

  1018. 							</ul>
    1019. 

  1019. 							<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>
    1020. 

  1020. 						</li>
    1021. 

  1021. 					</ul>
    1022. 

  1022. 				</section>
    1023. 

  1023. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1024. 

  1024. 					<a name="unmuteaudio" class="tsd-anchor"></a>
    1025. 

  1025. 					<h3>unmute<wbr>Audio</h3>
    1026. 

  1026. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1027. 

  1027. 						<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>
    1028. 

  1028. 					</ul>
    1029. 

  1029. 					<ul class="tsd-descriptions">
    1030. 

  1030. 						<li class="tsd-description">
    1031. 

  1031. 							<aside class="tsd-sources">
    1032. 

  1032. 								<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#unmuteaudio">unmuteAudio</a></p>
    1033. 

  1033. 							</aside>
    1034. 

  1034. 							<div class="tsd-comment tsd-typography">
    1035. 

  1035. 								<div class="lead">
    1036. 

  1036. 									<p>unmute 当前流的音频</p>
    1037. 

  1037. 									<ul>
    1038. 

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

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

  1040. 									</ul>
    1041. 

  1041. 								</div>
    1042. 

  1042. 								<dl class="tsd-comment-tags">
    1043. 

  1043. 									<dt>example</dt>
    1044. 

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

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

  1046. </code></pre>
    1047. 

  1047. 									</dd>
    1048. 

  1048. 								</dl>
    1049. 

  1049. 							</div>
    1050. 

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

  1051. 							<p>操作是否成功</p>
    1052. 

  1052. 						</li>
    1053. 

  1053. 					</ul>
    1054. 

  1054. 				</section>
    1055. 

  1055. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1056. 

  1056. 					<a name="unmutevideo" class="tsd-anchor"></a>
    1057. 

  1057. 					<h3>unmute<wbr>Video</h3>
    1058. 

  1058. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1059. 

  1059. 						<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>
    1060. 

  1060. 					</ul>
    1061. 

  1061. 					<ul class="tsd-descriptions">
    1062. 

  1062. 						<li class="tsd-description">
    1063. 

  1063. 							<aside class="tsd-sources">
    1064. 

  1064. 								<p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#unmutevideo">unmuteVideo</a></p>
    1065. 

  1065. 							</aside>
    1066. 

  1066. 							<div class="tsd-comment tsd-typography">
    1067. 

  1067. 								<div class="lead">
    1068. 

  1068. 									<p>unmute 当前流的视频</p>
    1069. 

  1069. 									<ul>
    1070. 

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

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

  1072. 									</ul>
    1073. 

  1073. 								</div>
    1074. 

  1074. 								<dl class="tsd-comment-tags">
    1075. 

  1075. 									<dt>example</dt>
    1076. 

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

  1077. <span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`stream&#039;s video is muted </span><span style="color: #0000FF">${</span><span style="color: #001080">stream</span><span style="color: #000000FF">.</span><span style="color: #001080">videoMuted</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">);</span>
    1078. 

  1078. </code></pre>
    1079. 

  1079. 									</dd>
    1080. 

  1080. 								</dl>
    1081. 

  1081. 							</div>
    1082. 

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

  1083. 							<p>操作是否成功</p>
    1084. 

  1084. 						</li>
    1085. 

  1085. 					</ul>
    1086. 

  1086. 				</section>
    1087. 

  1087. 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
    1088. 

  1088. 					<a name="use" class="tsd-anchor"></a>
    1089. 

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

  1090. 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
    1091. 

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

  1092. 					</ul>
    1093. 

  1093. 					<ul class="tsd-descriptions">
    1094. 

  1094. 						<li class="tsd-description">
    1095. 

  1095. 							<aside class="tsd-sources">
    1096. 

  1096. 							</aside>
    1097. 

  1097. 							<div class="tsd-comment tsd-typography">
    1098. 

  1098. 								<div class="lead">
    1099. 

  1099. 									<p>加载流插件，使用插件功能</p>
    1100. 

  1100. 								</div>
    1101. 

  1101. 							</div>
    1102. 

  1102. 							<h4 class="tsd-parameters-title">Parameters</h4>
    1103. 

  1103. 							<ul class="tsd-parameters">
    1104. 

  1104. 								<li>
    1105. 

  1105. 									<h5>plugin: <a href="../interfaces/streamplugin.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamPlugin</a></h5>
    1106. 

  1106. 									<div class="tsd-comment tsd-typography">
    1107. 

  1107. 										<p>插件</p>
    1108. 

  1108. 									</div>
    1109. 

  1109. 								</li>
    1110. 

  1110. 								<li>
    1111. 

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

  1112. 									<div class="tsd-comment tsd-typography">
    1113. 

  1113. 										<p>插件初始化参数</p>
    1114. 

  1114. 									</div>
    1115. 

  1115. 								</li>
    1116. 

  1116. 							</ul>
    1117. 

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

  1118. 						</li>
    1119. 

  1119. 					</ul>
    1120. 

  1120. 				</section>
    1121. 

  1121. 			</section>
    1122. 

  1122. 		</div>
    1123. 

  1123. 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
    1124. 

  1124. 			<nav class="tsd-navigation primary">
    1125. 

  1125. 				<ul>
    1126. 

  1126. 					<li class=" ">
    1127. 

  1127. 						<a href="../index.html">Exports</a>
    1128. 

  1128. 					</li>
    1129. 

  1129. 				</ul>
    1130. 

  1130. 			</nav>
    1131. 

  1131. 			<nav class="tsd-navigation secondary menu-sticky">
    1132. 

  1132. 				<ul class="before-current">
    1133. 

  1133. 				</ul>
    1134. 

  1134. 				<ul class="current">
    1135. 

  1135. 					<li class="current tsd-kind-class">
    1136. 

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

  1137. 						<ul>
    1138. 

  1138. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
    1139. 

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

  1140. 							</li>
    1141. 

  1141. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
    1142. 

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

  1143. 							</li>
    1144. 

  1144. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
    1145. 

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

  1146. 							</li>
    1147. 

  1147. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
    1148. 

  1148. 								<a href="localstream.html#userid" class="tsd-kind-icon">user<wbr>Id</a>
    1149. 

  1149. 							</li>
    1150. 

  1150. 							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
    1151. 

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

  1152. 							</li>
    1153. 

  1153. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    1154. 

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

  1155. 							</li>
    1156. 

  1156. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    1157. 

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

  1158. 							</li>
    1159. 

  1159. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1160. 

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

  1161. 							</li>
    1162. 

  1162. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1163. 

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

  1164. 							</li>
    1165. 

  1165. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1166. 

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

  1167. 							</li>
    1168. 

  1168. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
    1169. 

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

  1170. 							</li>
    1171. 

  1171. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
    1172. 

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

  1173. 							</li>
    1174. 

  1174. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    1175. 

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

  1176. 							</li>
    1177. 

  1177. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1178. 

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

  1179. 							</li>
    1180. 

  1180. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1181. 

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

  1182. 							</li>
    1183. 

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

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

  1185. 							</li>
    1186. 

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

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

  1188. 							</li>
    1189. 

  1189. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1190. 

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

  1191. 							</li>
    1192. 

  1192. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    1193. 

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

  1194. 							</li>
    1195. 

  1195. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    1196. 

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

  1197. 							</li>
    1198. 

  1198. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1199. 

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

  1200. 							</li>
    1201. 

  1201. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    1202. 

  1202. 								<a href="localstream.html#setaudiolevel" class="tsd-kind-icon">set<wbr>Audio<wbr>Level</a>
    1203. 

  1203. 							</li>
    1204. 

  1204. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    1205. 

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

  1206. 							</li>
    1207. 

  1207. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    1208. 

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

  1209. 							</li>
    1210. 

  1210. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1211. 

  1211. 								<a href="localstream.html#snapshot" class="tsd-kind-icon">snapshot</a>
    1212. 

  1212. 							</li>
    1213. 

  1213. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1214. 

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

  1215. 							</li>
    1216. 

  1216. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    1217. 

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

  1218. 							</li>
    1219. 

  1219. 							<li class=" tsd-kind-method tsd-parent-kind-class">
    1220. 

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

  1221. 							</li>
    1222. 

  1222. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1223. 

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

  1224. 							</li>
    1225. 

  1225. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
    1226. 

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

  1227. 							</li>
    1228. 

  1228. 							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
    1229. 

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

  1230. 							</li>
    1231. 

  1231. 						</ul>
    1232. 

  1232. 					</li>
    1233. 

  1233. 				</ul>
    1234. 

  1234. 				<ul class="after-current">
    1235. 

  1235. 				</ul>
    1236. 

  1236. 			</nav>
    1237. 

  1237. 		</div>
    1238. 

  1238. 	</div>
    1239. 

  1239. </div>
    1240. 

  1240. <footer class="with-border-bottom">
    1241. 

  1241. 	<div class="container">
    1242. 

  1242. 		<h2>Legend</h2>
    1243. 

  1243. 		<div class="tsd-legend-group">
    1244. 

  1244. 			<ul class="tsd-legend">
    1245. 

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

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

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

  1248. 			</ul>
    1249. 

  1249. 			<ul class="tsd-legend">
    1250. 

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

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

  1252. 			</ul>
    1253. 

  1253. 			<ul class="tsd-legend">
    1254. 

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

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

  1256. 			</ul>
    1257. 

  1257. 			<ul class="tsd-legend">
    1258. 

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

  1259. 			</ul>
    1260. 

  1260. 		</div>
    1261. 

  1261. 	</div>
    1262. 

  1262. </footer>
    1263. 

  1263. <div class="container tsd-generator">
    1264. 

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

  1265. </div>
    1266. 

  1266. <div class="overlay"></div>
    1267. 

  1267. <script src="../assets/js/main.js"></script>
    1268. 

  1268. </body>
    1269. 

  1269. </html>
    1270.