| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268 |
- <!doctype html>
- <html class="default no-js">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <title>LocalStream | @urtc/sdk-web</title>
- <meta name="description" content="Documentation for @urtc/sdk-web">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- </head>
- <body>
- <header>
- <div class="tsd-page-toolbar">
- <div class="container">
- <div class="table-wrap">
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div class="field">
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
- </div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
- <a href="../index.html" class="title">@urtc/sdk-web</a>
- </div>
- <div class="table-cell" id="tsd-widgets">
- <div id="tsd-filter">
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
- <div class="tsd-filter-group">
- <div class="tsd-select" id="tsd-filter-visibility">
- <span class="tsd-select-label">All</span>
- <ul class="tsd-select-list">
- <li data-value="public">Public</li>
- <li data-value="protected">Public/Protected</li>
- <li data-value="private" class="selected">All</li>
- </ul>
- </div>
- <input type="checkbox" id="tsd-filter-inherited" checked />
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
- <input type="checkbox" id="tsd-filter-externals" checked />
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
- </div>
- </div>
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
- </div>
- </div>
- </div>
- </div>
- <div class="tsd-page-title">
- <div class="container">
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">@urtc/sdk-web</a>
- </li>
- <li>
- <a href="localstream.html">LocalStream</a>
- </li>
- </ul>
- <h1>Class LocalStream</h1>
- </div>
- </div>
- </header>
- <div class="container container-main">
- <div class="row">
- <div class="col-8 col-content">
- <section class="tsd-panel tsd-comment">
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>本地流,可用于本地预览,也可用 client 进行发布</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-hierarchy">
- <h3>Hierarchy</h3>
- <ul class="tsd-hierarchy">
- <li>
- <a href="stream.html" class="tsd-signature-type" data-tsd-kind="Class">Stream</a>
- <ul class="tsd-hierarchy">
- <li>
- <span class="target">LocalStream</span>
- </li>
- </ul>
- </li>
- </ul>
- </section>
- <section class="tsd-panel-group tsd-index-group">
- <h2>Index</h2>
- <section class="tsd-panel tsd-index-panel">
- <div class="tsd-index-content">
- <section class="tsd-index-section tsd-is-inherited">
- <h3>Properties</h3>
- <ul class="tsd-index-list">
- <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>
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#id" class="tsd-kind-icon">id</a></li>
- <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>
- <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>
- <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>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Methods</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#addtrack" class="tsd-kind-icon">add<wbr>Track</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#destroy" class="tsd-kind-icon">destroy</a></li>
- <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>
- <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>
- <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>
- <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>
- <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>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#init" class="tsd-kind-icon">init</a></li>
- <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>
- <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>
- <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>
- <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>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#play" class="tsd-kind-icon">play</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#removetrack" class="tsd-kind-icon">remove<wbr>Track</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#replacetrack" class="tsd-kind-icon">replace<wbr>Track</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#resume" class="tsd-kind-icon">resume</a></li>
- <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>
- <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>
- <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>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#snapshot" class="tsd-kind-icon">snapshot</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="localstream.html#stop" class="tsd-kind-icon">stop</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#switchdevice" class="tsd-kind-icon">switch<wbr>Device</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="localstream.html#switchimage" class="tsd-kind-icon">switch<wbr>Image</a></li>
- <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>
- <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>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="localstream.html#use" class="tsd-kind-icon">use</a></li>
- </ul>
- </section>
- </div>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group tsd-is-inherited">
- <h2>Properties</h2>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="audiomuted" class="tsd-anchor"></a>
- <h3>audio<wbr>Muted</h3>
- <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>
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#audiomuted">audioMuted</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>当前流是否 mute 了音频</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="id" class="tsd-anchor"></a>
- <h3>id</h3>
- <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#id">id</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>当前流ID</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="mediastream" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> media<wbr>Stream</h3>
- <div class="tsd-signature tsd-kind-icon">media<wbr>Stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MediaStream</span></div>
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#mediastream">mediaStream</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>当前流包含的媒体流,关于媒体流,请详见 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaStream">MediaStream</a>。</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="userid" class="tsd-anchor"></a>
- <h3>user<wbr>Id</h3>
- <div class="tsd-signature tsd-kind-icon">user<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#userid">userId</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>当前流所属用户的ID
- 注:若创建本地流时指定的 userId 与 join 时指定的 userId 不同,那么发布本条流时,流的 userId 将会自动被自动更新为 join 时指定的 userId</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a name="videomuted" class="tsd-anchor"></a>
- <h3>video<wbr>Muted</h3>
- <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>
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#videomuted">videoMuted</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>当前流是否 mute 了视频</p>
- </div>
- </div>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Methods</h2>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="addtrack" class="tsd-anchor"></a>
- <h3>add<wbr>Track</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>添加一条媒体轨道(音轨或视轨)到当前流</p>
- <blockquote>
- <p>注:</p>
- <ol>
- <li>若创建本地流时,audio 为 false,不可添加音轨,video 为 false 时,不可添加视轨</li>
- </ol>
- </blockquote>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>track: <span class="tsd-signature-type">MediaStreamTrack</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>媒体轨道</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="destroy" class="tsd-anchor"></a>
- <h3>destroy</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>销毁当前流,一般在本地流不再被使用时,可调用此方法销毁,解除摄像头或麦克风设备的占用。</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="getaudiolevel" class="tsd-anchor"></a>
- <h3>get<wbr>Audio<wbr>Level</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#getaudiolevel">getAudioLevel</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>获取当前流的音量大小,只有当本地流或远端流中有音频数据才有效。</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #795E26">setInterval</span><span style="color: #000000">(() </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
- <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>
- <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"> > </span><span style="color: #098658">0</span><span style="color: #000000">) {</span>
- <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>
- <span style="color: #000000"> }</span>
- <span style="color: #000000">}, </span><span style="color: #098658">200</span><span style="color: #000000">);</span>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="getmediatype" class="tsd-anchor"></a>
- <h3>get<wbr>Media<wbr>Type</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#getmediatype">getMediaType</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>获取流的媒体类型</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <a href="../index.html#mediatype" class="tsd-signature-type" data-tsd-kind="Type alias">MediaType</a></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="getstats" class="tsd-anchor"></a>
- <h3>get<wbr>Stats</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <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"><</span><a href="../interfaces/streamstats.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamStats</a><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#getstats">getStats</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>获取流发布或订阅后的统计数据</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #001080">stream</span>
- <span style="color: #000000"> .</span><span style="color: #795E26">getStats</span><span style="color: #000000">()</span>
- <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">=></span><span style="color: #000000"> {</span>
- <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: #000000">, </span><span style="color: #001080">stats</span><span style="color: #000000">);</span>
- <span style="color: #000000"> });</span>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/streamstats.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamStats</a><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
- <a name="hasaudio" class="tsd-anchor"></a>
- <h3>has<wbr>Audio</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Overrides <a href="stream.html">Stream</a>.<a href="stream.html#hasaudio">hasAudio</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>判断当前流是否有音频</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
- <a name="hasvideo" class="tsd-anchor"></a>
- <h3>has<wbr>Video</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Overrides <a href="stream.html">Stream</a>.<a href="stream.html#hasvideo">hasVideo</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>判断当前流是否有视频</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="init" class="tsd-anchor"></a>
- <h3>init</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>初始化本地流对象,将读取麦克风、摄像头、屏幕共享等来初始化媒体流</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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>
- <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: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
- <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>
- <span style="color: #000000"> })</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">=></span><span style="color: #000000"> {</span>
- <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: #000000"> })</span>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="muteaudio" class="tsd-anchor"></a>
- <h3>mute<wbr>Audio</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#muteaudio">muteAudio</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>mute 当前流的音频</p>
- <ul>
- <li>本地流调用此方法时,将不向服务器推送音频数据,远端用户将收到 <code>mute-audio</code> 的事件通知</li>
- <li>远端流调用此方法时,仅为不从服务器拉取音频数据,并无事件通知远端用户</li>
- </ul>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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>
- <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'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>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
- <p>操作是否成功</p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="mutevideo" class="tsd-anchor"></a>
- <h3>mute<wbr>Video</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#mutevideo">muteVideo</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>mute 当前流的视频</p>
- <ul>
- <li>本地流调用此方法时,将不向服务器推送视频数据,远端用户将收到 <code>mute-video</code> 的事件通知</li>
- <li>远端流调用此方法时,仅为不从服务器拉取视频数据,并无事件通知远端用户</li>
- </ul>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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>
- <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'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>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
- <p>操作是否成功</p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
- <a name="off" class="tsd-anchor"></a>
- <h3>off</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">off<T><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"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#off">off</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>取消监听流对象事件</p>
- </div>
- </div>
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
- <ul class="tsd-type-parameters">
- <li>
- <h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"user-joined"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"user-left"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"kick-off"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stream-added"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stream-removed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stream-subscribed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stream-published"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stream-reconnecting"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stream-reconnected"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mute-audio"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"unmute-audio"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mute-video"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"unmute-video"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"first-key-frame"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"screen-sharing-stopped"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"connection-state-changed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"network-quality"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"player-status-change"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"*"</span></h4>
- </li>
- </ul>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>type: <span class="tsd-signature-type">T</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>流对象事件类型,特别的,当为 '*' 时,取消监听所有事件</p>
- </div>
- </li>
- <li>
- <h5>listener: <span class="tsd-signature-type">Listener</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
- <div class="tsd-comment tsd-typography">
- <p>流对象事件监听函数</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventEmitter</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
- <a name="on" class="tsd-anchor"></a>
- <h3>on</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
- <li class="tsd-signature tsd-kind-icon">on<T><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"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#on">on</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>监听流对象事件</p>
- </div>
- </div>
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
- <ul class="tsd-type-parameters">
- <li>
- <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>
- </li>
- </ul>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>type: <span class="tsd-signature-type">T</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>流事件类型</p>
- </div>
- </li>
- <li>
- <h5>listener: <span class="tsd-signature-type">Listener</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
- <div class="tsd-comment tsd-typography">
- <p>流事件监听函数</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventEmitter</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="play" class="tsd-anchor"></a>
- <h3>play</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#play">play</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>播放当前流</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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">'xxx'</span><span style="color: #000000">; </span><span style="color: #008000">// 比如 id 为 xxx 的 div 元素</span>
- <span style="color: #001080">stream</span>
- <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>
- <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">=></span><span style="color: #000000"> {</span>
- <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>
- <span style="color: #000000"> });</span>
- </code></pre>
- </dd>
- <dt>reject</dt>
- <dd><p><a href="rtcerror.html">RtcError</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>container: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>播放音视频时,包裹 video 标签所用的容器元素或容器元素的 ID</p>
- </div>
- </li>
- <li>
- <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>
- <div class="tsd-comment tsd-typography">
- <p>其他播放参数,参见<a href="../interfaces/playoptions.html">PlayOptions</a></p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="removetrack" class="tsd-anchor"></a>
- <h3>remove<wbr>Track</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>从当前流中删除一条媒体轨道(音轨或视轨)</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>track: <span class="tsd-signature-type">MediaStreamTrack</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>媒体轨道</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="replacetrack" class="tsd-anchor"></a>
- <h3>replace<wbr>Track</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>替换当前流中的媒体轨道</p>
- <blockquote>
- <p>注:</p>
- <ol>
- <li>替换视频时,建议使用与原轨道相同的分辨率的视频轨道,若不相同,请在替换后及时设置流的 profile 来调整到合适的码率等</li>
- <li>返回值为当前流中相同类型的媒体轨道,此媒体轨道仍可用(占用音频设备或视频设备),请自行决定是否调用其 stop 方法释放设备</li>
- <li>若是切换不同的摄像头或麦克风设备,建议使用 switchDevice 方法,若是切换静态图片为视频流,建立使用 switchImage 方法</li>
- </ol>
- </blockquote>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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>
- <span style="color: #001080">oldTrack</span><span style="color: #000000">.</span><span style="color: #795E26">stop</span><span style="color: #000000">();</span>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>track: <span class="tsd-signature-type">MediaStreamTrack</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>新媒体轨道</p>
- </div>
- </li>
- </ul>
- <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>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="resume" class="tsd-anchor"></a>
- <h3>resume</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#resume">resume</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>恢复播放流,一般由于浏览器限制无法自动播放时,可提示用户手动触发该方法进行恢复播放</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #001080">stream</span>
- <span style="color: #000000"> .</span><span style="color: #795E26">resume</span><span style="color: #000000">()</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">=></span><span style="color: #000000"> {</span>
- <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: #000000"> });</span>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="setaudiolevel" class="tsd-anchor"></a>
- <h3>set<wbr>Audio<wbr>Level</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>设置音频能量大小,默认 100</p>
- </div>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>level: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>能量大小,取值范围 [0-300]</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="setscreenprofile" class="tsd-anchor"></a>
- <h3>set<wbr>Screen<wbr>Profile</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <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">"480p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p_2"</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">"480p_2"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>设置当前流(屏幕共享流)视频的 Profile,默认 '1080p'
- 注:请务必在调用 init 方法之前,设置屏幕共享流的 Profile,否则无法生效。</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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">'720p'</span><span style="color: #000000">);</span>
- <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">=></span><span style="color: #000000"> {</span>
- <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: #000000">});</span>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>profile: <span class="tsd-signature-type">"480p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p_2"</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">"480p_2"</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>视频 Profile</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="setvideoprofile" class="tsd-anchor"></a>
- <h3>set<wbr>Video<wbr>Profile</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <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">"180p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"180p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"240p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"360p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"360p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"480p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p_3"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p_3"</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>设置当前流视频的 Profile,默认 '360p_2'</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #001080">stream</span>
- <span style="color: #000000"> .</span><span style="color: #795E26">setVideoProfile</span><span style="color: #000000">(</span><span style="color: #A31515">'720p'</span><span style="color: #000000">)</span>
- <span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
- <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">'set video profile success'</span><span style="color: #000000">);</span>
- <span style="color: #000000"> })</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">=></span><span style="color: #000000"> {</span>
- <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">'set video profile failed '</span><span style="color: #000000">, </span><span style="color: #001080">err</span><span style="color: #000000">);</span>
- <span style="color: #000000"> });</span>
- </code></pre>
- <p>或</p>
- <pre><code class="language-js"><span style="color: #001080">stream</span>
- <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>
- <span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
- <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">'set video profile success'</span><span style="color: #000000">);</span>
- <span style="color: #000000"> })</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">=></span><span style="color: #000000"> {</span>
- <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">'set video profile failed '</span><span style="color: #000000">, </span><span style="color: #001080">err</span><span style="color: #000000">);</span>
- <span style="color: #000000"> });</span>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>profile: <span class="tsd-signature-type">"180p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"180p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"240p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"360p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"360p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"480p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"720p_3"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p_2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1080p_3"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CustomVideoProfile</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>视频 Profile</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="snapshot" class="tsd-anchor"></a>
- <h3>snapshot</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#snapshot">snapshot</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>对当前流进行截屏,可用于页面展示或下载保存</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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">'xxx.jpg'</span><span style="color: #000000">})</span>
- <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">=></span><span style="color: #000000"> {</span>
- <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: #000000">, </span><span style="color: #001080">pic</span><span style="color: #000000">);</span>
- <span style="color: #000000"> })</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">=></span><span style="color: #000000"> {</span>
- <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: #000000">, </span><span style="color: #001080">err</span><span style="color: #000000">);</span>
- <span style="color: #000000"> });</span>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <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>
- <div class="tsd-comment tsd-typography">
- <p>截屏参数,选传,参见<a href="../interfaces/snapshotoptions.html">SnapshotOptions</a></p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="stop" class="tsd-anchor"></a>
- <h3>stop</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#stop">stop</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>停止播放当前流</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="switchdevice" class="tsd-anchor"></a>
- <h3>switch<wbr>Device</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <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">"audio"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"video"</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>切换音视频设备</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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">'audio'</span><span style="color: #000000">, </span><span style="color: #A31515">'xxxxxxx'</span><span style="color: #000000">)</span>
- <span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
- <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: #000000">);</span>
- <span style="color: #000000"> })</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">=></span><span style="color: #000000"> {</span>
- <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: #000000"> });</span>
- </code></pre>
- </dd>
- <dt>reject</dt>
- <dd><p><a href="rtcerror.html">RtcError</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>type: <span class="tsd-signature-type">"audio"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"video"</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>设备类型</p>
- </div>
- </li>
- <li>
- <h5>deviceId: <span class="tsd-signature-type">string</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>设备 ID</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
- <a name="switchimage" class="tsd-anchor"></a>
- <h3>switch<wbr>Image</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
- <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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>切换图片 - 使用图片生成视频,并将当前流的视频使用其代替</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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">'https://a.b.c/d.jpg'</span><span style="color: #000000">;</span>
- <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>
- <span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
- <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: #000000">)</span>
- <span style="color: #000000"> })</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">=></span><span style="color: #000000"> {</span>
- <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>
- <span style="color: #000000"> });</span>
- </code></pre>
- </dd>
- <dt>reject</dt>
- <dd><p><a href="rtcerror.html">RtcError</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>file: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">File</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>图片地址或图片文件</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="unmuteaudio" class="tsd-anchor"></a>
- <h3>unmute<wbr>Audio</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#unmuteaudio">unmuteAudio</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>unmute 当前流的音频</p>
- <ul>
- <li>本地流调用此方法时,将向服务器推送音频数据,远端用户将收到 <code>unmute-audio</code> 的事件通知</li>
- <li>远端流调用此方法时,会从服务器拉取音频数据,并无事件通知远端用户</li>
- </ul>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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>
- <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'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>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
- <p>操作是否成功</p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a name="unmutevideo" class="tsd-anchor"></a>
- <h3>unmute<wbr>Video</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <p>Inherited from <a href="stream.html">Stream</a>.<a href="stream.html#unmutevideo">unmuteVideo</a></p>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>unmute 当前流的视频</p>
- <ul>
- <li>本地流调用此方法时,将向服务器推送视频数据,远端用户将收到 <code>unmute-video</code> 的事件通知</li>
- <li>远端流调用此方法时,会从服务器拉取视频数据,并无事件通知远端用户</li>
- </ul>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <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>
- <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'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>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
- <p>操作是否成功</p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="use" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> use</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <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>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>加载流插件,使用插件功能</p>
- </div>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>plugin: <a href="../interfaces/streamplugin.html" class="tsd-signature-type" data-tsd-kind="Interface">StreamPlugin</a></h5>
- <div class="tsd-comment tsd-typography">
- <p>插件</p>
- </div>
- </li>
- <li>
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>插件初始化参数</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- </section>
- </div>
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
- <nav class="tsd-navigation primary">
- <ul>
- <li class=" ">
- <a href="../index.html">Exports</a>
- </li>
- </ul>
- </nav>
- <nav class="tsd-navigation secondary menu-sticky">
- <ul class="before-current">
- </ul>
- <ul class="current">
- <li class="current tsd-kind-class">
- <a href="localstream.html" class="tsd-kind-icon">Local<wbr>Stream</a>
- <ul>
- <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>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
- <a href="localstream.html#id" class="tsd-kind-icon">id</a>
- </li>
- <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>
- <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>
- <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>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="localstream.html#addtrack" class="tsd-kind-icon">add<wbr>Track</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="localstream.html#destroy" class="tsd-kind-icon">destroy</a>
- </li>
- <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>
- <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>
- <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>
- <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>
- <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>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="localstream.html#init" class="tsd-kind-icon">init</a>
- </li>
- <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>
- <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>
- <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>
- <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>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="localstream.html#play" class="tsd-kind-icon">play</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="localstream.html#removetrack" class="tsd-kind-icon">remove<wbr>Track</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="localstream.html#replacetrack" class="tsd-kind-icon">replace<wbr>Track</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="localstream.html#resume" class="tsd-kind-icon">resume</a>
- </li>
- <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>
- <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>
- <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>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="localstream.html#snapshot" class="tsd-kind-icon">snapshot</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
- <a href="localstream.html#stop" class="tsd-kind-icon">stop</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="localstream.html#switchdevice" class="tsd-kind-icon">switch<wbr>Device</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class">
- <a href="localstream.html#switchimage" class="tsd-kind-icon">switch<wbr>Image</a>
- </li>
- <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>
- <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>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="localstream.html#use" class="tsd-kind-icon">use</a>
- </li>
- </ul>
- </li>
- </ul>
- <ul class="after-current">
- </ul>
- </nav>
- </div>
- </div>
- </div>
- <footer class="with-border-bottom">
- <div class="container">
- <h2>Legend</h2>
- <div class="tsd-legend-group">
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
- </ul>
- </div>
- </div>
- </footer>
- <div class="container tsd-generator">
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
- </div>
- <div class="overlay"></div>
- <script src="../assets/js/main.js"></script>
- </body>
- </html>
|