123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750 |
- <!doctype html>
- <html class="default no-js">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <title>RtcEngine | react-native-agora</title>
- <meta name="description" content="">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <link rel="stylesheet" href="../assets/css/main.css">
- </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.js" 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">react-native-agora</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>
- <input type="checkbox" id="tsd-filter-only-exported" />
- <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
- </div>
- </div>
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
- </div>
- </div>
- </div>
- </div>
- <div class="tsd-page-title">
- <div class="container">
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../globals.html">Globals</a>
- </li>
- <li>
- <a href="rtcengine.html">RtcEngine</a>
- </li>
- </ul>
- <h1>Class RtcEngine</h1>
- </div>
- </div>
- </header>
- <div class="container container-main">
- <div class="row">
- <div class="col-8 col-content">
- <section class="tsd-panel tsd-comment">
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>RtcEngine is the javascript object for control agora native sdk through react native bridge.</p>
- </div>
- <p>You can use the RtcEngine methods to create <a href="rtcengine.html#init">init</a></p>
- <p>Other methods of the RtcEngine object serve for agora native sdk and set up error logging.</p>
- </div>
- </section>
- <section class="tsd-panel tsd-hierarchy">
- <h3>Hierarchy</h3>
- <ul class="tsd-hierarchy">
- <li>
- <span class="target">RtcEngine</span>
- </li>
- </ul>
- </section>
- <section class="tsd-panel-group tsd-index-group">
- <h2>Index</h2>
- <section class="tsd-panel tsd-index-panel">
- <div class="tsd-index-content">
- <section class="tsd-index-section tsd-is-private tsd-is-private-protected">
- <h3>Properties</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="rtcengine.html#eventtypes" class="tsd-kind-icon">event<wbr>Types</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Methods</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#addinjectstreamurl" class="tsd-kind-icon">add<wbr>Inject<wbr>Stream<wbr>Url</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#addpublishstreamurl" class="tsd-kind-icon">add<wbr>Publish<wbr>Stream<wbr>Url</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#addvideowatermark" class="tsd-kind-icon">add<wbr>Video<wbr>Watermark</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#adjustaudiomixingplayoutvolume" class="tsd-kind-icon">adjust<wbr>Audio<wbr>Mixing<wbr>Playout<wbr>Volume</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#adjustaudiomixingpublishvolume" class="tsd-kind-icon">adjust<wbr>Audio<wbr>Mixing<wbr>Publish<wbr>Volume</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#adjustaudiomixingvolume" class="tsd-kind-icon">adjust<wbr>Audio<wbr>Mixing<wbr>Volume</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#adjustplaybacksignalvolume" class="tsd-kind-icon">adjust<wbr>Playback<wbr>Signal<wbr>Volume</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#adjustrecordingsignalvolume" class="tsd-kind-icon">adjust<wbr>Recording<wbr>Signal<wbr>Volume</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#createdatastream" class="tsd-kind-icon">create<wbr>Data<wbr>Stream</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#destroy" class="tsd-kind-icon">destroy</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#disableaudio" class="tsd-kind-icon">disable<wbr>Audio</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#disablelastmiletest" class="tsd-kind-icon">disable<wbr>Lastmile<wbr>Test</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#disablelocalaudio" class="tsd-kind-icon">disable<wbr>Local<wbr>Audio</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#disablevideo" class="tsd-kind-icon">disable<wbr>Video</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#enableaudio" class="tsd-kind-icon">enable<wbr>Audio</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#enableaudiovolumeindication" class="tsd-kind-icon">enable<wbr>Audio<wbr>Volume<wbr>Indication</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#enabledualstreammode" class="tsd-kind-icon">enable<wbr>Dual<wbr>Stream<wbr>Mode</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#enableinearmonitoring" class="tsd-kind-icon">enable<wbr>InEar<wbr>Monitoring</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#enablelastmiletest" class="tsd-kind-icon">enable<wbr>Lastmile<wbr>Test</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#enablelocalaudio" class="tsd-kind-icon">enable<wbr>Local<wbr>Audio</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#enablelocalvideo" class="tsd-kind-icon">enable<wbr>Local<wbr>Video</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#enablevideo" class="tsd-kind-icon">enable<wbr>Video</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#enablewebsdkinteroperability" class="tsd-kind-icon">enable<wbr>Web<wbr>Sdk<wbr>Interoperability</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#getaudiomixingcurrentposition" class="tsd-kind-icon">get<wbr>Audio<wbr>Mixing<wbr>Current<wbr>Position</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#getaudiomixingduration" class="tsd-kind-icon">get<wbr>Audio<wbr>Mixing<wbr>Duration</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#getcallid" class="tsd-kind-icon">get<wbr>Call<wbr>Id</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#getcameramaxzoomfactor" class="tsd-kind-icon">get<wbr>Camera<wbr>Max<wbr>Zoom<wbr>Factor</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#getconnectionstate" class="tsd-kind-icon">get<wbr>Connection<wbr>State</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#geteffectsvolume" class="tsd-kind-icon">get<wbr>Effects<wbr>Volume</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#getsdkversion" class="tsd-kind-icon">get<wbr>Sdk<wbr>Version</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#init" class="tsd-kind-icon">init</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#iscameraautofocusfacemodesupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Auto<wbr>Focus<wbr>Face<wbr>Mode<wbr>Supported</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#iscameraexposurepositionsupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Exposure<wbr>Position<wbr>Supported</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#iscamerafocussupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Focus<wbr>Supported</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#iscameratorchsupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Torch<wbr>Supported</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#iscamerazoomsupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Zoom<wbr>Supported</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#joinchannel" class="tsd-kind-icon">join<wbr>Channel</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#leavechannel" class="tsd-kind-icon">leave<wbr>Channel</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#methodisspeakerphoneenabled" class="tsd-kind-icon">methodis<wbr>Speakerphone<wbr>Enabled</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#muteallremoteaudiostreams" class="tsd-kind-icon">mute<wbr>All<wbr>Remote<wbr>Audio<wbr>Streams</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#muteallremotevideostreams" class="tsd-kind-icon">mute<wbr>All<wbr>Remote<wbr>Video<wbr>Streams</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#mutelocalaudiostream" class="tsd-kind-icon">mute<wbr>Local<wbr>Audio<wbr>Stream</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#mutelocalvideostream" class="tsd-kind-icon">mute<wbr>Local<wbr>Video<wbr>Stream</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#muteremoteaudiostream" class="tsd-kind-icon">mute<wbr>Remote<wbr>Audio<wbr>Stream</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#muteremotevideostream" class="tsd-kind-icon">mute<wbr>Remote<wbr>Video<wbr>Stream</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#off" class="tsd-kind-icon">off</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#on" class="tsd-kind-icon">on</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#pausealleffects" class="tsd-kind-icon">pause<wbr>All<wbr>Effects</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#pauseaudiomixing" class="tsd-kind-icon">pause<wbr>Audio<wbr>Mixing</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#pauseeffect" class="tsd-kind-icon">pause<wbr>Effect</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#playeffect" class="tsd-kind-icon">play<wbr>Effect</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#preloadeffect" class="tsd-kind-icon">preload<wbr>Effect</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#removclearvideowatermarkse" class="tsd-kind-icon">removclear<wbr>Video<wbr>Watermarkse</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#removealllisteners" class="tsd-kind-icon">remove<wbr>All<wbr>Listeners</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#removeinjectstreamurl" class="tsd-kind-icon">remove<wbr>Inject<wbr>Stream<wbr>Url</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#removepublishstreamurl" class="tsd-kind-icon">remove<wbr>Publish<wbr>Stream<wbr>Url</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#renewtoken" class="tsd-kind-icon">renew<wbr>Token</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#resumealleffects" class="tsd-kind-icon">resume<wbr>All<wbr>Effects</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#resumeaudiomixing" class="tsd-kind-icon">resume<wbr>Audio<wbr>Mixing</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#resumeeffect" class="tsd-kind-icon">resume<wbr>Effect</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#sendstreammessage" class="tsd-kind-icon">send<wbr>Stream<wbr>Message</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setaudiomixingposition" class="tsd-kind-icon">set<wbr>Audio<wbr>Mixing<wbr>Position</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setaudiosessionoperationrestriction" class="tsd-kind-icon">set<wbr>Audio<wbr>Session<wbr>Operation<wbr>Restriction</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setcameraautofocusfacemodeenabled" class="tsd-kind-icon">set<wbr>Camera<wbr>Auto<wbr>Focus<wbr>Face<wbr>Mode<wbr>Enabled</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setcameraexposureposition" class="tsd-kind-icon">set<wbr>Camera<wbr>Exposure<wbr>Position</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setcamerafocuspositioninpreview" class="tsd-kind-icon">set<wbr>Camera<wbr>Focus<wbr>Position<wbr>InPreview</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setcameratorchon" class="tsd-kind-icon">set<wbr>Camera<wbr>Torch<wbr>On</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setcamerazoomfactor" class="tsd-kind-icon">set<wbr>Camera<wbr>Zoom<wbr>Factor</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setclientrole" class="tsd-kind-icon">set<wbr>Client<wbr>Role</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setdefaultaudioroutetospeakerphone" class="tsd-kind-icon">set<wbr>Default<wbr>Audio<wbr>Route<wbr>ToSpeakerphone</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setdefaultmuteallremoteaudiostreams" class="tsd-kind-icon">set<wbr>Default<wbr>Mute<wbr>All<wbr>Remote<wbr>Audio<wbr>Streams</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setdefaultmuteallremotevideostreams" class="tsd-kind-icon">set<wbr>Default<wbr>Mute<wbr>All<wbr>Remote<wbr>Video<wbr>Streams</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#seteffectsvolume" class="tsd-kind-icon">set<wbr>Effects<wbr>Volume</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setenablespeakerphone" class="tsd-kind-icon">set<wbr>Enable<wbr>Speakerphone</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setinearmonitoringvolume" class="tsd-kind-icon">set<wbr>InEar<wbr>Monitoring<wbr>Volume</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setlivetranscoding" class="tsd-kind-icon">set<wbr>Live<wbr>Transcoding</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setlocalpublishfallbackoption" class="tsd-kind-icon">set<wbr>Local<wbr>Publish<wbr>Fallback<wbr>Option</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setlocalrendermode" class="tsd-kind-icon">set<wbr>Local<wbr>Render<wbr>Mode</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setlocalvideomirrormode" class="tsd-kind-icon">set<wbr>Local<wbr>Video<wbr>Mirror<wbr>Mode</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setlocalvoiceequalization" class="tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Equalization</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setlocalvoicepitch" class="tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Pitch</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setlocalvoicereverb" class="tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Reverb</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setlog" class="tsd-kind-icon">set<wbr>Log</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setmixedaudioframeparameters" class="tsd-kind-icon">set<wbr>Mixed<wbr>Audio<wbr>Frame<wbr>Parameters</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setplaybackaudioframeparameters" class="tsd-kind-icon">set<wbr>Playback<wbr>Audio<wbr>Frame<wbr>Parameters</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setrecordingaudioframeparameters" class="tsd-kind-icon">set<wbr>Recording<wbr>Audio<wbr>Frame<wbr>Parameters</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setremotedefaultvideostreamtype" class="tsd-kind-icon">set<wbr>Remote<wbr>Default<wbr>Video<wbr>Stream<wbr>Type</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setremoterendermode" class="tsd-kind-icon">set<wbr>Remote<wbr>Render<wbr>Mode</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setremotesubscribefallbackoption" class="tsd-kind-icon">set<wbr>Remote<wbr>Subscribe<wbr>Fallback<wbr>Option</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setremotevideostreamtype" class="tsd-kind-icon">set<wbr>Remote<wbr>Video<wbr>Stream<wbr>Type</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setvideoqualityparameters" class="tsd-kind-icon">set<wbr>Video<wbr>Quality<wbr>Parameters</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setvolumeofeffect" class="tsd-kind-icon">set<wbr>Volume<wbr>OfEffect</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setuplocalvideo" class="tsd-kind-icon">setup<wbr>Local<wbr>Video</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setupremotevideo" class="tsd-kind-icon">setup<wbr>Remote<wbr>Video</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#startaudiomixing" class="tsd-kind-icon">start<wbr>Audio<wbr>Mixing</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#startaudiorecording" class="tsd-kind-icon">start<wbr>Audio<wbr>Recording</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#startechotest" class="tsd-kind-icon">start<wbr>Echo<wbr>Test</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#startpreview" class="tsd-kind-icon">start<wbr>Preview</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#stopalleffects" class="tsd-kind-icon">stop<wbr>All<wbr>Effects</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#stopaudiomixing" class="tsd-kind-icon">stop<wbr>Audio<wbr>Mixing</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#stopaudiorecording" class="tsd-kind-icon">stop<wbr>Audio<wbr>Recording</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#stopechotest" class="tsd-kind-icon">stop<wbr>Echo<wbr>Test</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#stopeffect" class="tsd-kind-icon">stop<wbr>Effect</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#stoppreview" class="tsd-kind-icon">stop<wbr>Preview</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#switchcamera" class="tsd-kind-icon">switch<wbr>Camera</a></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#unloadeffect" class="tsd-kind-icon">unload<wbr>Effect</a></li>
- </ul>
- </section>
- </div>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
- <h2>Properties</h2>
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
- <a name="eventtypes" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> event<wbr>Types</h3>
- <div class="tsd-signature tsd-kind-icon">event<wbr>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new Set<string>()</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L40">RtcEngine.native.ts:40</a></li>
- </ul>
- </aside>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Methods</h2>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="addinjectstreamurl" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> add<wbr>Inject<wbr>Stream<wbr>Url</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">add<wbr>Inject<wbr>Stream<wbr>Url<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">InjectStreamOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L928">RtcEngine.native.ts:928</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>add inject stream url</p>
- </div>
- <p>This method injects an online media stream to a live broadcast.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">InjectStreamOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="addpublishstreamurl" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> add<wbr>Publish<wbr>Stream<wbr>Url</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">add<wbr>Publish<wbr>Stream<wbr>Url<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublishStreamOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1151">RtcEngine.native.ts:1151</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>add publish stream url</p>
- </div>
- <p>This method add publish stream by option.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">PublishStreamOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="addvideowatermark" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> add<wbr>Video<wbr>Watermark</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">add<wbr>Video<wbr>Watermark<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ImageOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L845">RtcEngine.native.ts:845</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>add video watermark</p>
- </div>
- <p>This method adds video watermark to the local video.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">ImageOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="adjustaudiomixingplayoutvolume" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> adjust<wbr>Audio<wbr>Mixing<wbr>Playout<wbr>Volume</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">adjust<wbr>Audio<wbr>Mixing<wbr>Playout<wbr>Volume<span class="tsd-signature-symbol">(</span>volume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L552">RtcEngine.native.ts:552</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>adjust audio mixing playout volume</p>
- </div>
- <p>This method adjusts audio mixing playout by the volume parameter</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>volume: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="adjustaudiomixingpublishvolume" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> adjust<wbr>Audio<wbr>Mixing<wbr>Publish<wbr>Volume</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">adjust<wbr>Audio<wbr>Mixing<wbr>Publish<wbr>Volume<span class="tsd-signature-symbol">(</span>volume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L562">RtcEngine.native.ts:562</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>adjust audio mixing publish volume</p>
- </div>
- <p>This method adjusts audio mixing publish by the volume paraemter</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>volume: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="adjustaudiomixingvolume" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> adjust<wbr>Audio<wbr>Mixing<wbr>Volume</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">adjust<wbr>Audio<wbr>Mixing<wbr>Volume<span class="tsd-signature-symbol">(</span>volume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L542">RtcEngine.native.ts:542</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>adjust audio mixing volume</p>
- </div>
- <p>This method adjusts audio mixing volume by the volume number parameter</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>volume: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="adjustplaybacksignalvolume" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> adjust<wbr>Playback<wbr>Signal<wbr>Volume</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">adjust<wbr>Playback<wbr>Signal<wbr>Volume<span class="tsd-signature-symbol">(</span>volume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L406">RtcEngine.native.ts:406</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>adjust playback signal volume</p>
- </div>
- <p>This method adjusts playback signal by volume.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>volume: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="adjustrecordingsignalvolume" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> adjust<wbr>Recording<wbr>Signal<wbr>Volume</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">adjust<wbr>Recording<wbr>Signal<wbr>Volume<span class="tsd-signature-symbol">(</span>volume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L396">RtcEngine.native.ts:396</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>adjust recording signal volume</p>
- </div>
- <p>This method adjusts recording your signal by volume.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>volume: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="createdatastream" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Data<wbr>Stream</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">create<wbr>Data<wbr>Stream<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DataStreamOption</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L428">RtcEngine.native.ts:428</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>create data stream</p>
- </div>
- <p>This method creates data stream with options</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">DataStreamOption</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="destroy" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> destroy</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L166">RtcEngine.native.ts:166</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>destroy</p>
- </div>
- <p>This method stops event subscribe and destroy the RtcEngine instance's.
- You should call it, when you want to destroy the engine.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="disableaudio" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> disable<wbr>Audio</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">disable<wbr>Audio<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L346">RtcEngine.native.ts:346</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>disable audio</p>
- </div>
- <p>This method disables audio</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="disablelastmiletest" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> disable<wbr>Lastmile<wbr>Test</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">disable<wbr>Lastmile<wbr>Test<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L797">RtcEngine.native.ts:797</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>disable lastmile test</p>
- </div>
- <p>This method disable the network connection qualit test.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="disablelocalaudio" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> disable<wbr>Local<wbr>Audio</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">disable<wbr>Local<wbr>Audio<span class="tsd-signature-symbol">(</span>muted<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L366">RtcEngine.native.ts:366</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>mute local audio stream</p>
- </div>
- <p>This method mutes the local audio stream by muted.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="disablevideo" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> disable<wbr>Video</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">disable<wbr>Video<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L277">RtcEngine.native.ts:277</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>disable video</p>
- </div>
- <p>This method disables video.</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="enableaudio" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Audio</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">enable<wbr>Audio<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L337">RtcEngine.native.ts:337</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>enable audio</p>
- </div>
- <p>This method enables audio</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="enableaudiovolumeindication" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Audio<wbr>Volume<wbr>Indication</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">enable<wbr>Audio<wbr>Volume<wbr>Indication<span class="tsd-signature-symbol">(</span>interval<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, smooth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L417">RtcEngine.native.ts:417</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>enable audio volume indication</p>
- </div>
- <p>This method enables audio volume by interval and smooth</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>interval: <span class="tsd-signature-type">number</span></h5>
- </li>
- <li>
- <h5>smooth: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="enabledualstreammode" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Dual<wbr>Stream<wbr>Mode</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">enable<wbr>Dual<wbr>Stream<wbr>Mode<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L892">RtcEngine.native.ts:892</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>enable dual stream mode</p>
- </div>
- <p>This method enables the dual stream by parameter mode.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>enabled: <span class="tsd-signature-type">boolean</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="enableinearmonitoring" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>InEar<wbr>Monitoring</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">enable<wbr>InEar<wbr>Monitoring<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L449">RtcEngine.native.ts:449</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>enable in-ear monitor</p>
- </div>
- <p>This method enables in-ear monitoring by boolean parameter enabled</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="enablelastmiletest" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Lastmile<wbr>Test</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">enable<wbr>Lastmile<wbr>Test<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L786">RtcEngine.native.ts:786</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>enable lastmile test</p>
- </div>
- <p>This method enables the network connection qualit test.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="enablelocalaudio" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Local<wbr>Audio</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">enable<wbr>Local<wbr>Audio<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L356">RtcEngine.native.ts:356</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>enable local audio</p>
- </div>
- <p>This method enables local audio by the boolean parameter.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="enablelocalvideo" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Local<wbr>Video</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">enable<wbr>Local<wbr>Video<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L287">RtcEngine.native.ts:287</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>enable local video</p>
- </div>
- <p>This method enables the local video by the boolean parameter.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="enablevideo" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Video</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">enable<wbr>Video<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L268">RtcEngine.native.ts:268</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>enable video</p>
- </div>
- <p>This method enables video.</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="enablewebsdkinteroperability" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Web<wbr>Sdk<wbr>Interoperability</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">enable<wbr>Web<wbr>Sdk<wbr>Interoperability<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L122">RtcEngine.native.ts:122</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>enable websdk interoperability</p>
- </div>
- <p>This method used to enable websdk interoperability, so that it can connect with agora websdk apps.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>enabled: <span class="tsd-signature-type">boolean</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="getaudiomixingcurrentposition" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Audio<wbr>Mixing<wbr>Current<wbr>Position</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">get<wbr>Audio<wbr>Mixing<wbr>Current<wbr>Position<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L582">RtcEngine.native.ts:582</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>get audio mixing current position</p>
- </div>
- <p>This method gets audio mixing current position value.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="getaudiomixingduration" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Audio<wbr>Mixing<wbr>Duration</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">get<wbr>Audio<wbr>Mixing<wbr>Duration<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L572">RtcEngine.native.ts:572</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>get audio mixing duration</p>
- </div>
- <p>This method gets the audio mixing duration</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="getcallid" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Call<wbr>Id</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">get<wbr>Call<wbr>Id<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1113">RtcEngine.native.ts:1113</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>get call id</p>
- </div>
- <p>This method is used to get call id.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="getcameramaxzoomfactor" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Camera<wbr>Max<wbr>Zoom<wbr>Factor</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">get<wbr>Camera<wbr>Max<wbr>Zoom<wbr>Factor<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1054">RtcEngine.native.ts:1054</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>get camera max zoom ratio</p>
- </div>
- <p>This method gets the camera maximum zoom ratio.</p>
- <dl class="tsd-comment-tags">
- <dt>notice</dt>
- <dd><p>Android Only</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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="getconnectionstate" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Connection<wbr>State</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">get<wbr>Connection<wbr>State<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L132">RtcEngine.native.ts:132</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>get agora native sdk connection state</p>
- </div>
- <p>This method gets agora native sdk connection state</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
- <p>Promise<{success: true, state: (connection state)}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="geteffectsvolume" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Effects<wbr>Volume</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">get<wbr>Effects<wbr>Volume<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L602">RtcEngine.native.ts:602</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>get effects of volume</p>
- </div>
- <p>This methods get audio mixing effects volume value.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="getsdkversion" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Sdk<wbr>Version</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">get<wbr>Sdk<wbr>Version<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, errorHandler<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1187">RtcEngine.native.ts:1187</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>get sdk version</p>
- </div>
- <p>This method gets the sdk version details and passed it into callback function</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
- <div class="tsd-comment tsd-typography">
- <p>to handle resolve from getSdkVersion</p>
- </div>
- </li>
- <li>
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> errorHandler: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
- <div class="tsd-comment tsd-typography">
- <p>to handle reject error from getSdkVersion</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="init" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> init</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">init<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Option</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L49">RtcEngine.native.ts:49</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>Creates a RtcEngine Object internal.</p>
- </div>
- <p>This method creates and start event observer. You should call this method once.</p>
- <dl class="tsd-comment-tags">
- <dt>example</dt>
- <dd><p><code>RtcEngine.init(option)</code></p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">Option</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>Defines the property of the client, see {@link Option} for details.</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="iscameraautofocusfacemodesupported" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Camera<wbr>Auto<wbr>Focus<wbr>Face<wbr>Mode<wbr>Supported</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">is<wbr>Camera<wbr>Auto<wbr>Focus<wbr>Face<wbr>Mode<wbr>Supported<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1030">RtcEngine.native.ts:1030</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>is camera auto focus face mode supported</p>
- </div>
- <p>This method checks whether the camera mannual auto-face focus function is supported.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="iscameraexposurepositionsupported" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Camera<wbr>Exposure<wbr>Position<wbr>Supported</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">is<wbr>Camera<wbr>Exposure<wbr>Position<wbr>Supported<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1019">RtcEngine.native.ts:1019</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>is camera exposure position supported</p>
- </div>
- <p>This method checks whether the camera mannual exposure function is supported.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="iscamerafocussupported" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Camera<wbr>Focus<wbr>Supported</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">is<wbr>Camera<wbr>Focus<wbr>Supported<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1008">RtcEngine.native.ts:1008</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>is camera focus supported</p>
- </div>
- <p>This method checks whether the camera mannual focus function is supported.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="iscameratorchsupported" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Camera<wbr>Torch<wbr>Supported</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">is<wbr>Camera<wbr>Torch<wbr>Supported<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L997">RtcEngine.native.ts:997</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>is camera torch supported</p>
- </div>
- <p>This method checks whether the camera flash function is supported.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="iscamerazoomsupported" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Camera<wbr>Zoom<wbr>Supported</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">is<wbr>Camera<wbr>Zoom<wbr>Supported<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L986">RtcEngine.native.ts:986</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>is camera zoom supported</p>
- </div>
- <p>This method checks whether the camera zoom function is supported.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="joinchannel" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> join<wbr>Channel</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">join<wbr>Channel<span class="tsd-signature-symbol">(</span>channelName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, uid<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, token<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, info<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Object</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L63">RtcEngine.native.ts:63</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>join specified channel</p>
- </div>
- <p>This method joins and begin rendering the video stream. when join succeeds.
- Otherwise, it will invoke error by the event</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>channelName: <span class="tsd-signature-type">string</span></h5>
- </li>
- <li>
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> uid: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
- </li>
- <li>
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> token: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
- </li>
- <li>
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> info: <span class="tsd-signature-type">Object</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="leavechannel" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> leave<wbr>Channel</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">leave<wbr>Channel<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L154">RtcEngine.native.ts:154</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>leave channel</p>
- </div>
- <p>This method leaves the joined channel, then your video view will not render ever.
- You should call it, when you dont need render video stream.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="methodisspeakerphoneenabled" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> methodis<wbr>Speakerphone<wbr>Enabled</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">methodis<wbr>Speakerphone<wbr>Enabled<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L438">RtcEngine.native.ts:438</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>check for mobile phone speaker enabled</p>
- </div>
- <p>This method checks the phone speaker is enabled</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="muteallremoteaudiostreams" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> mute<wbr>All<wbr>Remote<wbr>Audio<wbr>Streams</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">mute<wbr>All<wbr>Remote<wbr>Audio<wbr>Streams<span class="tsd-signature-symbol">(</span>muted<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L375">RtcEngine.native.ts:375</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>mute all remote audio streams</p>
- </div>
- <p>This method mutes all remote audio streams by muted</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="muteallremotevideostreams" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> mute<wbr>All<wbr>Remote<wbr>Video<wbr>Streams</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">mute<wbr>All<wbr>Remote<wbr>Video<wbr>Streams<span class="tsd-signature-symbol">(</span>muted<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L307">RtcEngine.native.ts:307</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>mute all remote video streams</p>
- </div>
- <p>This method mutes all remote streams by the boolean parameter.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="mutelocalaudiostream" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> mute<wbr>Local<wbr>Audio<wbr>Stream</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">mute<wbr>Local<wbr>Audio<wbr>Stream<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1199">RtcEngine.native.ts:1199</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>mute local audio stream</p>
- </div>
- <p>This method sends/stops sending the local audio.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="mutelocalvideostream" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> mute<wbr>Local<wbr>Video<wbr>Stream</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">mute<wbr>Local<wbr>Video<wbr>Stream<span class="tsd-signature-symbol">(</span>muted<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L297">RtcEngine.native.ts:297</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>mute local video stream</p>
- </div>
- <p>This method mutes video stream by the boolean parameter.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="muteremoteaudiostream" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> mute<wbr>Remote<wbr>Audio<wbr>Stream</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">mute<wbr>Remote<wbr>Audio<wbr>Stream<span class="tsd-signature-symbol">(</span>uid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, muted<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L386">RtcEngine.native.ts:386</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>mute specified remote audio stream by muted</p>
- </div>
- <p>This method mutes specified remote audio stream by number uid and boolean muted.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>uid: <span class="tsd-signature-type">number</span></h5>
- </li>
- <li>
- <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="muteremotevideostream" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> mute<wbr>Remote<wbr>Video<wbr>Stream</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">mute<wbr>Remote<wbr>Video<wbr>Stream<span class="tsd-signature-symbol">(</span>uid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, muted<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L318">RtcEngine.native.ts:318</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>mute specified remote video stream.</p>
- </div>
- <p>This method mutes remote video stream by the number of uid and boolean parameter.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>uid: <span class="tsd-signature-type">number</span></h5>
- </li>
- <li>
- <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="off" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> off</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">(</span>eventType<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">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L85">RtcEngine.native.ts:85</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>remove event listeners</p>
- </div>
- <p>This method unsubscribes specified eventType related all listeners. You should call this method when you want to unsubscribe some eventType.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>eventType: <span class="tsd-signature-type">string</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="on" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> on</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L74">RtcEngine.native.ts:74</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>add event listener</p>
- </div>
- <p>This method subscribes specified eventType and run listener. You should call this method at first.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>eventType: <span class="tsd-signature-type">string</span></h5>
- </li>
- <li>
- <h5>listener: <span class="tsd-signature-type">function</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- <ul class="tsd-parameters">
- <li class="tsd-parameter-siganture">
- <ul class="tsd-signatures tsd-kind-type-literal">
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="pausealleffects" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> pause<wbr>All<wbr>Effects</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">pause<wbr>All<wbr>Effects<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L700">RtcEngine.native.ts:700</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>pause all effects for audio mixing</p>
- </div>
- <p>This method pause all effects for audio mixing.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="pauseaudiomixing" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> pause<wbr>Audio<wbr>Mixing</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">pause<wbr>Audio<wbr>Mixing<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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L523">RtcEngine.native.ts:523</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>pause audio mixing</p>
- </div>
- <p>This method pauses for audio mixing.</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="pauseeffect" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> pause<wbr>Effect</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">pause<wbr>Effect<span class="tsd-signature-symbol">(</span>soundId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L689">RtcEngine.native.ts:689</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>pause the specified effect for audio mixing by soundid</p>
- </div>
- <p>This method pauses the specified effect for audio mixing by soundid.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>soundId: <span class="tsd-signature-type">number</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="playeffect" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> play<wbr>Effect</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">play<wbr>Effect<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PlayEffectOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L634">RtcEngine.native.ts:634</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>play specified effect for audio mixing</p>
- </div>
- <p>This methos plays the specified effect of audio mixing file by option config.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">PlayEffectOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="preloadeffect" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> preload<wbr>Effect</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">preload<wbr>Effect<span class="tsd-signature-symbol">(</span>soundId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, filepath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L667">RtcEngine.native.ts:667</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>preload effect for audio mixing file.</p>
- </div>
- <p>This methods preloads the specified audio mixing file to memory by the soundid</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>soundId: <span class="tsd-signature-type">number</span></h5>
- </li>
- <li>
- <h5>filepath: <span class="tsd-signature-type">string</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="removclearvideowatermarkse" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> removclear<wbr>Video<wbr>Watermarkse</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">removclear<wbr>Video<wbr>Watermarkse<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L856">RtcEngine.native.ts:856</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>clear video watermarks</p>
- </div>
- <p>This method removes the watermark image from the video stream added by addVideoWatermark.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="removealllisteners" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> remove<wbr>All<wbr>Listeners</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">remove<wbr>All<wbr>Listeners<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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L97">RtcEngine.native.ts:97</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>remove all events listeners</p>
- </div>
- <p>This method unsubscribes all eventTypes related listeners.</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="removeinjectstreamurl" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> remove<wbr>Inject<wbr>Stream<wbr>Url</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">remove<wbr>Inject<wbr>Stream<wbr>Url<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RemoveInjectStreamOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L940">RtcEngine.native.ts:940</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>remove inject stream url</p>
- </div>
- <p>This method removes stream by addInjectsStreamUrl.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">RemoveInjectStreamOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="removepublishstreamurl" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> remove<wbr>Publish<wbr>Stream<wbr>Url</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">remove<wbr>Publish<wbr>Stream<wbr>Url<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RemovePublishStreamOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1163">RtcEngine.native.ts:1163</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>remove publish stream url</p>
- </div>
- <p>This method remove publish stream by options.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">RemovePublishStreamOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="renewtoken" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> renew<wbr>Token</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">renew<wbr>Token<span class="tsd-signature-symbol">(</span>token<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">any</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L110">RtcEngine.native.ts:110</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>renew token</p>
- </div>
- <p>This method renews a new token.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>token: <span class="tsd-signature-type">string</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="resumealleffects" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> resume<wbr>All<wbr>Effects</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">resume<wbr>All<wbr>Effects<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L721">RtcEngine.native.ts:721</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>resume all audio mixing effects.</p>
- </div>
- <p>This method resumes all audio mixing effects.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="resumeaudiomixing" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> resume<wbr>Audio<wbr>Mixing</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">resume<wbr>Audio<wbr>Mixing<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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L532">RtcEngine.native.ts:532</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>resume audio mixing</p>
- </div>
- <p>This method resumes for audio mixing.</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="resumeeffect" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> resume<wbr>Effect</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">resume<wbr>Effect<span class="tsd-signature-symbol">(</span>soundId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L711">RtcEngine.native.ts:711</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>resume audio mixing effect by the specified soundid</p>
- </div>
- <p>This method resumes audio mixing effect by the specified soundid</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>soundId: <span class="tsd-signature-type">number</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="sendstreammessage" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> send<wbr>Stream<wbr>Message</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">send<wbr>Stream<wbr>Message<span class="tsd-signature-symbol">(</span>uid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1139">RtcEngine.native.ts:1139</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>send stream message</p>
- </div>
- <p>This method sends stream message by specified uid</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>uid: <span class="tsd-signature-type">number</span></h5>
- </li>
- <li>
- <h5>data: <span class="tsd-signature-type">any</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setaudiomixingposition" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Audio<wbr>Mixing<wbr>Position</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Audio<wbr>Mixing<wbr>Position<span class="tsd-signature-symbol">(</span>pos<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L592">RtcEngine.native.ts:592</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set audio mixing position</p>
- </div>
- <p>This method sets audio mixing position by the parameter pos</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>pos: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setaudiosessionoperationrestriction" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Audio<wbr>Session<wbr>Operation<wbr>Restriction</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Audio<wbr>Session<wbr>Operation<wbr>Restriction<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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L754">RtcEngine.native.ts:754</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set audio session operation restriction</p>
- </div>
- <p>The SDK and the app can both configure the audio session by default. The app may occasionally use other apps or third-party components to manipulate the audio session and restrict the SDK from doing so. This method allows the app to restrict the SDK’s manipulation of the audio session.
- You can call this method at any time to return the control of the audio sessions to the SDK.
- This method restricts the SDK’s manipulation of the audio session. Any operation to the audio session relies solely on the app, other apps, or third-party components.</p>
- <dl class="tsd-comment-tags">
- <dt>notice</dt>
- <dd><p>iOS support only</p>
- </dd>
- </dl>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setcameraautofocusfacemodeenabled" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Camera<wbr>Auto<wbr>Focus<wbr>Face<wbr>Mode<wbr>Enabled</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Camera<wbr>Auto<wbr>Focus<wbr>Face<wbr>Mode<wbr>Enabled<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1102">RtcEngine.native.ts:1102</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set enable auto focus face mode</p>
- </div>
- <p>This method enables auto-focus face mode function.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>boolean</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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setcameraexposureposition" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Camera<wbr>Exposure<wbr>Position</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Camera<wbr>Exposure<wbr>Position<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PositionOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1078">RtcEngine.native.ts:1078</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set camera exposure position</p>
- </div>
- <p>This method sets the mannual exposure position.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">PositionOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setcamerafocuspositioninpreview" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Camera<wbr>Focus<wbr>Position<wbr>InPreview</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Camera<wbr>Focus<wbr>Position<wbr>InPreview<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PositionOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1066">RtcEngine.native.ts:1066</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set camera focus position in preview</p>
- </div>
- <p>This method sets the mannual focus position.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">PositionOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setcameratorchon" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Camera<wbr>Torch<wbr>On</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Camera<wbr>Torch<wbr>On<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1090">RtcEngine.native.ts:1090</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set camera torch on</p>
- </div>
- <p>This method enables the camera flash function.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>enabled: <span class="tsd-signature-type">boolean</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setcamerazoomfactor" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Camera<wbr>Zoom<wbr>Factor</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Camera<wbr>Zoom<wbr>Factor<span class="tsd-signature-symbol">(</span>zoomFactor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1042">RtcEngine.native.ts:1042</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set camera zoom ratio</p>
- </div>
- <p>This method sets the camera zoom ratio.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>zoomFactor: <span class="tsd-signature-type">number</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setclientrole" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Client<wbr>Role</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Client<wbr>Role<span class="tsd-signature-symbol">(</span>role<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L142">RtcEngine.native.ts:142</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>change the client role</p>
- </div>
- <p>This method changes the client of role.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>role: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>(audience: 0, host: 1)</p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setdefaultaudioroutetospeakerphone" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Default<wbr>Audio<wbr>Route<wbr>ToSpeakerphone</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Default<wbr>Audio<wbr>Route<wbr>ToSpeakerphone<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L248">RtcEngine.native.ts:248</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set default audio speaker</p>
- </div>
- <p>This method set the default audio speaker enable or disable by pass boolean parameter.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setdefaultmuteallremoteaudiostreams" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Default<wbr>Mute<wbr>All<wbr>Remote<wbr>Audio<wbr>Streams</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Default<wbr>Mute<wbr>All<wbr>Remote<wbr>Audio<wbr>Streams<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L259">RtcEngine.native.ts:259</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set default mute all remote audio streams</p>
- </div>
- <p>This method set default mute all remote audio streams enable or not by pass boolean parameter.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setdefaultmuteallremotevideostreams" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Default<wbr>Mute<wbr>All<wbr>Remote<wbr>Video<wbr>Streams</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Default<wbr>Mute<wbr>All<wbr>Remote<wbr>Video<wbr>Streams<span class="tsd-signature-symbol">(</span>muted<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L328">RtcEngine.native.ts:328</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set default mute all remote video stream</p>
- </div>
- <p>This method mutes all remote video stream default by the boolean parameter.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="seteffectsvolume" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Effects<wbr>Volume</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Effects<wbr>Volume<span class="tsd-signature-symbol">(</span>volume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L613">RtcEngine.native.ts:613</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set effects volume</p>
- </div>
- <p>This methods set audio mixing effects volume by float parameter.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>volume: <span class="tsd-signature-type">number</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setenablespeakerphone" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Enable<wbr>Speakerphone</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Enable<wbr>Speakerphone<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L238">RtcEngine.native.ts:238</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set enable speaker phone</p>
- </div>
- <p>This method set the speaker phone enable or disable by pass boolean parameter.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setinearmonitoringvolume" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>InEar<wbr>Monitoring<wbr>Volume</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>InEar<wbr>Monitoring<wbr>Volume<span class="tsd-signature-symbol">(</span>volume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L460">RtcEngine.native.ts:460</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set in-ear monitoring volume</p>
- </div>
- <p>This method sets the in-ear-monitoring volume by number parameter volume</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>volume: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setlivetranscoding" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Live<wbr>Transcoding</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Live<wbr>Transcoding<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LiveTranscodingOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1175">RtcEngine.native.ts:1175</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set live transcoding</p>
- </div>
- <p>This method sets the video layout and audio settings for CDN live.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">LiveTranscodingOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setlocalpublishfallbackoption" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Publish<wbr>Fallback<wbr>Option</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Local<wbr>Publish<wbr>Fallback<wbr>Option<span class="tsd-signature-symbol">(</span>option<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L868">RtcEngine.native.ts:868</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set local publish fallback</p>
- </div>
- <p>This method sets the fallback option for the locally published video stream based on the network conditions.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>option: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- <p><a href="https://docs.agora.io/en/Video/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_constants.html#a3e453c93766e783a7e5eca05b1776238">more details</a></p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setlocalrendermode" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Render<wbr>Mode</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Local<wbr>Render<wbr>Mode<span class="tsd-signature-symbol">(</span>mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L197">RtcEngine.native.ts:197</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set local video render mode</p>
- </div>
- <p>This method calls native sdk render mode for local video.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>mode: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setlocalvideomirrormode" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Video<wbr>Mirror<wbr>Mode</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Local<wbr>Video<wbr>Mirror<wbr>Mode<span class="tsd-signature-symbol">(</span>mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L964">RtcEngine.native.ts:964</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set local video mirror mode</p>
- </div>
- <p>This method sets local video mirror mode</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>mode: <span class="tsd-signature-type">number</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setlocalvoiceequalization" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Voice<wbr>Equalization</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Equalization<span class="tsd-signature-symbol">(</span>band<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, gain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L483">RtcEngine.native.ts:483</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set local voice equalization</p>
- </div>
- <p>This method set local video equalization of band frequency by enum band number and number of gain</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>band: <span class="tsd-signature-type">number</span></h5>
- </li>
- <li>
- <h5>gain: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setlocalvoicepitch" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Voice<wbr>Pitch</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Pitch<span class="tsd-signature-symbol">(</span>pitch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L471">RtcEngine.native.ts:471</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set local voice pitch</p>
- </div>
- <p>This method sets the local voice pitch by float parameter pitch</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>pitch: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setlocalvoicereverb" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Voice<wbr>Reverb</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Reverb<span class="tsd-signature-symbol">(</span>reverb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L494">RtcEngine.native.ts:494</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set local voice reverb</p>
- </div>
- <p>This method sets local voice by reverb and value</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>reverb: <span class="tsd-signature-type">number</span></h5>
- </li>
- <li>
- <h5>value: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setlog" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Log</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Log<span class="tsd-signature-symbol">(</span>filepath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L1126">RtcEngine.native.ts:1126</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set log file and log filter</p>
- </div>
- <p>This method sets the log file generated path and specified the log level.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>filepath: <span class="tsd-signature-type">string</span></h5>
- </li>
- <li>
- <h5>level: <span class="tsd-signature-type">number</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setmixedaudioframeparameters" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Mixed<wbr>Audio<wbr>Frame<wbr>Parameters</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Mixed<wbr>Audio<wbr>Frame<wbr>Parameters<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MixedAudioFrameOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L833">RtcEngine.native.ts:833</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set mixed audio frame parameters</p>
- </div>
- <p>This method Sets the audio frame format for the mixedAudioFrame callback.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">MixedAudioFrameOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setplaybackaudioframeparameters" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Playback<wbr>Audio<wbr>Frame<wbr>Parameters</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Playback<wbr>Audio<wbr>Frame<wbr>Parameters<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AudioFrameOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L821">RtcEngine.native.ts:821</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set playback audio frame parameters</p>
- </div>
- <p>This method Sets the audio frame format for the playbackFrame callback.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">AudioFrameOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setrecordingaudioframeparameters" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Recording<wbr>Audio<wbr>Frame<wbr>Parameters</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Recording<wbr>Audio<wbr>Frame<wbr>Parameters<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AudioFrameOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L809">RtcEngine.native.ts:809</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set recording audio frame parameters</p>
- </div>
- <p>This method Sets the audio recording format for the audioFrame callback.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">AudioFrameOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setremotedefaultvideostreamtype" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Remote<wbr>Default<wbr>Video<wbr>Stream<wbr>Type</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Remote<wbr>Default<wbr>Video<wbr>Stream<wbr>Type<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DefaultVideoStreamOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L916">RtcEngine.native.ts:916</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set remote default video stream type</p>
- </div>
- <p>This method sets the default video stream type.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">DefaultVideoStreamOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setremoterendermode" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Remote<wbr>Render<wbr>Mode</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Remote<wbr>Render<wbr>Mode<span class="tsd-signature-symbol">(</span>uid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L209">RtcEngine.native.ts:209</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set the specified remote video render mode</p>
- </div>
- <p>This method calls native sdk render mode for the specified remote video.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>uid: <span class="tsd-signature-type">number</span></h5>
- </li>
- <li>
- <h5>mode: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setremotesubscribefallbackoption" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Remote<wbr>Subscribe<wbr>Fallback<wbr>Option</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Remote<wbr>Subscribe<wbr>Fallback<wbr>Option<span class="tsd-signature-symbol">(</span>option<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L880">RtcEngine.native.ts:880</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set remote publish fallback</p>
- </div>
- <p>This method sets the fallback option for the remotely subscribed video stream based on the network conditions.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>option: <span class="tsd-signature-type">number</span></h5>
- <div class="tsd-comment tsd-typography">
- <p><a href="https://docs.agora.io/en/Video/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_constants.html#a3e453c93766e783a7e5eca05b1776238">more details</a></p>
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setremotevideostreamtype" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Remote<wbr>Video<wbr>Stream<wbr>Type</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Remote<wbr>Video<wbr>Stream<wbr>Type<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VideoStreamOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L904">RtcEngine.native.ts:904</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set remote video stream type</p>
- </div>
- <p>This method sets the remote video stream type by uid and streamType.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">VideoStreamOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setvideoqualityparameters" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Video<wbr>Quality<wbr>Parameters</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Video<wbr>Quality<wbr>Parameters<span class="tsd-signature-symbol">(</span>quality<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L952">RtcEngine.native.ts:952</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set video quality</p>
- </div>
- <p>This method sets the preferences for the video quality. (Live broadcast only).</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>quality: <span class="tsd-signature-type">boolean</span></h5>
- <div class="tsd-comment tsd-typography">
- <p>boolean</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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setvolumeofeffect" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Volume<wbr>OfEffect</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">set<wbr>Volume<wbr>OfEffect<span class="tsd-signature-symbol">(</span>volume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L623">RtcEngine.native.ts:623</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>set volume for playing effects.</p>
- </div>
- <p>This methods set for playing audio mixing effects</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>volume: <span class="tsd-signature-type">number</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setuplocalvideo" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> setup<wbr>Local<wbr>Video</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">setup<wbr>Local<wbr>Video<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VideoOption</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L177">RtcEngine.native.ts:177</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>show local video</p>
- </div>
- <p>This method calls native sdk render canvas for local video.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">VideoOption</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="setupremotevideo" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> setup<wbr>Remote<wbr>Video</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">setup<wbr>Remote<wbr>Video<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VideoOption</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L187">RtcEngine.native.ts:187</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>show remote video</p>
- </div>
- <p>This method calls native sdk render canvas for remote video.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">VideoOption</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="startaudiomixing" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> start<wbr>Audio<wbr>Mixing</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">start<wbr>Audio<wbr>Mixing<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AudioMixingOption</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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L505">RtcEngine.native.ts:505</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>start audio mixing</p>
- </div>
- <p>This method will start audio mixing by option config</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">AudioMixingOption</span></h5>
- <div class="tsd-comment tsd-typography">
- </div>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="startaudiorecording" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> start<wbr>Audio<wbr>Recording</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">start<wbr>Audio<wbr>Recording<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AudioRecordingOption</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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L732">RtcEngine.native.ts:732</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>start audio recording by quality</p>
- </div>
- <p>This method start audio recording by quality config</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>options: <span class="tsd-signature-type">AudioRecordingOption</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="startechotest" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> start<wbr>Echo<wbr>Test</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">start<wbr>Echo<wbr>Test<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L765">RtcEngine.native.ts:765</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>start echo test</p>
- </div>
- <p>This method launches an audio call test to determine whether the audio devices (for example, headset and speaker) and the network connection are working properly.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="startpreview" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> start<wbr>Preview</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">start<wbr>Preview<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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L218">RtcEngine.native.ts:218</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>start video preview</p>
- </div>
- <p>This method start video preview for video.</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="stopalleffects" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> stop<wbr>All<wbr>Effects</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">stop<wbr>All<wbr>Effects<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L655">RtcEngine.native.ts:655</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>stop play all for effect audio mixing.</p>
- </div>
- <p>This methods stops all effect audio mixing.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="stopaudiomixing" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> stop<wbr>Audio<wbr>Mixing</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">stop<wbr>Audio<wbr>Mixing<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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L514">RtcEngine.native.ts:514</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>stop audio mixing</p>
- </div>
- <p>This methods stops for audio mixing.</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="stopaudiorecording" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> stop<wbr>Audio<wbr>Recording</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">stop<wbr>Audio<wbr>Recording<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L742">RtcEngine.native.ts:742</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>stop audio recording</p>
- </div>
- <p>This method stops audio recording.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="stopechotest" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> stop<wbr>Echo<wbr>Test</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">stop<wbr>Echo<wbr>Test<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L775">RtcEngine.native.ts:775</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>stop echo test</p>
- </div>
- <p>This method stop launched an audio call test.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="stopeffect" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> stop<wbr>Effect</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">stop<wbr>Effect<span class="tsd-signature-symbol">(</span>soundId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L645">RtcEngine.native.ts:645</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>stop play effect for audio mixing</p>
- </div>
- <p>This methods stops the specified effect for audio mixing file by soundid.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>soundId: <span class="tsd-signature-type">number</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="stoppreview" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> stop<wbr>Preview</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">stop<wbr>Preview<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">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L228">RtcEngine.native.ts:228</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>stop video preview</p>
- </div>
- <p>This method stops video preview for video.</p>
- </div>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="switchcamera" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> switch<wbr>Camera</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">switch<wbr>Camera<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">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L975">RtcEngine.native.ts:975</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>switch camera</p>
- </div>
- <p>This method switches camera between front and rear.</p>
- </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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a name="unloadeffect" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagStatic">Static</span> unload<wbr>Effect</h3>
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <li class="tsd-signature tsd-kind-icon">unload<wbr>Effect<span class="tsd-signature-symbol">(</span>soundId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/RtcEngine.native.ts#L678">RtcEngine.native.ts:678</a></li>
- </ul>
- </aside>
- <div class="tsd-comment tsd-typography">
- <div class="lead">
- <p>unload effect</p>
- </div>
- <p>This methods unload the already loaded audio mixing file from memory by the soundid.</p>
- </div>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>soundId: <span class="tsd-signature-type">number</span></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">any</span><span class="tsd-signature-symbol">></span></h4>
- <p>Promise<{success, value}></p>
- </li>
- </ul>
- </section>
- </section>
- </div>
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
- <nav class="tsd-navigation primary">
- <ul>
- <li class="globals ">
- <a href="../globals.html"><em>Globals</em></a>
- </li>
- </ul>
- </nav>
- <nav class="tsd-navigation secondary menu-sticky">
- <ul class="before-current">
- <li class=" tsd-kind-class tsd-has-type-parameter">
- <a href="agoraview.html" class="tsd-kind-icon">Agora<wbr>View</a>
- </li>
- </ul>
- <ul class="current">
- <li class="current tsd-kind-class">
- <a href="rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
- <ul>
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
- <a href="rtcengine.html#eventtypes" class="tsd-kind-icon">event<wbr>Types</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#addinjectstreamurl" class="tsd-kind-icon">add<wbr>Inject<wbr>Stream<wbr>Url</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#addpublishstreamurl" class="tsd-kind-icon">add<wbr>Publish<wbr>Stream<wbr>Url</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#addvideowatermark" class="tsd-kind-icon">add<wbr>Video<wbr>Watermark</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#adjustaudiomixingplayoutvolume" class="tsd-kind-icon">adjust<wbr>Audio<wbr>Mixing<wbr>Playout<wbr>Volume</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#adjustaudiomixingpublishvolume" class="tsd-kind-icon">adjust<wbr>Audio<wbr>Mixing<wbr>Publish<wbr>Volume</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#adjustaudiomixingvolume" class="tsd-kind-icon">adjust<wbr>Audio<wbr>Mixing<wbr>Volume</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#adjustplaybacksignalvolume" class="tsd-kind-icon">adjust<wbr>Playback<wbr>Signal<wbr>Volume</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#adjustrecordingsignalvolume" class="tsd-kind-icon">adjust<wbr>Recording<wbr>Signal<wbr>Volume</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#createdatastream" class="tsd-kind-icon">create<wbr>Data<wbr>Stream</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#destroy" class="tsd-kind-icon">destroy</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#disableaudio" class="tsd-kind-icon">disable<wbr>Audio</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#disablelastmiletest" class="tsd-kind-icon">disable<wbr>Lastmile<wbr>Test</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#disablelocalaudio" class="tsd-kind-icon">disable<wbr>Local<wbr>Audio</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#disablevideo" class="tsd-kind-icon">disable<wbr>Video</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#enableaudio" class="tsd-kind-icon">enable<wbr>Audio</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#enableaudiovolumeindication" class="tsd-kind-icon">enable<wbr>Audio<wbr>Volume<wbr>Indication</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#enabledualstreammode" class="tsd-kind-icon">enable<wbr>Dual<wbr>Stream<wbr>Mode</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#enableinearmonitoring" class="tsd-kind-icon">enable<wbr>InEar<wbr>Monitoring</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#enablelastmiletest" class="tsd-kind-icon">enable<wbr>Lastmile<wbr>Test</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#enablelocalaudio" class="tsd-kind-icon">enable<wbr>Local<wbr>Audio</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#enablelocalvideo" class="tsd-kind-icon">enable<wbr>Local<wbr>Video</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#enablevideo" class="tsd-kind-icon">enable<wbr>Video</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#enablewebsdkinteroperability" class="tsd-kind-icon">enable<wbr>Web<wbr>Sdk<wbr>Interoperability</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#getaudiomixingcurrentposition" class="tsd-kind-icon">get<wbr>Audio<wbr>Mixing<wbr>Current<wbr>Position</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#getaudiomixingduration" class="tsd-kind-icon">get<wbr>Audio<wbr>Mixing<wbr>Duration</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#getcallid" class="tsd-kind-icon">get<wbr>Call<wbr>Id</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#getcameramaxzoomfactor" class="tsd-kind-icon">get<wbr>Camera<wbr>Max<wbr>Zoom<wbr>Factor</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#getconnectionstate" class="tsd-kind-icon">get<wbr>Connection<wbr>State</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#geteffectsvolume" class="tsd-kind-icon">get<wbr>Effects<wbr>Volume</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#getsdkversion" class="tsd-kind-icon">get<wbr>Sdk<wbr>Version</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#init" class="tsd-kind-icon">init</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#iscameraautofocusfacemodesupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Auto<wbr>Focus<wbr>Face<wbr>Mode<wbr>Supported</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#iscameraexposurepositionsupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Exposure<wbr>Position<wbr>Supported</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#iscamerafocussupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Focus<wbr>Supported</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#iscameratorchsupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Torch<wbr>Supported</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#iscamerazoomsupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Zoom<wbr>Supported</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#joinchannel" class="tsd-kind-icon">join<wbr>Channel</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#leavechannel" class="tsd-kind-icon">leave<wbr>Channel</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#methodisspeakerphoneenabled" class="tsd-kind-icon">methodis<wbr>Speakerphone<wbr>Enabled</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#muteallremoteaudiostreams" class="tsd-kind-icon">mute<wbr>All<wbr>Remote<wbr>Audio<wbr>Streams</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#muteallremotevideostreams" class="tsd-kind-icon">mute<wbr>All<wbr>Remote<wbr>Video<wbr>Streams</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#mutelocalaudiostream" class="tsd-kind-icon">mute<wbr>Local<wbr>Audio<wbr>Stream</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#mutelocalvideostream" class="tsd-kind-icon">mute<wbr>Local<wbr>Video<wbr>Stream</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#muteremoteaudiostream" class="tsd-kind-icon">mute<wbr>Remote<wbr>Audio<wbr>Stream</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#muteremotevideostream" class="tsd-kind-icon">mute<wbr>Remote<wbr>Video<wbr>Stream</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#off" class="tsd-kind-icon">off</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#on" class="tsd-kind-icon">on</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#pausealleffects" class="tsd-kind-icon">pause<wbr>All<wbr>Effects</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#pauseaudiomixing" class="tsd-kind-icon">pause<wbr>Audio<wbr>Mixing</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#pauseeffect" class="tsd-kind-icon">pause<wbr>Effect</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#playeffect" class="tsd-kind-icon">play<wbr>Effect</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#preloadeffect" class="tsd-kind-icon">preload<wbr>Effect</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#removclearvideowatermarkse" class="tsd-kind-icon">removclear<wbr>Video<wbr>Watermarkse</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#removealllisteners" class="tsd-kind-icon">remove<wbr>All<wbr>Listeners</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#removeinjectstreamurl" class="tsd-kind-icon">remove<wbr>Inject<wbr>Stream<wbr>Url</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#removepublishstreamurl" class="tsd-kind-icon">remove<wbr>Publish<wbr>Stream<wbr>Url</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#renewtoken" class="tsd-kind-icon">renew<wbr>Token</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#resumealleffects" class="tsd-kind-icon">resume<wbr>All<wbr>Effects</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#resumeaudiomixing" class="tsd-kind-icon">resume<wbr>Audio<wbr>Mixing</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#resumeeffect" class="tsd-kind-icon">resume<wbr>Effect</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#sendstreammessage" class="tsd-kind-icon">send<wbr>Stream<wbr>Message</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setaudiomixingposition" class="tsd-kind-icon">set<wbr>Audio<wbr>Mixing<wbr>Position</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setaudiosessionoperationrestriction" class="tsd-kind-icon">set<wbr>Audio<wbr>Session<wbr>Operation<wbr>Restriction</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setcameraautofocusfacemodeenabled" class="tsd-kind-icon">set<wbr>Camera<wbr>Auto<wbr>Focus<wbr>Face<wbr>Mode<wbr>Enabled</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setcameraexposureposition" class="tsd-kind-icon">set<wbr>Camera<wbr>Exposure<wbr>Position</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setcamerafocuspositioninpreview" class="tsd-kind-icon">set<wbr>Camera<wbr>Focus<wbr>Position<wbr>InPreview</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setcameratorchon" class="tsd-kind-icon">set<wbr>Camera<wbr>Torch<wbr>On</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setcamerazoomfactor" class="tsd-kind-icon">set<wbr>Camera<wbr>Zoom<wbr>Factor</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setclientrole" class="tsd-kind-icon">set<wbr>Client<wbr>Role</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setdefaultaudioroutetospeakerphone" class="tsd-kind-icon">set<wbr>Default<wbr>Audio<wbr>Route<wbr>ToSpeakerphone</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setdefaultmuteallremoteaudiostreams" class="tsd-kind-icon">set<wbr>Default<wbr>Mute<wbr>All<wbr>Remote<wbr>Audio<wbr>Streams</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setdefaultmuteallremotevideostreams" class="tsd-kind-icon">set<wbr>Default<wbr>Mute<wbr>All<wbr>Remote<wbr>Video<wbr>Streams</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#seteffectsvolume" class="tsd-kind-icon">set<wbr>Effects<wbr>Volume</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setenablespeakerphone" class="tsd-kind-icon">set<wbr>Enable<wbr>Speakerphone</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setinearmonitoringvolume" class="tsd-kind-icon">set<wbr>InEar<wbr>Monitoring<wbr>Volume</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setlivetranscoding" class="tsd-kind-icon">set<wbr>Live<wbr>Transcoding</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setlocalpublishfallbackoption" class="tsd-kind-icon">set<wbr>Local<wbr>Publish<wbr>Fallback<wbr>Option</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setlocalrendermode" class="tsd-kind-icon">set<wbr>Local<wbr>Render<wbr>Mode</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setlocalvideomirrormode" class="tsd-kind-icon">set<wbr>Local<wbr>Video<wbr>Mirror<wbr>Mode</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setlocalvoiceequalization" class="tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Equalization</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setlocalvoicepitch" class="tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Pitch</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setlocalvoicereverb" class="tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Reverb</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setlog" class="tsd-kind-icon">set<wbr>Log</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setmixedaudioframeparameters" class="tsd-kind-icon">set<wbr>Mixed<wbr>Audio<wbr>Frame<wbr>Parameters</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setplaybackaudioframeparameters" class="tsd-kind-icon">set<wbr>Playback<wbr>Audio<wbr>Frame<wbr>Parameters</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setrecordingaudioframeparameters" class="tsd-kind-icon">set<wbr>Recording<wbr>Audio<wbr>Frame<wbr>Parameters</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setremotedefaultvideostreamtype" class="tsd-kind-icon">set<wbr>Remote<wbr>Default<wbr>Video<wbr>Stream<wbr>Type</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setremoterendermode" class="tsd-kind-icon">set<wbr>Remote<wbr>Render<wbr>Mode</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setremotesubscribefallbackoption" class="tsd-kind-icon">set<wbr>Remote<wbr>Subscribe<wbr>Fallback<wbr>Option</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setremotevideostreamtype" class="tsd-kind-icon">set<wbr>Remote<wbr>Video<wbr>Stream<wbr>Type</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setvideoqualityparameters" class="tsd-kind-icon">set<wbr>Video<wbr>Quality<wbr>Parameters</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setvolumeofeffect" class="tsd-kind-icon">set<wbr>Volume<wbr>OfEffect</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setuplocalvideo" class="tsd-kind-icon">setup<wbr>Local<wbr>Video</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#setupremotevideo" class="tsd-kind-icon">setup<wbr>Remote<wbr>Video</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#startaudiomixing" class="tsd-kind-icon">start<wbr>Audio<wbr>Mixing</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#startaudiorecording" class="tsd-kind-icon">start<wbr>Audio<wbr>Recording</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#startechotest" class="tsd-kind-icon">start<wbr>Echo<wbr>Test</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#startpreview" class="tsd-kind-icon">start<wbr>Preview</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#stopalleffects" class="tsd-kind-icon">stop<wbr>All<wbr>Effects</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#stopaudiomixing" class="tsd-kind-icon">stop<wbr>Audio<wbr>Mixing</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#stopaudiorecording" class="tsd-kind-icon">stop<wbr>Audio<wbr>Recording</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#stopechotest" class="tsd-kind-icon">stop<wbr>Echo<wbr>Test</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#stopeffect" class="tsd-kind-icon">stop<wbr>Effect</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#stoppreview" class="tsd-kind-icon">stop<wbr>Preview</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#switchcamera" class="tsd-kind-icon">switch<wbr>Camera</a>
- </li>
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
- <a href="rtcengine.html#unloadeffect" class="tsd-kind-icon">unload<wbr>Effect</a>
- </li>
- </ul>
- </li>
- </ul>
- <ul class="after-current">
- <li class=" tsd-kind-variable tsd-is-not-exported">
- <a href="../globals.html#agora" class="tsd-kind-icon">Agora</a>
- </li>
- <li class=" tsd-kind-variable tsd-is-not-exported">
- <a href="../globals.html#agoraeventemitter" class="tsd-kind-icon">Agora<wbr>Event<wbr>Emitter</a>
- </li>
- <li class=" tsd-kind-variable tsd-is-not-exported">
- <a href="../globals.html#rctagoraview" class="tsd-kind-icon">RCTAgora<wbr>View</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-module"><span class="tsd-kind-icon">Module</span></li>
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
- <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
- <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
- <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
- <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
- <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
- <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>
- <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
- <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
- <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>
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
- <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
- </ul>
- </div>
- </div>
- </footer>
- <div class="container tsd-generator">
- <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
- </div>
- <div class="overlay"></div>
- <script src="../assets/js/main.js"></script>
- <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
- </body>
- </html>
|