| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694 |
- <!doctype html>
- <html class="default no-js">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <title>@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">
- <h1>@urtc/sdk-web</h1>
- </div>
- </div>
- </header>
- <div class="container container-main">
- <div class="row">
- <div class="col-8 col-content">
- <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 ">
- <h3>Classes</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-class"><a href="classes/client.html" class="tsd-kind-icon">Client</a></li>
- <li class="tsd-kind-class"><a href="classes/localstream.html" class="tsd-kind-icon">Local<wbr>Stream</a></li>
- <li class="tsd-kind-class"><a href="classes/remotestream.html" class="tsd-kind-icon">Remote<wbr>Stream</a></li>
- <li class="tsd-kind-class"><a href="classes/rtcerror.html" class="tsd-kind-icon">Rtc<wbr>Error</a></li>
- <li class="tsd-kind-class"><a href="classes/stream.html" class="tsd-kind-icon">Stream</a></li>
- <li class="tsd-kind-class"><a href="classes/user.html" class="tsd-kind-icon">User</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Interfaces</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-interface"><a href="interfaces/audiostats.html" class="tsd-kind-icon">Audio<wbr>Stats</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/clientoptions.html" class="tsd-kind-icon">Client<wbr>Options</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/clientplugin.html" class="tsd-kind-icon">Client<wbr>Plugin</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/codecs.html" class="tsd-kind-icon">Codecs</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/connectionstates.html" class="tsd-kind-icon">Connection<wbr>States</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/devicechangedeventdata.html" class="tsd-kind-icon">Device<wbr>Changed<wbr>Event<wbr>Data</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/devicedetectionoptions.html" class="tsd-kind-icon">Device<wbr>Detection<wbr>Options</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/getdevicesoptions.html" class="tsd-kind-icon">Get<wbr>Devices<wbr>Options</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/joinoptions.html" class="tsd-kind-icon">Join<wbr>Options</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/localstreamoptions.html" class="tsd-kind-icon">Local<wbr>Stream<wbr>Options</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/networkqualities.html" class="tsd-kind-icon">Network<wbr>Qualities</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/networkstats.html" class="tsd-kind-icon">Network<wbr>Stats</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/playoptions.html" class="tsd-kind-icon">Play<wbr>Options</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/playereventdata.html" class="tsd-kind-icon">Player<wbr>Event<wbr>Data</a></li>
- <li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/rtcevent.html" class="tsd-kind-icon">Rtc<wbr>Event</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/serverconfig.html" class="tsd-kind-icon">Server<wbr>Config</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/snapshotoptions.html" class="tsd-kind-icon">Snapshot<wbr>Options</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/streamplugin.html" class="tsd-kind-icon">Stream<wbr>Plugin</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/streamstats.html" class="tsd-kind-icon">Stream<wbr>Stats</a></li>
- <li class="tsd-kind-interface"><a href="interfaces/videostats.html" class="tsd-kind-icon">Video<wbr>Stats</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Type aliases</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-type-alias"><a href="index.html#audiocodec" class="tsd-kind-icon">Audio<wbr>Codec</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#connectionstate" class="tsd-kind-icon">Connection<wbr>State</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#errorcode" class="tsd-kind-icon">Error<wbr>Code</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#facingmode" class="tsd-kind-icon">Facing<wbr>Mode</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#mediatype" class="tsd-kind-icon">Media<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#networkquality" class="tsd-kind-icon">Network<wbr>Quality</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#playcontrolstype" class="tsd-kind-icon">Play<wbr>Controls<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#playervideofittype" class="tsd-kind-icon">Player<wbr>Video<wbr>Fit<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#roletype" class="tsd-kind-icon">Role<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#roomtype" class="tsd-kind-icon">Room<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcconnectionstateevent" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>State<wbr>Event</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcconnectionstateeventtype" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>State<wbr>Event<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcdevicechangedevent" class="tsd-kind-icon">Rtc<wbr>Device<wbr>Changed<wbr>Event</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcdevicechangedeventtype" class="tsd-kind-icon">Rtc<wbr>Device<wbr>Changed<wbr>Event<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcerrorevent" class="tsd-kind-icon">Rtc<wbr>Error<wbr>Event</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcerroreventtype" class="tsd-kind-icon">Rtc<wbr>Error<wbr>Event<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtceventtype" class="tsd-kind-icon">Rtc<wbr>Event<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcnetworkqualityevent" class="tsd-kind-icon">Rtc<wbr>Network<wbr>Quality<wbr>Event</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcnetworkqualityeventtype" class="tsd-kind-icon">Rtc<wbr>Network<wbr>Quality<wbr>Event<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcplayerevent" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcplayereventtype" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcstreamevent" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcstreameventtype" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcuserevent" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#rtcusereventtype" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#screenprofile" class="tsd-kind-icon">Screen<wbr>Profile</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#switchdevicetype" class="tsd-kind-icon">Switch<wbr>Device<wbr>Type</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#videocodec" class="tsd-kind-icon">Video<wbr>Codec</a></li>
- <li class="tsd-kind-type-alias"><a href="index.html#videoprofile" class="tsd-kind-icon">Video<wbr>Profile</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Variables</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-variable"><a href="index.html#version" class="tsd-kind-icon">version</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Functions</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-function"><a href="index.html#createclient" class="tsd-kind-icon">create<wbr>Client</a></li>
- <li class="tsd-kind-function"><a href="index.html#createstream" class="tsd-kind-icon">create<wbr>Stream</a></li>
- <li class="tsd-kind-function"><a href="index.html#devicedetection" class="tsd-kind-icon">device<wbr>Detection</a></li>
- <li class="tsd-kind-function"><a href="index.html#disableuploadlog" class="tsd-kind-icon">disable<wbr>Upload<wbr>Log</a></li>
- <li class="tsd-kind-function"><a href="index.html#enableuploadlog" class="tsd-kind-icon">enable<wbr>Upload<wbr>Log</a></li>
- <li class="tsd-kind-function"><a href="index.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a></li>
- <li class="tsd-kind-function"><a href="index.html#getcameras" class="tsd-kind-icon">get<wbr>Cameras</a></li>
- <li class="tsd-kind-function"><a href="index.html#getdevices" class="tsd-kind-icon">get<wbr>Devices</a></li>
- <li class="tsd-kind-function"><a href="index.html#getloudspeakers" class="tsd-kind-icon">get<wbr>Loudspeakers</a></li>
- <li class="tsd-kind-function"><a href="index.html#getmicrophones" class="tsd-kind-icon">get<wbr>Microphones</a></li>
- <li class="tsd-kind-function"><a href="index.html#getsupportedcodec" class="tsd-kind-icon">get<wbr>Supported<wbr>Codec</a></li>
- <li class="tsd-kind-function"><a href="index.html#issupportscreenshare" class="tsd-kind-icon">is<wbr>Support<wbr>Screen<wbr>Share</a></li>
- <li class="tsd-kind-function"><a href="index.html#issupportwebrtc" class="tsd-kind-icon">is<wbr>Support<wbr>WebRTC</a></li>
- <li class="tsd-kind-function"><a href="index.html#setloglevel" class="tsd-kind-icon">set<wbr>Log<wbr>Level</a></li>
- <li class="tsd-kind-function"><a href="index.html#setservers" class="tsd-kind-icon">set<wbr>Servers</a></li>
- </ul>
- </section>
- </div>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Type aliases</h2>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="audiocodec" class="tsd-anchor"></a>
- <h3>Audio<wbr>Codec</h3>
- <div class="tsd-signature tsd-kind-icon">Audio<wbr>Codec<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"opus"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>音频编解码格式</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="connectionstate" class="tsd-anchor"></a>
- <h3>Connection<wbr>State</h3>
- <div class="tsd-signature tsd-kind-icon">Connection<wbr>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"OPEN"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"CONNECTING"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"CLOSING"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"RECONNECTING"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"CLOSED"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>连接状态类型:</p>
- <ul>
- <li>OPEN - 已连接</li>
- <li>CONNECTING - 连接中</li>
- <li>CLOSING - 断开中</li>
- <li>RECONNECTING - 重连中</li>
- <li>CLOSED - 已断开</li>
- </ul>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="errorcode" class="tsd-anchor"></a>
- <h3>Error<wbr>Code</h3>
- <div class="tsd-signature tsd-kind-icon">Error<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="classes/rtcerror.html" class="tsd-signature-type" data-tsd-kind="Class">RtcError</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Exclude</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-symbol">typeof </span><a href="classes/rtcerror.html" class="tsd-signature-type" data-tsd-kind="Class">RtcError</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"prototype"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"getCode"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stackTraceLimit"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"prepareStackTrace"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"captureStackTrace"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">]</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>RTC 错误代码</p>
- </div>
- <p>通用错误及代码</p>
- <ul>
- <li>1000 - 非法参数</li>
- <li>1001 - 非法操作</li>
- <li>1002 - 不支持</li>
- <li>1003 - 不存在</li>
- <li>1004 - 请求失败</li>
- <li>1999 - 其他错误</li>
- </ul>
- <p>房间相关错误及代码</p>
- <ul>
- <li>2000 - 网关不可达</li>
- <li>2001 - 获取 Access Token 失败</li>
- <li>2002 - Access Token 非法</li>
- <li>2003 - Websocket 连接失败</li>
- <li>2004 - 加入房间失败</li>
- <li>2005 - 未加入房间</li>
- <li>2006 - 正在加入房间</li>
- <li>2007 - 正在离开房间</li>
- <li>2008 - 角色类型不匹配</li>
- <li>2009 - 信令服务器地址错误</li>
- </ul>
- <p>流相关错误及代码</p>
- <ul>
- <li>3000 - 流不存在</li>
- <li>3001 - 同类型的流已存在</li>
- <li>3002 - 音频不存在</li>
- <li>3003 - 视频不存在</li>
- <li>3004 - [中止错误] 尽管用户和操作系统都授予了访问设备硬件的权利,而且未出现可能抛出NotReadableError异常的硬件问题,但仍然有一些问题的出现导致了设备无法被使用。</li>
- <li>3005 - [拒绝错误] 用户拒绝了当前的浏览器实例的访问请求;或者用户拒绝了当前会话的访问;或者用户在全局范围内拒绝了所有媒体访问请求。</li>
- <li>3006 - [找不到错误] 找不到满足请求参数的媒体类型。</li>
- <li>3007 - [无法读取错误] 尽管用户已经授权使用相应的设备,操作系统上某个硬件、浏览器或者网页层面发生的错误导致设备无法被访问。</li>
- <li>3008 - [无法满足要求错误] 指定的要求无法被设备满足。</li>
- <li>3009 - 流连接失败</li>
- <li>3010 - 流正在重连</li>
- <li>3011 - 流尚未发布</li>
- <li>3012 - 流正在发布</li>
- <li>3013 - 流正在取消发布</li>
- <li>3014 - 流已经发布</li>
- <li>3015 - 流尚未订阅</li>
- <li>3016 - 流正在订阅</li>
- <li>3017 - 流正在取消订阅</li>
- <li>3018 - 流已经订阅</li>
- <li>3019 - 自动播放被禁止错误</li>
- <li>3020 - 音视频数据异常,未成功播放(一般为网络原因导致,拉流时音视频数据加载过慢)</li>
- <li>3021 - 因未曾调用或调用 play 方法失败,故不可恢复播放</li>
- <li>3024 - ICE 建连失败</li>
- </ul>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="facingmode" class="tsd-anchor"></a>
- <h3>Facing<wbr>Mode</h3>
- <div class="tsd-signature tsd-kind-icon">Facing<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"user"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"environment"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>指定使用前置或后置摄像头,'user'(前置摄像头)或 'environment'(后置摄像头)</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="mediatype" class="tsd-anchor"></a>
- <h3>Media<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Media<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"camera"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"screen"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>流的媒体类型, camera - 主视频流,screen - 辅助视频流,通常是一个屏幕分享流</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="networkquality" class="tsd-anchor"></a>
- <h3>Network<wbr>Quality</h3>
- <div class="tsd-signature tsd-kind-icon">Network<wbr>Quality<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"0"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"5"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"6"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>流的网络质量评分,有 '0' | '1' | '2' | '3' | '4' | '5' | '6'</p>
- <ul>
- <li>'0': 网络质量未知</li>
- <li>'1': 网络质量优秀</li>
- <li>'2': 网络质量良好</li>
- <li>'3': 网络质量一般</li>
- <li>'4': 网络质量较差</li>
- <li>'5': 网络质量糟糕</li>
- <li>'6': 网络连接断开</li>
- </ul>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="playcontrolstype" class="tsd-anchor"></a>
- <h3>Play<wbr>Controls<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Play<wbr>Controls<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"show"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hide"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"auto"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>视频播放时 audio / video 的控制面板的显示模式</p>
- <ul>
- <li>show 模式:一直显示</li>
- <li>hide 模式:一直隐藏</li>
- <li>auto 模式:自动判断</li>
- </ul>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="playervideofittype" class="tsd-anchor"></a>
- <h3>Player<wbr>Video<wbr>Fit<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Player<wbr>Video<wbr>Fit<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"cover"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"contain"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>视频播放时的显示模式</p>
- <ul>
- <li>cover 模式:优先保证视窗被填满。</li>
- <li>contain 模式:优先保证视频内容全部显示。
- 播放摄像头视频流默认使用 cover 模式,屏幕共享视频流默认使用 contain 模式。</li>
- </ul>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="roletype" class="tsd-anchor"></a>
- <h3>Role<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Role<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"audience"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"speaker"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>用户角色,'audience' | 'speaker' 分别为观众,主讲。</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="roomtype" class="tsd-anchor"></a>
- <h3>Room<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Room<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"conference"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"live"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>房间类型:'conference' | 'live',分别对应会议模式 | 直播模式。
- 注:
- 会议模式:房间内用户数较少,各用户均会推流,并拉其他用户的流。
- 直播模式:房间内用户数较多,个别用户会推流,大部分用户只拉流观看。</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcconnectionstateevent" class="tsd-anchor"></a>
- <h3>Rtc<wbr>Connection<wbr>State<wbr>Event</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Connection<wbr>State<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type" data-tsd-kind="Interface">RtcEvent</a><span class="tsd-signature-symbol"><</span><a href="index.html#rtcconnectionstateeventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcConnectionStateEventType</a><span class="tsd-signature-symbol">, </span><a href="interfaces/connectionstates.html" class="tsd-signature-type" data-tsd-kind="Interface">ConnectionStates</a><span class="tsd-signature-symbol">></span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Rtc 连接状态事件,事件类型参见 <a href="index.html#rtcconnectionstateeventtype">RtcConnectionStateEventType</a></p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcconnectionstateeventtype" class="tsd-anchor"></a>
- <h3>Rtc<wbr>Connection<wbr>State<wbr>Event<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Connection<wbr>State<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"connection-state-changed"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Rtc 客户端连接状态事件类型:</p>
- </div>
- <p><a href="index.html#rtcconnectionstateevent">连接状态事件</a></p>
- <ul>
- <li>connection-state-changed - 连接状态改变</li>
- </ul>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'connection-state-changed'</span><span style="color: #000000">, (</span><span style="color: #001080">event</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">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #000000FF">.</span><span style="color: #001080">previous</span><span style="color: #0000FF">}</span><span style="color: #A31515"> => </span><span style="color: #0000FF">${</span><span style="color: #001080">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #000000FF">.</span><span style="color: #001080">current</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>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcdevicechangedevent" class="tsd-anchor"></a>
- <h3>Rtc<wbr>Device<wbr>Changed<wbr>Event</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Device<wbr>Changed<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type" data-tsd-kind="Interface">RtcEvent</a><span class="tsd-signature-symbol"><</span><a href="index.html#rtcdevicechangedeventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcDeviceChangedEventType</a><span class="tsd-signature-symbol">, </span><a href="interfaces/devicechangedeventdata.html" class="tsd-signature-type" data-tsd-kind="Interface">DeviceChangedEventData</a><span class="tsd-signature-symbol">></span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Rtc 设备列表变化事件,事件类型参见 {@link RtcDeviceChangeEventType}</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcdevicechangedeventtype" class="tsd-anchor"></a>
- <h3>Rtc<wbr>Device<wbr>Changed<wbr>Event<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Device<wbr>Changed<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"device-changed"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>设备变化事件</p>
- <ul>
- <li>device-changed - 设备变化(新增或移除)</li>
- </ul>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'device-changed'</span><span style="color: #000000">, (</span><span style="color: #001080">event</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">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #000000FF">.</span><span style="color: #001080">type</span><span style="color: #0000FF">}</span><span style="color: #A31515"> 设备已 </span><span style="color: #0000FF">${</span><span style="color: #001080">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #000000FF">.</span><span style="color: #001080">status</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>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcerrorevent" class="tsd-anchor"></a>
- <h3>Rtc<wbr>Error<wbr>Event</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Error<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type" data-tsd-kind="Interface">RtcEvent</a><span class="tsd-signature-symbol"><</span><a href="index.html#rtcerroreventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcErrorEventType</a><span class="tsd-signature-symbol">, </span><a href="classes/rtcerror.html" class="tsd-signature-type" data-tsd-kind="Class">RtcError</a><span class="tsd-signature-symbol">></span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Rtc 错误事件,事件类型参见 <a href="index.html#rtcerroreventtype">RtcErrorEventType</a></p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcerroreventtype" class="tsd-anchor"></a>
- <h3>Rtc<wbr>Error<wbr>Event<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Error<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"error"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>错误事件</p>
- <ul>
- <li>error - 错误事件,当出现不可恢复错误后,会抛出此事件</li>
- </ul>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'error'</span><span style="color: #000000">, (</span><span style="color: #001080">event</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">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #000000FF">.</span><span style="color: #001080">code</span><span style="color: #0000FF">}</span><span style="color: #A31515">] - </span><span style="color: #0000FF">${</span><span style="color: #001080">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #000000FF">.</span><span style="color: #001080">message</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>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtceventtype" class="tsd-anchor"></a>
- <h3>Rtc<wbr>Event<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="index.html#rtcusereventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcUserEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcstreameventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcStreamEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcconnectionstateeventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcConnectionStateEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcnetworkqualityeventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcNetworkQualityEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcplayereventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcPlayerEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcdevicechangedeventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcDeviceChangedEventType</a><span class="tsd-signature-symbol"> | </span><a href="index.html#rtcerroreventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcErrorEventType</a></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Rtc 事件类型</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcnetworkqualityevent" class="tsd-anchor"></a>
- <h3>Rtc<wbr>Network<wbr>Quality<wbr>Event</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Network<wbr>Quality<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type" data-tsd-kind="Interface">RtcEvent</a><span class="tsd-signature-symbol"><</span><a href="index.html#rtcnetworkqualityeventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcNetworkQualityEventType</a><span class="tsd-signature-symbol">, </span><a href="interfaces/networkqualities.html" class="tsd-signature-type" data-tsd-kind="Interface">NetworkQualities</a><span class="tsd-signature-symbol">></span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Rtc 网络连接质量事件,事件类型参见 <a href="index.html#rtcnetworkqualityeventtype">RtcNetworkQualityEventType</a></p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcnetworkqualityeventtype" class="tsd-anchor"></a>
- <h3>Rtc<wbr>Network<wbr>Quality<wbr>Event<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Network<wbr>Quality<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"network-quality"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Rtc 网络连接质量类型:</p>
- </div>
- <p><a href="index.html#rtcnetworkqualityevent">网络连接质量事件</a></p>
- <ul>
- <li>network-quality - 上/下行网络质量</li>
- </ul>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'network-quality'</span><span style="color: #000000">, (</span><span style="color: #001080">event</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">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #000000FF">.</span><span style="color: #001080">uplink</span><span style="color: #0000FF">}</span><span style="color: #A31515"> / </span><span style="color: #0000FF">${</span><span style="color: #001080">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #000000FF">.</span><span style="color: #001080">downlink</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>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcplayerevent" class="tsd-anchor"></a>
- <h3>Rtc<wbr>Player<wbr>Event</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Player<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type" data-tsd-kind="Interface">RtcEvent</a><span class="tsd-signature-symbol"><</span><a href="index.html#rtcplayereventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcPlayerEventType</a><span class="tsd-signature-symbol">, </span><a href="interfaces/playereventdata.html" class="tsd-signature-type" data-tsd-kind="Interface">PlayerEventData</a><span class="tsd-signature-symbol">></span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Rtc 播放器事件,事件类型参见 <a href="index.html#rtcplayereventtype">RtcPlayerEventType</a></p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcplayereventtype" class="tsd-anchor"></a>
- <h3>Rtc<wbr>Player<wbr>Event<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Player<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"player-status-change"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Rtc 播放器事件类型:</p>
- </div>
- <p><a href="index.html#rtcplayerevent">播放器事件</a></p>
- <ul>
- <li>player-status-change - 流播放器状态改变</li>
- </ul>
- <p><strong>注,此事件需在单条流上进行监听</strong></p>
- <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">on</span><span style="color: #000000">(</span><span style="color: #A31515">'player-status-change'</span><span style="color: #000000">, (</span><span style="color: #001080">event</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">data</span><span style="color: #000000"> } = </span><span style="color: #001080">event</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">type</span><span style="color: #000000">, </span><span style="color: #0070C1">status</span><span style="color: #000000"> } = </span><span style="color: #001080">data</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">`stream's </span><span style="color: #0000FF">${</span><span style="color: #001080">type</span><span style="color: #0000FF">}</span><span style="color: #A31515"> status changed to </span><span style="color: #0000FF">${</span><span style="color: #001080">status</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>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcstreamevent" class="tsd-anchor"></a>
- <h3>Rtc<wbr>Stream<wbr>Event</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Stream<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type" data-tsd-kind="Interface">RtcEvent</a><span class="tsd-signature-symbol"><</span><a href="index.html#rtcstreameventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcStreamEventType</a><span class="tsd-signature-symbol">, </span><a href="classes/stream.html" class="tsd-signature-type" data-tsd-kind="Class">Stream</a><span class="tsd-signature-symbol"> | </span><a href="classes/localstream.html" class="tsd-signature-type" data-tsd-kind="Class">LocalStream</a><span class="tsd-signature-symbol"> | </span><a href="classes/remotestream.html" class="tsd-signature-type" data-tsd-kind="Class">RemoteStream</a><span class="tsd-signature-symbol">></span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Rtc 流事件,事件类型参见 <a href="index.html#rtcstreameventtype">RtcStreamEventType</a></p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcstreameventtype" class="tsd-anchor"></a>
- <h3>Rtc<wbr>Stream<wbr>Event<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>Stream<wbr>Event<wbr>Type<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">"audio-track-ended"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"screen-sharing-stopped"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Rtc 流事件类型:</p>
- </div>
- <p><a href="index.html#rtcstreamevent">流事件</a></p>
- <ul>
- <li>stream-added - 有远端流加入,此时事件中的 data 为 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
- <li>stream-removed - 有远端流移除,此时事件中的 data 为 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
- <li>stream-subscribed - 远端流订阅完成,此时事件中的 data 为 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
- <li>stream-published - 本地流发布完成,此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流</li>
- <li>stream-reconnecting - 流正在重连(本地流重新发布/远端流重新订阅),此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流或 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
- <li>stream-reconnected - 流已重连(本地流已重新发布/远端流已重新订阅),此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流或 <a href="classes/remotestream.html">RemoteStream</a> 远端流</li>
- <li>mute-audio - 流的音频被 mute</li>
- <li>unmute-audio - 流的音频被取消 mute</li>
- <li>mute-video - 流的视频被 mute</li>
- <li>unmute-video - 流的视频被取消 mute</li>
- </ul>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'stream-add'</span><span style="color: #000000">, (</span><span style="color: #001080">event</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">subscribe</span><span style="color: #000000">(</span><span style="color: #001080">event</span><span style="color: #000000">.</span><span style="color: #001080">data</span><span style="color: #000000">);</span>
- <span style="color: #000000">});</span>
- </code></pre>
- <p><strong>特别地,以下事件需在单条流上进行监听</strong></p>
- <ul>
- <li>screen-sharing-stopped - 屏幕共享流被中止,此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流</li>
- <li>audio-track-ended - 音频被中止,此时事件中的 data 为 <a href="classes/localstream.html">LocalStream</a> 本地流</li>
- <li>first-key-frame - 接收到远端流的首帧</li>
- </ul>
- </dd>
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #001080">localStream</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'screen-sharing-stopped'</span><span style="color: #000000">, (</span><span style="color: #001080">event</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
- <span style="color: #000000"> </span><span style="color: #008000">// 此事件只针对本地流有效,若本地流已发布,监听到此事件后,可以决定要不要取消发布</span>
- <span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">unpublish</span><span style="color: #000000">(</span><span style="color: #001080">event</span><span style="color: #000000">.</span><span style="color: #001080">data</span><span style="color: #000000">);</span>
- <span style="color: #000000"> </span><span style="color: #001080">event</span><span style="color: #000000">.</span><span style="color: #001080">data</span><span style="color: #000000">.</span><span style="color: #795E26">destroy</span><span style="color: #000000">();</span>
- <span style="color: #000000">});</span>
- </code></pre>
- </dd>
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #001080">stream</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'first-key-frame'</span><span style="color: #000000">, (</span><span style="color: #001080">event</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">`stream </span><span style="color: #0000FF">${</span><span style="color: #001080">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #0000FF">}</span><span style="color: #A31515"> got first key frame`</span><span style="color: #000000">);</span>
- <span style="color: #000000">});</span>
- </code></pre>
- </dd>
- </dl>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcuserevent" class="tsd-anchor"></a>
- <h3>Rtc<wbr>User<wbr>Event</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>User<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="interfaces/rtcevent.html" class="tsd-signature-type" data-tsd-kind="Interface">RtcEvent</a><span class="tsd-signature-symbol"><</span><a href="index.html#rtcusereventtype" class="tsd-signature-type" data-tsd-kind="Type alias">RtcUserEventType</a><span class="tsd-signature-symbol">, </span><a href="classes/user.html" class="tsd-signature-type" data-tsd-kind="Class">User</a><span class="tsd-signature-symbol">></span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Rtc 用户事件,事件类型参见 <a href="index.html#rtcusereventtype">RtcUserEventType</a></p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="rtcusereventtype" class="tsd-anchor"></a>
- <h3>Rtc<wbr>User<wbr>Event<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Rtc<wbr>User<wbr>Event<wbr>Type<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></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Rtc 用户事件类型:</p>
- </div>
- <p><a href="index.html#rtcuserevent">用户事件</a></p>
- <ul>
- <li>user-joined - 有用户加入房间</li>
- <li>user-left - 有用户离开房间</li>
- <li>kick-off - 当前用户被踢出房间</li>
- </ul>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'user-joined'</span><span style="color: #000000">, (</span><span style="color: #001080">event</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">event</span><span style="color: #000000FF">.</span><span style="color: #001080">data</span><span style="color: #000000FF">.</span><span style="color: #001080">id</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>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="screenprofile" class="tsd-anchor"></a>
- <h3>Screen<wbr>Profile</h3>
- <div class="tsd-signature tsd-kind-icon">Screen<wbr>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">"480p_2"</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></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>预设的屏幕共享视频 Profile</p>
- </div>
- <table>
- <thead>
- <tr>
- <th align="center">名称</th>
- <th align="center">视频宽</th>
- <th align="center">视频高</th>
- <th align="center">帧率 (fps)</th>
- <th align="center">码率 (kbps)</th>
- </tr>
- </thead>
- <tbody><tr>
- <td align="center">480p</td>
- <td align="center">640</td>
- <td align="center">480</td>
- <td align="center">5</td>
- <td align="center">600</td>
- </tr>
- <tr>
- <td align="center">480p_2</td>
- <td align="center">640</td>
- <td align="center">480</td>
- <td align="center">30</td>
- <td align="center">1000</td>
- </tr>
- <tr>
- <td align="center">720p</td>
- <td align="center">1280</td>
- <td align="center">720</td>
- <td align="center">5</td>
- <td align="center">1000</td>
- </tr>
- <tr>
- <td align="center">720p_2</td>
- <td align="center">1280</td>
- <td align="center">720</td>
- <td align="center">30</td>
- <td align="center">2000</td>
- </tr>
- <tr>
- <td align="center">1080p</td>
- <td align="center">1920</td>
- <td align="center">1080</td>
- <td align="center">5</td>
- <td align="center">1500</td>
- </tr>
- <tr>
- <td align="center">1080p_2</td>
- <td align="center">1920</td>
- <td align="center">1080</td>
- <td align="center">30</td>
- <td align="center">2500</td>
- </tr>
- </tbody></table>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="switchdevicetype" class="tsd-anchor"></a>
- <h3>Switch<wbr>Device<wbr>Type</h3>
- <div class="tsd-signature tsd-kind-icon">Switch<wbr>Device<wbr>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></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>切换设备的类型</p>
- </div>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="videocodec" class="tsd-anchor"></a>
- <h3>Video<wbr>Codec</h3>
- <div class="tsd-signature tsd-kind-icon">Video<wbr>Codec<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"vp8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"h264"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"h265"</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>视频编解码格式</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>note</dt>
- <dd><p>'h265' 目前仅部分浏览器在开启试验性功能时才支持,如 Safari 开启 <code>WebRTC H265 codec</code></p>
- </dd>
- </dl>
- </div>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
- <a name="videoprofile" class="tsd-anchor"></a>
- <h3>Video<wbr>Profile</h3>
- <div class="tsd-signature tsd-kind-icon">Video<wbr>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></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>预设的视频 Profile</p>
- </div>
- <table>
- <thead>
- <tr>
- <th align="center">名称</th>
- <th align="center">视频宽</th>
- <th align="center">视频高</th>
- <th align="center">帧率 (fps)</th>
- <th align="center">码率 (kbps)</th>
- </tr>
- </thead>
- <tbody><tr>
- <td align="center">180p</td>
- <td align="center">240</td>
- <td align="center">180</td>
- <td align="center">15</td>
- <td align="center">200</td>
- </tr>
- <tr>
- <td align="center">180p_2</td>
- <td align="center">320</td>
- <td align="center">180</td>
- <td align="center">15</td>
- <td align="center">300</td>
- </tr>
- <tr>
- <td align="center">240p</td>
- <td align="center">320</td>
- <td align="center">240</td>
- <td align="center">15</td>
- <td align="center">400</td>
- </tr>
- <tr>
- <td align="center">360p</td>
- <td align="center">480</td>
- <td align="center">360</td>
- <td align="center">15</td>
- <td align="center">400</td>
- </tr>
- <tr>
- <td align="center">360p_2</td>
- <td align="center">640</td>
- <td align="center">360</td>
- <td align="center">15</td>
- <td align="center">500</td>
- </tr>
- <tr>
- <td align="center">480p</td>
- <td align="center">640</td>
- <td align="center">480</td>
- <td align="center">15</td>
- <td align="center">600</td>
- </tr>
- <tr>
- <td align="center">720p</td>
- <td align="center">1280</td>
- <td align="center">720</td>
- <td align="center">15</td>
- <td align="center">1000</td>
- </tr>
- <tr>
- <td align="center">720p_2</td>
- <td align="center">1280</td>
- <td align="center">720</td>
- <td align="center">15</td>
- <td align="center">1500</td>
- </tr>
- <tr>
- <td align="center">720p_3</td>
- <td align="center">1280</td>
- <td align="center">720</td>
- <td align="center">30</td>
- <td align="center">2000</td>
- </tr>
- <tr>
- <td align="center">1080p</td>
- <td align="center">1920</td>
- <td align="center">1080</td>
- <td align="center">15</td>
- <td align="center">1500</td>
- </tr>
- <tr>
- <td align="center">1080p_2</td>
- <td align="center">1920</td>
- <td align="center">1080</td>
- <td align="center">15</td>
- <td align="center">2000</td>
- </tr>
- <tr>
- <td align="center">1080p_3</td>
- <td align="center">1920</td>
- <td align="center">1080</td>
- <td align="center">30</td>
- <td align="center">2500</td>
- </tr>
- </tbody></table>
- </div>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Variables</h2>
- <section class="tsd-panel tsd-member tsd-kind-variable">
- <a name="version" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagConst">Const</span> version</h3>
- <div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></div>
- <aside class="tsd-sources">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>当前 sdk 的版本号</p>
- </div>
- </div>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Functions</h2>
- <section class="tsd-panel tsd-member tsd-kind-function">
- <a name="createclient" class="tsd-anchor"></a>
- <h3>create<wbr>Client</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">create<wbr>Client<span class="tsd-signature-symbol">(</span>appId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><a href="interfaces/clientoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></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">client</span><span style="color: #000000"> = </span><span style="color: #795E26">createClient</span><span style="color: #000000">(</span><span style="color: #A31515">'AppID'</span><span style="color: #000000">);</span>
- <span style="color: #001080">client</span>
- <span style="color: #000000"> .</span><span style="color: #795E26">join</span><span style="color: #000000">(</span><span style="color: #A31515">'roomId'</span><span style="color: #000000">, </span><span style="color: #A31515">'userId'</span><span style="color: #000000">, </span><span style="color: #A31515">'token'</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">localStream</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>throws</dt>
- <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>appId: <span class="tsd-signature-type">string</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>应用 ID,可在控制台查看</p>
- </div>
- </li>
- <li>
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <a href="interfaces/clientoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientOptions</a></h5>
- <div class="tsd-comment tsd-typography">
- <p>定义客户端的属性</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <a href="classes/client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-function">
- <a name="createstream" class="tsd-anchor"></a>
- <h3>create<wbr>Stream</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">create<wbr>Stream<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">: </span><a href="interfaces/localstreamoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LocalStreamOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/localstream.html" class="tsd-signature-type" data-tsd-kind="Class">LocalStream</a></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">localStream</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">localStream</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">localStream</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: #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>
- <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>throws</dt>
- <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>opts: <a href="interfaces/localstreamoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LocalStreamOptions</a></h5>
- <div class="tsd-comment tsd-typography">
- <p>必传,定义本地音视频流的属性
- 注:</p>
- <ol>
- <li>video, screen 不可同时为 true</li>
- <li>audio, video, screen 不可同时为 false</li>
- <li>若指定了 file,则 init 时将优先使用 file 来创建初始化本地流的视频</li>
- <li>screenAudio 在不同浏览器上表现不同,参见 <a href="interfaces/localstreamoptions.html">LocalStreamOptions</a></li>
- </ol>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <a href="classes/localstream.html" class="tsd-signature-type" data-tsd-kind="Class">LocalStream</a></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-function">
- <a name="devicedetection" class="tsd-anchor"></a>
- <h3>device<wbr>Detection</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">device<wbr>Detection<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="interfaces/devicedetectionoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DeviceDetectionOptions</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">
- </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">deviceDetection</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: #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="classes/rtcerror.html">RtcError</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <a href="interfaces/devicedetectionoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DeviceDetectionOptions</a></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-function">
- <a name="disableuploadlog" class="tsd-anchor"></a>
- <h3>disable<wbr>Upload<wbr>Log</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">disable<wbr>Upload<wbr>Log<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: #795E26">disableUploadLog</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-function">
- <a name="enableuploadlog" class="tsd-anchor"></a>
- <h3>enable<wbr>Upload<wbr>Log</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">enable<wbr>Upload<wbr>Log<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: #795E26">enableUploadLog</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-function">
- <a name="generatetoken" class="tsd-anchor"></a>
- <h3>generate<wbr>Token</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">generate<wbr>Token<span class="tsd-signature-symbol">(</span>appId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, appKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, roomId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, userId<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">string</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>根据 AppId,AppKey,RoomId,UserId 生成 token,用于开发阶段临时快速的加入房间并验证功能,由于 AppKey 不可暴露于公网,因此生产环境中不建议使用此方法生成 token。</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">token</span><span style="color: #000000"> = </span><span style="color: #795E26">generateToken</span><span style="color: #000000">(</span><span style="color: #A31515">'appId'</span><span style="color: #000000">, </span><span style="color: #A31515">'appKey'</span><span style="color: #000000">, </span><span style="color: #A31515">'roomId'</span><span style="color: #000000">, </span><span style="color: #A31515">'userId'</span><span style="color: #000000">);</span>
- <span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">join</span><span style="color: #000000">(</span><span style="color: #A31515">'roomId'</span><span style="color: #000000">, </span><span style="color: #A31515">'userId'</span><span style="color: #000000">, </span><span style="color: #001080">token</span><span style="color: #000000">);</span>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>appId: <span class="tsd-signature-type">string</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>应用 ID,可在控制台查看</p>
- </div>
- </li>
- <li>
- <h5>appKey: <span class="tsd-signature-type">string</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>应用密钥,可在控制台查看</p>
- </div>
- </li>
- <li>
- <h5>roomId: <span class="tsd-signature-type">string</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>房间 ID</p>
- </div>
- </li>
- <li>
- <h5>userId: <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">string</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-function">
- <a name="getcameras" class="tsd-anchor"></a>
- <h3>get<wbr>Cameras</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">get<wbr>Cameras<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">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</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>获取摄像头设备列表,点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #795E26">getCameras</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">devices</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">devices</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="classes/rtcerror.html">RtcError</a></p>
- </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">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-function">
- <a name="getdevices" class="tsd-anchor"></a>
- <h3>get<wbr>Devices</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">get<wbr>Devices<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">?: </span><a href="interfaces/getdevicesoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetDevicesOptions</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">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</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>获取音视频输入/输出设备列表,点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #795E26">getDevices</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">devices</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">devices</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="classes/rtcerror.html">RtcError</a></p>
- </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/getdevicesoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetDevicesOptions</a></h5>
- </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">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-function">
- <a name="getloudspeakers" class="tsd-anchor"></a>
- <h3>get<wbr>Loudspeakers</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">get<wbr>Loudspeakers<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">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</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>获取扬声器设备列表,点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #795E26">getLoudspeakers</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">devices</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">devices</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="classes/rtcerror.html">RtcError</a></p>
- </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">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-function">
- <a name="getmicrophones" class="tsd-anchor"></a>
- <h3>get<wbr>Microphones</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">get<wbr>Microphones<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">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</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>获取麦克风设备列表,点击 <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo">MediaDeviceInfo</a> 查看详情</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #795E26">getMicrophones</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">devices</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">devices</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="classes/rtcerror.html">RtcError</a></p>
- </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">MediaDeviceInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-function">
- <a name="getsupportedcodec" class="tsd-anchor"></a>
- <h3>get<wbr>Supported<wbr>Codec</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">get<wbr>Supported<wbr>Codec<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/codecs.html" class="tsd-signature-type" data-tsd-kind="Interface">Codecs</a><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: #795E26">getSupportedCodec</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">codecs</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">codecs</span><span style="color: #000000FF">.</span><span style="color: #001080">audio</span><span style="color: #0000FF">}</span><span style="color: #A31515">,视频编解码格式有 </span><span style="color: #0000FF">${</span><span style="color: #001080">codecs</span><span style="color: #000000FF">.</span><span style="color: #001080">video</span><span style="color: #0000FF">}</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>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/codecs.html" class="tsd-signature-type" data-tsd-kind="Interface">Codecs</a><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-function">
- <a name="issupportscreenshare" class="tsd-anchor"></a>
- <h3>is<wbr>Support<wbr>Screen<wbr>Share</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">is<wbr>Support<wbr>Screen<wbr>Share<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">
- </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: #AF00DB">if</span><span style="color: #000000"> (!</span><span style="color: #795E26">isSupportScreenShare</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>
- </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-function">
- <a name="issupportwebrtc" class="tsd-anchor"></a>
- <h3>is<wbr>Support<wbr>WebRTC</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">is<wbr>Support<wbr>WebRTC<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">
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>检测浏览器是否完全(可访问本地音视频设备)支持 WebRTC。</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #AF00DB">if</span><span style="color: #000000"> (!</span><span style="color: #795E26">isSupportWebRTC</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">`当前浏览器不完全支持 WebRTC,建议使用 Chrome 浏览器,iOS 系统建议使用 Safari 浏览器`</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">boolean</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-function">
- <a name="setloglevel" class="tsd-anchor"></a>
- <h3>set<wbr>Log<wbr>Level</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Log<wbr>Level<span class="tsd-signature-symbol">(</span>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LogLevel</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>设置日志打印级别,用于打印出更多日志来调试或定位问题,默认 warn 级别</p>
- </div>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><pre><code class="language-js"><span style="color: #795E26">setLogLevel</span><span style="color: #000000">(</span><span style="color: #A31515">'info'</span><span style="color: #000000">);</span>
- </code></pre>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>level: <span class="tsd-signature-type">LogLevel</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>日志级别,有 'debug', 'info', 'warn', 'error' 级别;</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-function">
- <a name="setservers" class="tsd-anchor"></a>
- <h3>set<wbr>Servers</h3>
- <ul class="tsd-signatures tsd-kind-function">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Servers<span class="tsd-signature-symbol">(</span>conf<span class="tsd-signature-symbol">: </span><a href="interfaces/serverconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerConfig</a><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: #795E26">setServers</span><span style="color: #000000">({</span>
- <span style="color: #000000"> </span><span style="color: #001080">gateway:</span><span style="color: #000000"> </span><span style="color: #A31515">'https://my-rtc.com'</span><span style="color: #000000">, </span><span style="color: #008000">// 指定网关</span>
- <span style="color: #000000"> </span><span style="color: #001080">log:</span><span style="color: #000000"> </span><span style="color: #A31515">'https://log.my-rtc.com'</span><span style="color: #000000">, </span><span style="color: #008000">// 指定日志服务器</span>
- <span style="color: #000000">});</span>
- </code></pre>
- <p><strong>特别地,单信令服务器时,不需要网关进行分配信令服务器,可以直接指定信令服务器</strong></p>
- <pre><code class="language-js"><span style="color: #795E26">setServers</span><span style="color: #000000">({</span>
- <span style="color: #000000"> </span><span style="color: #001080">signal:</span><span style="color: #000000"> </span><span style="color: #A31515">'wss://my-rtc.com:5005'</span><span style="color: #000000">, </span><span style="color: #008000">// 直接指定信令服务器</span>
- <span style="color: #000000"> </span><span style="color: #001080">log:</span><span style="color: #000000"> </span><span style="color: #A31515">'https://log.my-rtc.com'</span><span style="color: #000000">, </span><span style="color: #008000">// 指定日志服务器</span>
- <span style="color: #000000">});</span>
- </code></pre>
- </dd>
- <dt>throws</dt>
- <dd><p><a href="classes/rtcerror.html">RtcError</a></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>conf: <a href="interfaces/serverconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerConfig</a></h5>
- <div class="tsd-comment tsd-typography">
- <p>服务器配置,具体描述参见 ServerConfig 的说明</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="current ">
- <a href="index.html">Exports</a>
- </li>
- </ul>
- </nav>
- <nav class="tsd-navigation secondary menu-sticky">
- <ul class="before-current">
- <li class=" tsd-kind-class">
- <a href="classes/client.html" class="tsd-kind-icon">Client</a>
- </li>
- <li class=" tsd-kind-class">
- <a href="classes/localstream.html" class="tsd-kind-icon">Local<wbr>Stream</a>
- </li>
- <li class=" tsd-kind-class">
- <a href="classes/remotestream.html" class="tsd-kind-icon">Remote<wbr>Stream</a>
- </li>
- <li class=" tsd-kind-class">
- <a href="classes/rtcerror.html" class="tsd-kind-icon">Rtc<wbr>Error</a>
- </li>
- <li class=" tsd-kind-class">
- <a href="classes/stream.html" class="tsd-kind-icon">Stream</a>
- </li>
- <li class=" tsd-kind-class">
- <a href="classes/user.html" class="tsd-kind-icon">User</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/audiostats.html" class="tsd-kind-icon">Audio<wbr>Stats</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/clientoptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/clientplugin.html" class="tsd-kind-icon">Client<wbr>Plugin</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/codecs.html" class="tsd-kind-icon">Codecs</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/connectionstates.html" class="tsd-kind-icon">Connection<wbr>States</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/devicechangedeventdata.html" class="tsd-kind-icon">Device<wbr>Changed<wbr>Event<wbr>Data</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/devicedetectionoptions.html" class="tsd-kind-icon">Device<wbr>Detection<wbr>Options</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/getdevicesoptions.html" class="tsd-kind-icon">Get<wbr>Devices<wbr>Options</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/joinoptions.html" class="tsd-kind-icon">Join<wbr>Options</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/localstreamoptions.html" class="tsd-kind-icon">Local<wbr>Stream<wbr>Options</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/networkqualities.html" class="tsd-kind-icon">Network<wbr>Qualities</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/networkstats.html" class="tsd-kind-icon">Network<wbr>Stats</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/playoptions.html" class="tsd-kind-icon">Play<wbr>Options</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/playereventdata.html" class="tsd-kind-icon">Player<wbr>Event<wbr>Data</a>
- </li>
- <li class=" tsd-kind-interface tsd-has-type-parameter">
- <a href="interfaces/rtcevent.html" class="tsd-kind-icon">Rtc<wbr>Event</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/serverconfig.html" class="tsd-kind-icon">Server<wbr>Config</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/snapshotoptions.html" class="tsd-kind-icon">Snapshot<wbr>Options</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/streamplugin.html" class="tsd-kind-icon">Stream<wbr>Plugin</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/streamstats.html" class="tsd-kind-icon">Stream<wbr>Stats</a>
- </li>
- <li class=" tsd-kind-interface">
- <a href="interfaces/videostats.html" class="tsd-kind-icon">Video<wbr>Stats</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#audiocodec" class="tsd-kind-icon">Audio<wbr>Codec</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#connectionstate" class="tsd-kind-icon">Connection<wbr>State</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#errorcode" class="tsd-kind-icon">Error<wbr>Code</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#facingmode" class="tsd-kind-icon">Facing<wbr>Mode</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#mediatype" class="tsd-kind-icon">Media<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#networkquality" class="tsd-kind-icon">Network<wbr>Quality</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#playcontrolstype" class="tsd-kind-icon">Play<wbr>Controls<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#playervideofittype" class="tsd-kind-icon">Player<wbr>Video<wbr>Fit<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#roletype" class="tsd-kind-icon">Role<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#roomtype" class="tsd-kind-icon">Room<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcconnectionstateevent" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>State<wbr>Event</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcconnectionstateeventtype" class="tsd-kind-icon">Rtc<wbr>Connection<wbr>State<wbr>Event<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcdevicechangedevent" class="tsd-kind-icon">Rtc<wbr>Device<wbr>Changed<wbr>Event</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcdevicechangedeventtype" class="tsd-kind-icon">Rtc<wbr>Device<wbr>Changed<wbr>Event<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcerrorevent" class="tsd-kind-icon">Rtc<wbr>Error<wbr>Event</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcerroreventtype" class="tsd-kind-icon">Rtc<wbr>Error<wbr>Event<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtceventtype" class="tsd-kind-icon">Rtc<wbr>Event<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcnetworkqualityevent" class="tsd-kind-icon">Rtc<wbr>Network<wbr>Quality<wbr>Event</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcnetworkqualityeventtype" class="tsd-kind-icon">Rtc<wbr>Network<wbr>Quality<wbr>Event<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcplayerevent" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcplayereventtype" class="tsd-kind-icon">Rtc<wbr>Player<wbr>Event<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcstreamevent" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcstreameventtype" class="tsd-kind-icon">Rtc<wbr>Stream<wbr>Event<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcuserevent" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#rtcusereventtype" class="tsd-kind-icon">Rtc<wbr>User<wbr>Event<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#screenprofile" class="tsd-kind-icon">Screen<wbr>Profile</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#switchdevicetype" class="tsd-kind-icon">Switch<wbr>Device<wbr>Type</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#videocodec" class="tsd-kind-icon">Video<wbr>Codec</a>
- </li>
- <li class=" tsd-kind-type-alias">
- <a href="index.html#videoprofile" class="tsd-kind-icon">Video<wbr>Profile</a>
- </li>
- <li class=" tsd-kind-variable">
- <a href="index.html#version" class="tsd-kind-icon">version</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#createclient" class="tsd-kind-icon">create<wbr>Client</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#createstream" class="tsd-kind-icon">create<wbr>Stream</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#devicedetection" class="tsd-kind-icon">device<wbr>Detection</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#disableuploadlog" class="tsd-kind-icon">disable<wbr>Upload<wbr>Log</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#enableuploadlog" class="tsd-kind-icon">enable<wbr>Upload<wbr>Log</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#getcameras" class="tsd-kind-icon">get<wbr>Cameras</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#getdevices" class="tsd-kind-icon">get<wbr>Devices</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#getloudspeakers" class="tsd-kind-icon">get<wbr>Loudspeakers</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#getmicrophones" class="tsd-kind-icon">get<wbr>Microphones</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#getsupportedcodec" class="tsd-kind-icon">get<wbr>Supported<wbr>Codec</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#issupportscreenshare" class="tsd-kind-icon">is<wbr>Support<wbr>Screen<wbr>Share</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#issupportwebrtc" class="tsd-kind-icon">is<wbr>Support<wbr>WebRTC</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#setloglevel" class="tsd-kind-icon">set<wbr>Log<wbr>Level</a>
- </li>
- <li class=" tsd-kind-function">
- <a href="index.html#setservers" class="tsd-kind-icon">set<wbr>Servers</a>
- </li>
- </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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
- <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-interface"><span class="tsd-kind-icon">Property</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>
- </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>
|