Açıklama Yok

rtcengine.html 254KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117
  1. <!doctype html>
  2. <html class="default no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <title>RtcEngine | react-native-agora</title>
  7. <meta name="description" content="">
  8. <meta name="viewport" content="width=device-width, initial-scale=1">
  9. <link rel="stylesheet" href="../assets/css/main.css">
  10. </head>
  11. <body>
  12. <header>
  13. <div class="tsd-page-toolbar">
  14. <div class="container">
  15. <div class="table-wrap">
  16. <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
  17. <div class="field">
  18. <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
  19. <input id="tsd-search-field" type="text" />
  20. </div>
  21. <ul class="results">
  22. <li class="state loading">Preparing search index...</li>
  23. <li class="state failure">The search index is not available</li>
  24. </ul>
  25. <a href="../index.html" class="title">react-native-agora</a>
  26. </div>
  27. <div class="table-cell" id="tsd-widgets">
  28. <div id="tsd-filter">
  29. <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
  30. <div class="tsd-filter-group">
  31. <div class="tsd-select" id="tsd-filter-visibility">
  32. <span class="tsd-select-label">All</span>
  33. <ul class="tsd-select-list">
  34. <li data-value="public">Public</li>
  35. <li data-value="protected">Public/Protected</li>
  36. <li data-value="private" class="selected">All</li>
  37. </ul>
  38. </div>
  39. <input type="checkbox" id="tsd-filter-inherited" checked />
  40. <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
  41. <input type="checkbox" id="tsd-filter-externals" checked />
  42. <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
  43. <input type="checkbox" id="tsd-filter-only-exported" />
  44. <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
  45. </div>
  46. </div>
  47. <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
  48. </div>
  49. </div>
  50. </div>
  51. </div>
  52. <div class="tsd-page-title">
  53. <div class="container">
  54. <ul class="tsd-breadcrumb">
  55. <li>
  56. <a href="../globals.html">Globals</a>
  57. </li>
  58. <li>
  59. <a href="rtcengine.html">RtcEngine</a>
  60. </li>
  61. </ul>
  62. <h1>Class RtcEngine</h1>
  63. </div>
  64. </div>
  65. </header>
  66. <div class="container container-main">
  67. <div class="row">
  68. <div class="col-8 col-content">
  69. <section class="tsd-panel tsd-comment">
  70. <div class="tsd-comment tsd-typography">
  71. <div class="lead">
  72. <p>RtcEngine is the javascript object for control agora native sdk through react native bridge.</p>
  73. </div>
  74. <p>You can use the RtcEngine methods to create <a href="rtcengine.html#init">init</a></p>
  75. <p>Other methods of the RtcEngine object serve for agora native sdk and set up error logging.</p>
  76. </div>
  77. </section>
  78. <section class="tsd-panel tsd-hierarchy">
  79. <h3>Hierarchy</h3>
  80. <ul class="tsd-hierarchy">
  81. <li>
  82. <span class="target">RtcEngine</span>
  83. </li>
  84. </ul>
  85. </section>
  86. <section class="tsd-panel-group tsd-index-group">
  87. <h2>Index</h2>
  88. <section class="tsd-panel tsd-index-panel">
  89. <div class="tsd-index-content">
  90. <section class="tsd-index-section ">
  91. <h3>Events</h3>
  92. <ul class="tsd-index-list">
  93. <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#startlastmileprobetest" class="tsd-kind-icon">start<wbr>Lastmile<wbr>Probe<wbr>Test</a></li>
  94. </ul>
  95. </section>
  96. <section class="tsd-index-section tsd-is-private tsd-is-private-protected">
  97. <h3>Properties</h3>
  98. <ul class="tsd-index-list">
  99. <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>
  100. </ul>
  101. </section>
  102. <section class="tsd-index-section ">
  103. <h3>Methods</h3>
  104. <ul class="tsd-index-list">
  105. <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>
  106. <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>
  107. <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>
  108. <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>
  109. <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>
  110. <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>
  111. <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>
  112. <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>
  113. <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>
  114. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#destroy" class="tsd-kind-icon">destroy</a></li>
  115. <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>
  116. <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>
  117. <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>
  118. <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>
  119. <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>
  120. <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>
  121. <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>
  122. <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>
  123. <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>
  124. <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>
  125. <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>
  126. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#enablesoundpositionindication" class="tsd-kind-icon">enable<wbr>Sound<wbr>Position<wbr>Indication</a></li>
  127. <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>
  128. <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>
  129. <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>
  130. <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>
  131. <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>
  132. <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>
  133. <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>
  134. <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>
  135. <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>
  136. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#init" class="tsd-kind-icon">init</a></li>
  137. <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>
  138. <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>
  139. <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>
  140. <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>
  141. <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>
  142. <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>
  143. <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>
  144. <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>
  145. <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>
  146. <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>
  147. <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>
  148. <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>
  149. <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>
  150. <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>
  151. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#off" class="tsd-kind-icon">off</a></li>
  152. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#on" class="tsd-kind-icon">on</a></li>
  153. <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>
  154. <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>
  155. <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>
  156. <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>
  157. <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>
  158. <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>
  159. <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>
  160. <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>
  161. <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>
  162. <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>
  163. <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>
  164. <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>
  165. <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>
  166. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#sendmessage" class="tsd-kind-icon">send<wbr>Message</a></li>
  167. <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>
  168. <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>
  169. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setbeautyeffectoptions" class="tsd-kind-icon">set<wbr>Beauty<wbr>Effect<wbr>Options</a></li>
  170. <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>
  171. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setcameracapturerconfiguration" class="tsd-kind-icon">set<wbr>Camera<wbr>Capturer<wbr>Configuration</a></li>
  172. <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>
  173. <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>
  174. <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>
  175. <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>
  176. <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>
  177. <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>
  178. <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>
  179. <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>
  180. <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>
  181. <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>
  182. <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>
  183. <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>
  184. <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>
  185. <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>
  186. <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>
  187. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setlocalvoicechanger" class="tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Changer</a></li>
  188. <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>
  189. <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>
  190. <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>
  191. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setlocalvoicereverbpreset" class="tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Reverb<wbr>Preset</a></li>
  192. <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>
  193. <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>
  194. <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>
  195. <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>
  196. <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>
  197. <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>
  198. <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>
  199. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setremoteuserpriority" class="tsd-kind-icon">set<wbr>Remote<wbr>User<wbr>Priority</a></li>
  200. <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>
  201. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#setremotevoiceposition" class="tsd-kind-icon">set<wbr>Remote<wbr>Voice<wbr>Position</a></li>
  202. <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>
  203. <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>
  204. <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>
  205. <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>
  206. <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>
  207. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#startechotestwithinterval" class="tsd-kind-icon">start<wbr>Echo<wbr>Test<wbr>With<wbr>Interval</a></li>
  208. <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>
  209. <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>
  210. <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>
  211. <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>
  212. <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>
  213. <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>
  214. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="rtcengine.html#stoplastmileprobetest" class="tsd-kind-icon">stop<wbr>Lastmile<wbr>Probe<wbr>Test</a></li>
  215. <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>
  216. <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>
  217. <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>
  218. </ul>
  219. </section>
  220. </div>
  221. </section>
  222. </section>
  223. <section class="tsd-panel-group tsd-member-group ">
  224. <h2>Events</h2>
  225. <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
  226. <a name="startlastmileprobetest" class="tsd-anchor"></a>
  227. <h3><span class="tsd-flag ts-flagStatic">Static</span> start<wbr>Lastmile<wbr>Probe<wbr>Test</h3>
  228. <ul class="tsd-signatures tsd-kind-event tsd-parent-kind-class tsd-is-static">
  229. <li class="tsd-signature tsd-kind-icon">start<wbr>Lastmile<wbr>Probe<wbr>Test<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LastmileProbeConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  230. </ul>
  231. <ul class="tsd-descriptions">
  232. <li class="tsd-description">
  233. <aside class="tsd-sources">
  234. <ul>
  235. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1296">RtcEngine.native.ts:1296</a></li>
  236. </ul>
  237. </aside>
  238. <div class="tsd-comment tsd-typography">
  239. <div class="lead">
  240. <p>start the lastmile probe test</p>
  241. </div>
  242. <p>This method start the last-mile network probe test before joining a channel to get the uplink and downlink last-mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT).</p>
  243. </div>
  244. <h4 class="tsd-parameters-title">Parameters</h4>
  245. <ul class="tsd-parameters">
  246. <li>
  247. <h5>config: <span class="tsd-signature-type">LastmileProbeConfig</span></h5>
  248. <div class="tsd-comment tsd-typography">
  249. <p>LastmileProbeConfig {@link LastmileProbeConfig}</p>
  250. </div>
  251. </li>
  252. </ul>
  253. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  254. <p>Promise&lt;{success, value}&gt;</p>
  255. </li>
  256. </ul>
  257. </section>
  258. </section>
  259. <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
  260. <h2>Properties</h2>
  261. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
  262. <a name="eventtypes" class="tsd-anchor"></a>
  263. <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> event<wbr>Types</h3>
  264. <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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> =&nbsp;new Set&lt;string&gt;()</span></div>
  265. <aside class="tsd-sources">
  266. <ul>
  267. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L43">RtcEngine.native.ts:43</a></li>
  268. </ul>
  269. </aside>
  270. </section>
  271. </section>
  272. <section class="tsd-panel-group tsd-member-group ">
  273. <h2>Methods</h2>
  274. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  275. <a name="addinjectstreamurl" class="tsd-anchor"></a>
  276. <h3><span class="tsd-flag ts-flagStatic">Static</span> add<wbr>Inject<wbr>Stream<wbr>Url</h3>
  277. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  278. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  279. </ul>
  280. <ul class="tsd-descriptions">
  281. <li class="tsd-description">
  282. <aside class="tsd-sources">
  283. <ul>
  284. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L932">RtcEngine.native.ts:932</a></li>
  285. </ul>
  286. </aside>
  287. <div class="tsd-comment tsd-typography">
  288. <div class="lead">
  289. <p>add inject stream url</p>
  290. </div>
  291. <p>This method injects an online media stream to a live broadcast.</p>
  292. </div>
  293. <h4 class="tsd-parameters-title">Parameters</h4>
  294. <ul class="tsd-parameters">
  295. <li>
  296. <h5>options: <span class="tsd-signature-type">InjectStreamOption</span></h5>
  297. </li>
  298. </ul>
  299. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  300. <p>Promise&lt;{success, value}&gt;</p>
  301. </li>
  302. </ul>
  303. </section>
  304. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  305. <a name="addpublishstreamurl" class="tsd-anchor"></a>
  306. <h3><span class="tsd-flag ts-flagStatic">Static</span> add<wbr>Publish<wbr>Stream<wbr>Url</h3>
  307. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  308. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  309. </ul>
  310. <ul class="tsd-descriptions">
  311. <li class="tsd-description">
  312. <aside class="tsd-sources">
  313. <ul>
  314. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1157">RtcEngine.native.ts:1157</a></li>
  315. </ul>
  316. </aside>
  317. <div class="tsd-comment tsd-typography">
  318. <div class="lead">
  319. <p>add publish stream url</p>
  320. </div>
  321. <p>This method add publish stream by option.</p>
  322. </div>
  323. <h4 class="tsd-parameters-title">Parameters</h4>
  324. <ul class="tsd-parameters">
  325. <li>
  326. <h5>options: <span class="tsd-signature-type">PublishStreamOption</span></h5>
  327. </li>
  328. </ul>
  329. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  330. <p>Promise&lt;{success, value}&gt;</p>
  331. </li>
  332. </ul>
  333. </section>
  334. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  335. <a name="addvideowatermark" class="tsd-anchor"></a>
  336. <h3><span class="tsd-flag ts-flagStatic">Static</span> add<wbr>Video<wbr>Watermark</h3>
  337. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  338. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  339. </ul>
  340. <ul class="tsd-descriptions">
  341. <li class="tsd-description">
  342. <aside class="tsd-sources">
  343. <ul>
  344. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L849">RtcEngine.native.ts:849</a></li>
  345. </ul>
  346. </aside>
  347. <div class="tsd-comment tsd-typography">
  348. <div class="lead">
  349. <p>add video watermark</p>
  350. </div>
  351. <p>This method adds video watermark to the local video.</p>
  352. </div>
  353. <h4 class="tsd-parameters-title">Parameters</h4>
  354. <ul class="tsd-parameters">
  355. <li>
  356. <h5>options: <span class="tsd-signature-type">ImageOption</span></h5>
  357. </li>
  358. </ul>
  359. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  360. <p>Promise&lt;{success, value}&gt;</p>
  361. </li>
  362. </ul>
  363. </section>
  364. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  365. <a name="adjustaudiomixingplayoutvolume" class="tsd-anchor"></a>
  366. <h3><span class="tsd-flag ts-flagStatic">Static</span> adjust<wbr>Audio<wbr>Mixing<wbr>Playout<wbr>Volume</h3>
  367. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  368. <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>
  369. </ul>
  370. <ul class="tsd-descriptions">
  371. <li class="tsd-description">
  372. <aside class="tsd-sources">
  373. <ul>
  374. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L555">RtcEngine.native.ts:555</a></li>
  375. </ul>
  376. </aside>
  377. <div class="tsd-comment tsd-typography">
  378. <div class="lead">
  379. <p>adjust audio mixing playout volume</p>
  380. </div>
  381. <p>This method adjusts audio mixing playout by the volume parameter</p>
  382. </div>
  383. <h4 class="tsd-parameters-title">Parameters</h4>
  384. <ul class="tsd-parameters">
  385. <li>
  386. <h5>volume: <span class="tsd-signature-type">number</span></h5>
  387. <div class="tsd-comment tsd-typography">
  388. </div>
  389. </li>
  390. </ul>
  391. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  392. </li>
  393. </ul>
  394. </section>
  395. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  396. <a name="adjustaudiomixingpublishvolume" class="tsd-anchor"></a>
  397. <h3><span class="tsd-flag ts-flagStatic">Static</span> adjust<wbr>Audio<wbr>Mixing<wbr>Publish<wbr>Volume</h3>
  398. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  399. <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>
  400. </ul>
  401. <ul class="tsd-descriptions">
  402. <li class="tsd-description">
  403. <aside class="tsd-sources">
  404. <ul>
  405. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L565">RtcEngine.native.ts:565</a></li>
  406. </ul>
  407. </aside>
  408. <div class="tsd-comment tsd-typography">
  409. <div class="lead">
  410. <p>adjust audio mixing publish volume</p>
  411. </div>
  412. <p>This method adjusts audio mixing publish by the volume paraemter</p>
  413. </div>
  414. <h4 class="tsd-parameters-title">Parameters</h4>
  415. <ul class="tsd-parameters">
  416. <li>
  417. <h5>volume: <span class="tsd-signature-type">number</span></h5>
  418. <div class="tsd-comment tsd-typography">
  419. </div>
  420. </li>
  421. </ul>
  422. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  423. </li>
  424. </ul>
  425. </section>
  426. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  427. <a name="adjustaudiomixingvolume" class="tsd-anchor"></a>
  428. <h3><span class="tsd-flag ts-flagStatic">Static</span> adjust<wbr>Audio<wbr>Mixing<wbr>Volume</h3>
  429. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  430. <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>
  431. </ul>
  432. <ul class="tsd-descriptions">
  433. <li class="tsd-description">
  434. <aside class="tsd-sources">
  435. <ul>
  436. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L545">RtcEngine.native.ts:545</a></li>
  437. </ul>
  438. </aside>
  439. <div class="tsd-comment tsd-typography">
  440. <div class="lead">
  441. <p>adjust audio mixing volume</p>
  442. </div>
  443. <p>This method adjusts audio mixing volume by the volume number parameter</p>
  444. </div>
  445. <h4 class="tsd-parameters-title">Parameters</h4>
  446. <ul class="tsd-parameters">
  447. <li>
  448. <h5>volume: <span class="tsd-signature-type">number</span></h5>
  449. <div class="tsd-comment tsd-typography">
  450. </div>
  451. </li>
  452. </ul>
  453. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  454. </li>
  455. </ul>
  456. </section>
  457. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  458. <a name="adjustplaybacksignalvolume" class="tsd-anchor"></a>
  459. <h3><span class="tsd-flag ts-flagStatic">Static</span> adjust<wbr>Playback<wbr>Signal<wbr>Volume</h3>
  460. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  461. <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>
  462. </ul>
  463. <ul class="tsd-descriptions">
  464. <li class="tsd-description">
  465. <aside class="tsd-sources">
  466. <ul>
  467. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L409">RtcEngine.native.ts:409</a></li>
  468. </ul>
  469. </aside>
  470. <div class="tsd-comment tsd-typography">
  471. <div class="lead">
  472. <p>adjust playback signal volume</p>
  473. </div>
  474. <p>This method adjusts playback signal by volume.</p>
  475. </div>
  476. <h4 class="tsd-parameters-title">Parameters</h4>
  477. <ul class="tsd-parameters">
  478. <li>
  479. <h5>volume: <span class="tsd-signature-type">number</span></h5>
  480. <div class="tsd-comment tsd-typography">
  481. </div>
  482. </li>
  483. </ul>
  484. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  485. </li>
  486. </ul>
  487. </section>
  488. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  489. <a name="adjustrecordingsignalvolume" class="tsd-anchor"></a>
  490. <h3><span class="tsd-flag ts-flagStatic">Static</span> adjust<wbr>Recording<wbr>Signal<wbr>Volume</h3>
  491. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  492. <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>
  493. </ul>
  494. <ul class="tsd-descriptions">
  495. <li class="tsd-description">
  496. <aside class="tsd-sources">
  497. <ul>
  498. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L399">RtcEngine.native.ts:399</a></li>
  499. </ul>
  500. </aside>
  501. <div class="tsd-comment tsd-typography">
  502. <div class="lead">
  503. <p>adjust recording signal volume</p>
  504. </div>
  505. <p>This method adjusts recording your signal by volume.</p>
  506. </div>
  507. <h4 class="tsd-parameters-title">Parameters</h4>
  508. <ul class="tsd-parameters">
  509. <li>
  510. <h5>volume: <span class="tsd-signature-type">number</span></h5>
  511. <div class="tsd-comment tsd-typography">
  512. </div>
  513. </li>
  514. </ul>
  515. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  516. </li>
  517. </ul>
  518. </section>
  519. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  520. <a name="createdatastream" class="tsd-anchor"></a>
  521. <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Data<wbr>Stream</h3>
  522. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  523. <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>
  524. </ul>
  525. <ul class="tsd-descriptions">
  526. <li class="tsd-description">
  527. <aside class="tsd-sources">
  528. <ul>
  529. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L431">RtcEngine.native.ts:431</a></li>
  530. </ul>
  531. </aside>
  532. <div class="tsd-comment tsd-typography">
  533. <div class="lead">
  534. <p>create data stream</p>
  535. </div>
  536. <p>This method creates data stream with options</p>
  537. </div>
  538. <h4 class="tsd-parameters-title">Parameters</h4>
  539. <ul class="tsd-parameters">
  540. <li>
  541. <h5>options: <span class="tsd-signature-type">DataStreamOption</span></h5>
  542. <div class="tsd-comment tsd-typography">
  543. </div>
  544. </li>
  545. </ul>
  546. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
  547. </li>
  548. </ul>
  549. </section>
  550. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  551. <a name="destroy" class="tsd-anchor"></a>
  552. <h3><span class="tsd-flag ts-flagStatic">Static</span> destroy</h3>
  553. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  554. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  555. </ul>
  556. <ul class="tsd-descriptions">
  557. <li class="tsd-description">
  558. <aside class="tsd-sources">
  559. <ul>
  560. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L169">RtcEngine.native.ts:169</a></li>
  561. </ul>
  562. </aside>
  563. <div class="tsd-comment tsd-typography">
  564. <div class="lead">
  565. <p>destroy</p>
  566. </div>
  567. <p>This method stops event subscribe and destroy the RtcEngine instance&#39;s.
  568. You should call it, when you want to destroy the engine.</p>
  569. </div>
  570. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  571. <p>Promise&lt;{success, value}&gt;</p>
  572. </li>
  573. </ul>
  574. </section>
  575. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  576. <a name="disableaudio" class="tsd-anchor"></a>
  577. <h3><span class="tsd-flag ts-flagStatic">Static</span> disable<wbr>Audio</h3>
  578. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  579. <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>
  580. </ul>
  581. <ul class="tsd-descriptions">
  582. <li class="tsd-description">
  583. <aside class="tsd-sources">
  584. <ul>
  585. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L349">RtcEngine.native.ts:349</a></li>
  586. </ul>
  587. </aside>
  588. <div class="tsd-comment tsd-typography">
  589. <div class="lead">
  590. <p>disable audio</p>
  591. </div>
  592. <p>This method disables audio</p>
  593. </div>
  594. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  595. </li>
  596. </ul>
  597. </section>
  598. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  599. <a name="disablelastmiletest" class="tsd-anchor"></a>
  600. <h3><span class="tsd-flag ts-flagStatic">Static</span> disable<wbr>Lastmile<wbr>Test</h3>
  601. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  602. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  603. </ul>
  604. <ul class="tsd-descriptions">
  605. <li class="tsd-description">
  606. <aside class="tsd-sources">
  607. <ul>
  608. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L801">RtcEngine.native.ts:801</a></li>
  609. </ul>
  610. </aside>
  611. <div class="tsd-comment tsd-typography">
  612. <div class="lead">
  613. <p>disable lastmile test</p>
  614. </div>
  615. <p>This method disable the network connection qualit test.</p>
  616. </div>
  617. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  618. <p>Promise&lt;{success, value}&gt;</p>
  619. </li>
  620. </ul>
  621. </section>
  622. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  623. <a name="disablelocalaudio" class="tsd-anchor"></a>
  624. <h3><span class="tsd-flag ts-flagStatic">Static</span> disable<wbr>Local<wbr>Audio</h3>
  625. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  626. <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>
  627. </ul>
  628. <ul class="tsd-descriptions">
  629. <li class="tsd-description">
  630. <aside class="tsd-sources">
  631. <ul>
  632. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L369">RtcEngine.native.ts:369</a></li>
  633. </ul>
  634. </aside>
  635. <div class="tsd-comment tsd-typography">
  636. <div class="lead">
  637. <p>mute local audio stream</p>
  638. </div>
  639. <p>This method mutes the local audio stream by muted.</p>
  640. </div>
  641. <h4 class="tsd-parameters-title">Parameters</h4>
  642. <ul class="tsd-parameters">
  643. <li>
  644. <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
  645. <div class="tsd-comment tsd-typography">
  646. </div>
  647. </li>
  648. </ul>
  649. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  650. </li>
  651. </ul>
  652. </section>
  653. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  654. <a name="disablevideo" class="tsd-anchor"></a>
  655. <h3><span class="tsd-flag ts-flagStatic">Static</span> disable<wbr>Video</h3>
  656. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  657. <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>
  658. </ul>
  659. <ul class="tsd-descriptions">
  660. <li class="tsd-description">
  661. <aside class="tsd-sources">
  662. <ul>
  663. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L280">RtcEngine.native.ts:280</a></li>
  664. </ul>
  665. </aside>
  666. <div class="tsd-comment tsd-typography">
  667. <div class="lead">
  668. <p>disable video</p>
  669. </div>
  670. <p>This method disables video.</p>
  671. </div>
  672. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  673. </li>
  674. </ul>
  675. </section>
  676. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  677. <a name="enableaudio" class="tsd-anchor"></a>
  678. <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Audio</h3>
  679. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  680. <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>
  681. </ul>
  682. <ul class="tsd-descriptions">
  683. <li class="tsd-description">
  684. <aside class="tsd-sources">
  685. <ul>
  686. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L340">RtcEngine.native.ts:340</a></li>
  687. </ul>
  688. </aside>
  689. <div class="tsd-comment tsd-typography">
  690. <div class="lead">
  691. <p>enable audio</p>
  692. </div>
  693. <p>This method enables audio</p>
  694. </div>
  695. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  696. </li>
  697. </ul>
  698. </section>
  699. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  700. <a name="enableaudiovolumeindication" class="tsd-anchor"></a>
  701. <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Audio<wbr>Volume<wbr>Indication</h3>
  702. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  703. <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>
  704. </ul>
  705. <ul class="tsd-descriptions">
  706. <li class="tsd-description">
  707. <aside class="tsd-sources">
  708. <ul>
  709. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L420">RtcEngine.native.ts:420</a></li>
  710. </ul>
  711. </aside>
  712. <div class="tsd-comment tsd-typography">
  713. <div class="lead">
  714. <p>enable audio volume indication</p>
  715. </div>
  716. <p>This method enables audio volume by interval and smooth</p>
  717. </div>
  718. <h4 class="tsd-parameters-title">Parameters</h4>
  719. <ul class="tsd-parameters">
  720. <li>
  721. <h5>interval: <span class="tsd-signature-type">number</span></h5>
  722. </li>
  723. <li>
  724. <h5>smooth: <span class="tsd-signature-type">number</span></h5>
  725. <div class="tsd-comment tsd-typography">
  726. </div>
  727. </li>
  728. </ul>
  729. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  730. </li>
  731. </ul>
  732. </section>
  733. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  734. <a name="enabledualstreammode" class="tsd-anchor"></a>
  735. <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Dual<wbr>Stream<wbr>Mode</h3>
  736. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  737. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  738. </ul>
  739. <ul class="tsd-descriptions">
  740. <li class="tsd-description">
  741. <aside class="tsd-sources">
  742. <ul>
  743. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L896">RtcEngine.native.ts:896</a></li>
  744. </ul>
  745. </aside>
  746. <div class="tsd-comment tsd-typography">
  747. <div class="lead">
  748. <p>enable dual stream mode</p>
  749. </div>
  750. <p>This method enables the dual stream by parameter mode.</p>
  751. </div>
  752. <h4 class="tsd-parameters-title">Parameters</h4>
  753. <ul class="tsd-parameters">
  754. <li>
  755. <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
  756. </li>
  757. </ul>
  758. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  759. <p>Promise&lt;{success, value}&gt;</p>
  760. </li>
  761. </ul>
  762. </section>
  763. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  764. <a name="enableinearmonitoring" class="tsd-anchor"></a>
  765. <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>InEar<wbr>Monitoring</h3>
  766. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  767. <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>
  768. </ul>
  769. <ul class="tsd-descriptions">
  770. <li class="tsd-description">
  771. <aside class="tsd-sources">
  772. <ul>
  773. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L452">RtcEngine.native.ts:452</a></li>
  774. </ul>
  775. </aside>
  776. <div class="tsd-comment tsd-typography">
  777. <div class="lead">
  778. <p>enable in-ear monitor</p>
  779. </div>
  780. <p>This method enables in-ear monitoring by boolean parameter enabled</p>
  781. </div>
  782. <h4 class="tsd-parameters-title">Parameters</h4>
  783. <ul class="tsd-parameters">
  784. <li>
  785. <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
  786. <div class="tsd-comment tsd-typography">
  787. </div>
  788. </li>
  789. </ul>
  790. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  791. </li>
  792. </ul>
  793. </section>
  794. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  795. <a name="enablelastmiletest" class="tsd-anchor"></a>
  796. <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Lastmile<wbr>Test</h3>
  797. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  798. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  799. </ul>
  800. <ul class="tsd-descriptions">
  801. <li class="tsd-description">
  802. <aside class="tsd-sources">
  803. <ul>
  804. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L790">RtcEngine.native.ts:790</a></li>
  805. </ul>
  806. </aside>
  807. <div class="tsd-comment tsd-typography">
  808. <div class="lead">
  809. <p>enable lastmile test</p>
  810. </div>
  811. <p>This method enables the network connection qualit test.</p>
  812. </div>
  813. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  814. <p>Promise&lt;{success, value}&gt;</p>
  815. </li>
  816. </ul>
  817. </section>
  818. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  819. <a name="enablelocalaudio" class="tsd-anchor"></a>
  820. <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Local<wbr>Audio</h3>
  821. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  822. <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>
  823. </ul>
  824. <ul class="tsd-descriptions">
  825. <li class="tsd-description">
  826. <aside class="tsd-sources">
  827. <ul>
  828. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L359">RtcEngine.native.ts:359</a></li>
  829. </ul>
  830. </aside>
  831. <div class="tsd-comment tsd-typography">
  832. <div class="lead">
  833. <p>enable local audio</p>
  834. </div>
  835. <p>This method enables local audio by the boolean parameter.</p>
  836. </div>
  837. <h4 class="tsd-parameters-title">Parameters</h4>
  838. <ul class="tsd-parameters">
  839. <li>
  840. <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
  841. <div class="tsd-comment tsd-typography">
  842. </div>
  843. </li>
  844. </ul>
  845. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  846. </li>
  847. </ul>
  848. </section>
  849. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  850. <a name="enablelocalvideo" class="tsd-anchor"></a>
  851. <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Local<wbr>Video</h3>
  852. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  853. <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>
  854. </ul>
  855. <ul class="tsd-descriptions">
  856. <li class="tsd-description">
  857. <aside class="tsd-sources">
  858. <ul>
  859. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L290">RtcEngine.native.ts:290</a></li>
  860. </ul>
  861. </aside>
  862. <div class="tsd-comment tsd-typography">
  863. <div class="lead">
  864. <p>enable local video</p>
  865. </div>
  866. <p>This method enables the local video by the boolean parameter.</p>
  867. </div>
  868. <h4 class="tsd-parameters-title">Parameters</h4>
  869. <ul class="tsd-parameters">
  870. <li>
  871. <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
  872. <div class="tsd-comment tsd-typography">
  873. </div>
  874. </li>
  875. </ul>
  876. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  877. </li>
  878. </ul>
  879. </section>
  880. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  881. <a name="enablesoundpositionindication" class="tsd-anchor"></a>
  882. <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Sound<wbr>Position<wbr>Indication</h3>
  883. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  884. <li class="tsd-signature tsd-kind-icon">enable<wbr>Sound<wbr>Position<wbr>Indication<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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  885. </ul>
  886. <ul class="tsd-descriptions">
  887. <li class="tsd-description">
  888. <aside class="tsd-sources">
  889. <ul>
  890. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1263">RtcEngine.native.ts:1263</a></li>
  891. </ul>
  892. </aside>
  893. <div class="tsd-comment tsd-typography">
  894. <div class="lead">
  895. <p>control stereo panning for remote users</p>
  896. </div>
  897. <p>This method enables/disables stereo panning for remote users.</p>
  898. </div>
  899. <h4 class="tsd-parameters-title">Parameters</h4>
  900. <ul class="tsd-parameters">
  901. <li>
  902. <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
  903. <div class="tsd-comment tsd-typography">
  904. <p>boolean</p>
  905. </div>
  906. </li>
  907. </ul>
  908. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  909. <p>Promise&lt;{success, value}&gt;</p>
  910. </li>
  911. </ul>
  912. </section>
  913. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  914. <a name="enablevideo" class="tsd-anchor"></a>
  915. <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Video</h3>
  916. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  917. <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>
  918. </ul>
  919. <ul class="tsd-descriptions">
  920. <li class="tsd-description">
  921. <aside class="tsd-sources">
  922. <ul>
  923. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L271">RtcEngine.native.ts:271</a></li>
  924. </ul>
  925. </aside>
  926. <div class="tsd-comment tsd-typography">
  927. <div class="lead">
  928. <p>enable video</p>
  929. </div>
  930. <p>This method enables video.</p>
  931. </div>
  932. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  933. </li>
  934. </ul>
  935. </section>
  936. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  937. <a name="enablewebsdkinteroperability" class="tsd-anchor"></a>
  938. <h3><span class="tsd-flag ts-flagStatic">Static</span> enable<wbr>Web<wbr>Sdk<wbr>Interoperability</h3>
  939. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  940. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  941. </ul>
  942. <ul class="tsd-descriptions">
  943. <li class="tsd-description">
  944. <aside class="tsd-sources">
  945. <ul>
  946. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L125">RtcEngine.native.ts:125</a></li>
  947. </ul>
  948. </aside>
  949. <div class="tsd-comment tsd-typography">
  950. <div class="lead">
  951. <p>enable websdk interoperability</p>
  952. </div>
  953. <p>This method used to enable websdk interoperability, so that it can connect with agora websdk apps.</p>
  954. </div>
  955. <h4 class="tsd-parameters-title">Parameters</h4>
  956. <ul class="tsd-parameters">
  957. <li>
  958. <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
  959. </li>
  960. </ul>
  961. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  962. <p>Promise&lt;{success, value}&gt;</p>
  963. </li>
  964. </ul>
  965. </section>
  966. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  967. <a name="getaudiomixingcurrentposition" class="tsd-anchor"></a>
  968. <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Audio<wbr>Mixing<wbr>Current<wbr>Position</h3>
  969. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  970. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  971. </ul>
  972. <ul class="tsd-descriptions">
  973. <li class="tsd-description">
  974. <aside class="tsd-sources">
  975. <ul>
  976. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L585">RtcEngine.native.ts:585</a></li>
  977. </ul>
  978. </aside>
  979. <div class="tsd-comment tsd-typography">
  980. <div class="lead">
  981. <p>get audio mixing current position</p>
  982. </div>
  983. <p>This method gets audio mixing current position value.</p>
  984. </div>
  985. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  986. <p>Promise&lt;{success, value}&gt;</p>
  987. </li>
  988. </ul>
  989. </section>
  990. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  991. <a name="getaudiomixingduration" class="tsd-anchor"></a>
  992. <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Audio<wbr>Mixing<wbr>Duration</h3>
  993. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  994. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  995. </ul>
  996. <ul class="tsd-descriptions">
  997. <li class="tsd-description">
  998. <aside class="tsd-sources">
  999. <ul>
  1000. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L575">RtcEngine.native.ts:575</a></li>
  1001. </ul>
  1002. </aside>
  1003. <div class="tsd-comment tsd-typography">
  1004. <div class="lead">
  1005. <p>get audio mixing duration</p>
  1006. </div>
  1007. <p>This method gets the audio mixing duration</p>
  1008. </div>
  1009. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1010. <p>Promise&lt;{success, value}&gt;</p>
  1011. </li>
  1012. </ul>
  1013. </section>
  1014. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1015. <a name="getcallid" class="tsd-anchor"></a>
  1016. <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Call<wbr>Id</h3>
  1017. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1018. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1019. </ul>
  1020. <ul class="tsd-descriptions">
  1021. <li class="tsd-description">
  1022. <aside class="tsd-sources">
  1023. <ul>
  1024. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1118">RtcEngine.native.ts:1118</a></li>
  1025. </ul>
  1026. </aside>
  1027. <div class="tsd-comment tsd-typography">
  1028. <div class="lead">
  1029. <p>get call id</p>
  1030. </div>
  1031. <p>This method is used to get call id.</p>
  1032. </div>
  1033. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1034. <p>Promise&lt;{success, value}&gt;</p>
  1035. </li>
  1036. </ul>
  1037. </section>
  1038. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1039. <a name="getcameramaxzoomfactor" class="tsd-anchor"></a>
  1040. <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Camera<wbr>Max<wbr>Zoom<wbr>Factor</h3>
  1041. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1042. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1043. </ul>
  1044. <ul class="tsd-descriptions">
  1045. <li class="tsd-description">
  1046. <aside class="tsd-sources">
  1047. <ul>
  1048. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1059">RtcEngine.native.ts:1059</a></li>
  1049. </ul>
  1050. </aside>
  1051. <div class="tsd-comment tsd-typography">
  1052. <div class="lead">
  1053. <p>get camera max zoom ratio</p>
  1054. </div>
  1055. <p>This method gets the camera maximum zoom ratio.</p>
  1056. <dl class="tsd-comment-tags">
  1057. <dt>notice</dt>
  1058. <dd><p>Android Only</p>
  1059. </dd>
  1060. </dl>
  1061. </div>
  1062. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1063. <p>Promise&lt;{success, value}&gt;</p>
  1064. </li>
  1065. </ul>
  1066. </section>
  1067. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1068. <a name="getconnectionstate" class="tsd-anchor"></a>
  1069. <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Connection<wbr>State</h3>
  1070. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1071. <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>
  1072. </ul>
  1073. <ul class="tsd-descriptions">
  1074. <li class="tsd-description">
  1075. <aside class="tsd-sources">
  1076. <ul>
  1077. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L135">RtcEngine.native.ts:135</a></li>
  1078. </ul>
  1079. </aside>
  1080. <div class="tsd-comment tsd-typography">
  1081. <div class="lead">
  1082. <p>get agora native sdk connection state</p>
  1083. </div>
  1084. <p>This method gets agora native sdk connection state</p>
  1085. </div>
  1086. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
  1087. <p>Promise&lt;{success: true, state: (connection state)}&gt;</p>
  1088. </li>
  1089. </ul>
  1090. </section>
  1091. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1092. <a name="geteffectsvolume" class="tsd-anchor"></a>
  1093. <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Effects<wbr>Volume</h3>
  1094. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1095. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1096. </ul>
  1097. <ul class="tsd-descriptions">
  1098. <li class="tsd-description">
  1099. <aside class="tsd-sources">
  1100. <ul>
  1101. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L605">RtcEngine.native.ts:605</a></li>
  1102. </ul>
  1103. </aside>
  1104. <div class="tsd-comment tsd-typography">
  1105. <div class="lead">
  1106. <p>get effects of volume</p>
  1107. </div>
  1108. <p>This methods get audio mixing effects volume value.</p>
  1109. </div>
  1110. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1111. <p>Promise&lt;{success, value}&gt;</p>
  1112. </li>
  1113. </ul>
  1114. </section>
  1115. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1116. <a name="getsdkversion" class="tsd-anchor"></a>
  1117. <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Sdk<wbr>Version</h3>
  1118. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1119. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span>, errorHandler<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
  1120. </ul>
  1121. <ul class="tsd-descriptions">
  1122. <li class="tsd-description">
  1123. <aside class="tsd-sources">
  1124. <ul>
  1125. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1193">RtcEngine.native.ts:1193</a></li>
  1126. </ul>
  1127. </aside>
  1128. <div class="tsd-comment tsd-typography">
  1129. <div class="lead">
  1130. <p>get sdk version</p>
  1131. </div>
  1132. <p>This method gets the sdk version details and passed it into callback function</p>
  1133. </div>
  1134. <h4 class="tsd-parameters-title">Parameters</h4>
  1135. <ul class="tsd-parameters">
  1136. <li>
  1137. <h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
  1138. <div class="tsd-comment tsd-typography">
  1139. <p>to handle resolve from getSdkVersion</p>
  1140. </div>
  1141. </li>
  1142. <li>
  1143. <h5><span class="tsd-flag ts-flagOptional">Optional</span> errorHandler: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
  1144. <div class="tsd-comment tsd-typography">
  1145. <p>to handle reject error from getSdkVersion</p>
  1146. </div>
  1147. </li>
  1148. </ul>
  1149. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
  1150. </li>
  1151. </ul>
  1152. </section>
  1153. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1154. <a name="init" class="tsd-anchor"></a>
  1155. <h3><span class="tsd-flag ts-flagStatic">Static</span> init</h3>
  1156. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1157. <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>
  1158. </ul>
  1159. <ul class="tsd-descriptions">
  1160. <li class="tsd-description">
  1161. <aside class="tsd-sources">
  1162. <ul>
  1163. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L52">RtcEngine.native.ts:52</a></li>
  1164. </ul>
  1165. </aside>
  1166. <div class="tsd-comment tsd-typography">
  1167. <div class="lead">
  1168. <p>Creates a RtcEngine Object internal.</p>
  1169. </div>
  1170. <p>This method creates and start event observer. You should call this method once.</p>
  1171. <dl class="tsd-comment-tags">
  1172. <dt>example</dt>
  1173. <dd><p><code>RtcEngine.init(option)</code></p>
  1174. </dd>
  1175. </dl>
  1176. </div>
  1177. <h4 class="tsd-parameters-title">Parameters</h4>
  1178. <ul class="tsd-parameters">
  1179. <li>
  1180. <h5>options: <span class="tsd-signature-type">Option</span></h5>
  1181. <div class="tsd-comment tsd-typography">
  1182. <p>Defines the property of the client, see {@link Option} for details.</p>
  1183. </div>
  1184. </li>
  1185. </ul>
  1186. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1187. </li>
  1188. </ul>
  1189. </section>
  1190. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1191. <a name="iscameraautofocusfacemodesupported" class="tsd-anchor"></a>
  1192. <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Camera<wbr>Auto<wbr>Focus<wbr>Face<wbr>Mode<wbr>Supported</h3>
  1193. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1194. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1195. </ul>
  1196. <ul class="tsd-descriptions">
  1197. <li class="tsd-description">
  1198. <aside class="tsd-sources">
  1199. <ul>
  1200. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1035">RtcEngine.native.ts:1035</a></li>
  1201. </ul>
  1202. </aside>
  1203. <div class="tsd-comment tsd-typography">
  1204. <div class="lead">
  1205. <p>is camera auto focus face mode supported</p>
  1206. </div>
  1207. <p>This method checks whether the camera mannual auto-face focus function is supported.</p>
  1208. </div>
  1209. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1210. <p>Promise&lt;{success, value}&gt;</p>
  1211. </li>
  1212. </ul>
  1213. </section>
  1214. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1215. <a name="iscameraexposurepositionsupported" class="tsd-anchor"></a>
  1216. <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Camera<wbr>Exposure<wbr>Position<wbr>Supported</h3>
  1217. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1218. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1219. </ul>
  1220. <ul class="tsd-descriptions">
  1221. <li class="tsd-description">
  1222. <aside class="tsd-sources">
  1223. <ul>
  1224. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1024">RtcEngine.native.ts:1024</a></li>
  1225. </ul>
  1226. </aside>
  1227. <div class="tsd-comment tsd-typography">
  1228. <div class="lead">
  1229. <p>is camera exposure position supported</p>
  1230. </div>
  1231. <p>This method checks whether the camera mannual exposure function is supported.</p>
  1232. </div>
  1233. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1234. <p>Promise&lt;{success, value}&gt;</p>
  1235. </li>
  1236. </ul>
  1237. </section>
  1238. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1239. <a name="iscamerafocussupported" class="tsd-anchor"></a>
  1240. <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Camera<wbr>Focus<wbr>Supported</h3>
  1241. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1242. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1243. </ul>
  1244. <ul class="tsd-descriptions">
  1245. <li class="tsd-description">
  1246. <aside class="tsd-sources">
  1247. <ul>
  1248. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1013">RtcEngine.native.ts:1013</a></li>
  1249. </ul>
  1250. </aside>
  1251. <div class="tsd-comment tsd-typography">
  1252. <div class="lead">
  1253. <p>is camera focus supported</p>
  1254. </div>
  1255. <p>This method checks whether the camera mannual focus function is supported.</p>
  1256. </div>
  1257. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1258. <p>Promise&lt;{success, value}&gt;</p>
  1259. </li>
  1260. </ul>
  1261. </section>
  1262. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1263. <a name="iscameratorchsupported" class="tsd-anchor"></a>
  1264. <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Camera<wbr>Torch<wbr>Supported</h3>
  1265. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1266. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1267. </ul>
  1268. <ul class="tsd-descriptions">
  1269. <li class="tsd-description">
  1270. <aside class="tsd-sources">
  1271. <ul>
  1272. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1002">RtcEngine.native.ts:1002</a></li>
  1273. </ul>
  1274. </aside>
  1275. <div class="tsd-comment tsd-typography">
  1276. <div class="lead">
  1277. <p>is camera torch supported</p>
  1278. </div>
  1279. <p>This method checks whether the camera flash function is supported.</p>
  1280. </div>
  1281. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1282. <p>Promise&lt;{success, value}&gt;</p>
  1283. </li>
  1284. </ul>
  1285. </section>
  1286. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1287. <a name="iscamerazoomsupported" class="tsd-anchor"></a>
  1288. <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Camera<wbr>Zoom<wbr>Supported</h3>
  1289. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1290. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1291. </ul>
  1292. <ul class="tsd-descriptions">
  1293. <li class="tsd-description">
  1294. <aside class="tsd-sources">
  1295. <ul>
  1296. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L991">RtcEngine.native.ts:991</a></li>
  1297. </ul>
  1298. </aside>
  1299. <div class="tsd-comment tsd-typography">
  1300. <div class="lead">
  1301. <p>is camera zoom supported</p>
  1302. </div>
  1303. <p>This method checks whether the camera zoom function is supported.</p>
  1304. </div>
  1305. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1306. <p>Promise&lt;{success, value}&gt;</p>
  1307. </li>
  1308. </ul>
  1309. </section>
  1310. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1311. <a name="joinchannel" class="tsd-anchor"></a>
  1312. <h3><span class="tsd-flag ts-flagStatic">Static</span> join<wbr>Channel</h3>
  1313. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1314. <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>
  1315. </ul>
  1316. <ul class="tsd-descriptions">
  1317. <li class="tsd-description">
  1318. <aside class="tsd-sources">
  1319. <ul>
  1320. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L66">RtcEngine.native.ts:66</a></li>
  1321. </ul>
  1322. </aside>
  1323. <div class="tsd-comment tsd-typography">
  1324. <div class="lead">
  1325. <p>join specified channel</p>
  1326. </div>
  1327. <p>This method joins and begin rendering the video stream. when join succeeds.
  1328. Otherwise, it will invoke error by the event</p>
  1329. </div>
  1330. <h4 class="tsd-parameters-title">Parameters</h4>
  1331. <ul class="tsd-parameters">
  1332. <li>
  1333. <h5>channelName: <span class="tsd-signature-type">string</span></h5>
  1334. </li>
  1335. <li>
  1336. <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>
  1337. </li>
  1338. <li>
  1339. <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>
  1340. </li>
  1341. <li>
  1342. <h5><span class="tsd-flag ts-flagOptional">Optional</span> info: <span class="tsd-signature-type">Object</span></h5>
  1343. <div class="tsd-comment tsd-typography">
  1344. </div>
  1345. </li>
  1346. </ul>
  1347. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1348. </li>
  1349. </ul>
  1350. </section>
  1351. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1352. <a name="leavechannel" class="tsd-anchor"></a>
  1353. <h3><span class="tsd-flag ts-flagStatic">Static</span> leave<wbr>Channel</h3>
  1354. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1355. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1356. </ul>
  1357. <ul class="tsd-descriptions">
  1358. <li class="tsd-description">
  1359. <aside class="tsd-sources">
  1360. <ul>
  1361. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L157">RtcEngine.native.ts:157</a></li>
  1362. </ul>
  1363. </aside>
  1364. <div class="tsd-comment tsd-typography">
  1365. <div class="lead">
  1366. <p>leave channel</p>
  1367. </div>
  1368. <p>This method leaves the joined channel, then your video view will not render ever.
  1369. You should call it, when you dont need render video stream.</p>
  1370. </div>
  1371. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1372. <p>Promise&lt;{success, value}&gt;</p>
  1373. </li>
  1374. </ul>
  1375. </section>
  1376. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1377. <a name="methodisspeakerphoneenabled" class="tsd-anchor"></a>
  1378. <h3><span class="tsd-flag ts-flagStatic">Static</span> methodis<wbr>Speakerphone<wbr>Enabled</h3>
  1379. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1380. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  1381. </ul>
  1382. <ul class="tsd-descriptions">
  1383. <li class="tsd-description">
  1384. <aside class="tsd-sources">
  1385. <ul>
  1386. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L441">RtcEngine.native.ts:441</a></li>
  1387. </ul>
  1388. </aside>
  1389. <div class="tsd-comment tsd-typography">
  1390. <div class="lead">
  1391. <p>check for mobile phone speaker enabled</p>
  1392. </div>
  1393. <p>This method checks the phone speaker is enabled</p>
  1394. </div>
  1395. <h4 class="tsd-parameters-title">Parameters</h4>
  1396. <ul class="tsd-parameters">
  1397. <li>
  1398. <h5>callback: <span class="tsd-signature-type">Callback</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
  1399. <div class="tsd-comment tsd-typography">
  1400. </div>
  1401. </li>
  1402. </ul>
  1403. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1404. </li>
  1405. </ul>
  1406. </section>
  1407. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1408. <a name="muteallremoteaudiostreams" class="tsd-anchor"></a>
  1409. <h3><span class="tsd-flag ts-flagStatic">Static</span> mute<wbr>All<wbr>Remote<wbr>Audio<wbr>Streams</h3>
  1410. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1411. <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>
  1412. </ul>
  1413. <ul class="tsd-descriptions">
  1414. <li class="tsd-description">
  1415. <aside class="tsd-sources">
  1416. <ul>
  1417. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L378">RtcEngine.native.ts:378</a></li>
  1418. </ul>
  1419. </aside>
  1420. <div class="tsd-comment tsd-typography">
  1421. <div class="lead">
  1422. <p>mute all remote audio streams</p>
  1423. </div>
  1424. <p>This method mutes all remote audio streams by muted</p>
  1425. </div>
  1426. <h4 class="tsd-parameters-title">Parameters</h4>
  1427. <ul class="tsd-parameters">
  1428. <li>
  1429. <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
  1430. </li>
  1431. </ul>
  1432. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1433. </li>
  1434. </ul>
  1435. </section>
  1436. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1437. <a name="muteallremotevideostreams" class="tsd-anchor"></a>
  1438. <h3><span class="tsd-flag ts-flagStatic">Static</span> mute<wbr>All<wbr>Remote<wbr>Video<wbr>Streams</h3>
  1439. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1440. <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>
  1441. </ul>
  1442. <ul class="tsd-descriptions">
  1443. <li class="tsd-description">
  1444. <aside class="tsd-sources">
  1445. <ul>
  1446. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L310">RtcEngine.native.ts:310</a></li>
  1447. </ul>
  1448. </aside>
  1449. <div class="tsd-comment tsd-typography">
  1450. <div class="lead">
  1451. <p>mute all remote video streams</p>
  1452. </div>
  1453. <p>This method mutes all remote streams by the boolean parameter.</p>
  1454. </div>
  1455. <h4 class="tsd-parameters-title">Parameters</h4>
  1456. <ul class="tsd-parameters">
  1457. <li>
  1458. <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
  1459. <div class="tsd-comment tsd-typography">
  1460. </div>
  1461. </li>
  1462. </ul>
  1463. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1464. </li>
  1465. </ul>
  1466. </section>
  1467. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1468. <a name="mutelocalaudiostream" class="tsd-anchor"></a>
  1469. <h3><span class="tsd-flag ts-flagStatic">Static</span> mute<wbr>Local<wbr>Audio<wbr>Stream</h3>
  1470. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1471. <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>
  1472. </ul>
  1473. <ul class="tsd-descriptions">
  1474. <li class="tsd-description">
  1475. <aside class="tsd-sources">
  1476. <ul>
  1477. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1205">RtcEngine.native.ts:1205</a></li>
  1478. </ul>
  1479. </aside>
  1480. <div class="tsd-comment tsd-typography">
  1481. <div class="lead">
  1482. <p>mute local audio stream</p>
  1483. </div>
  1484. <p>This method sends/stops sending the local audio.</p>
  1485. </div>
  1486. <h4 class="tsd-parameters-title">Parameters</h4>
  1487. <ul class="tsd-parameters">
  1488. <li>
  1489. <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
  1490. <div class="tsd-comment tsd-typography">
  1491. </div>
  1492. </li>
  1493. </ul>
  1494. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1495. </li>
  1496. </ul>
  1497. </section>
  1498. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1499. <a name="mutelocalvideostream" class="tsd-anchor"></a>
  1500. <h3><span class="tsd-flag ts-flagStatic">Static</span> mute<wbr>Local<wbr>Video<wbr>Stream</h3>
  1501. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1502. <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>
  1503. </ul>
  1504. <ul class="tsd-descriptions">
  1505. <li class="tsd-description">
  1506. <aside class="tsd-sources">
  1507. <ul>
  1508. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L300">RtcEngine.native.ts:300</a></li>
  1509. </ul>
  1510. </aside>
  1511. <div class="tsd-comment tsd-typography">
  1512. <div class="lead">
  1513. <p>mute local video stream</p>
  1514. </div>
  1515. <p>This method mutes video stream by the boolean parameter.</p>
  1516. </div>
  1517. <h4 class="tsd-parameters-title">Parameters</h4>
  1518. <ul class="tsd-parameters">
  1519. <li>
  1520. <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
  1521. <div class="tsd-comment tsd-typography">
  1522. </div>
  1523. </li>
  1524. </ul>
  1525. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1526. </li>
  1527. </ul>
  1528. </section>
  1529. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1530. <a name="muteremoteaudiostream" class="tsd-anchor"></a>
  1531. <h3><span class="tsd-flag ts-flagStatic">Static</span> mute<wbr>Remote<wbr>Audio<wbr>Stream</h3>
  1532. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1533. <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>
  1534. </ul>
  1535. <ul class="tsd-descriptions">
  1536. <li class="tsd-description">
  1537. <aside class="tsd-sources">
  1538. <ul>
  1539. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L389">RtcEngine.native.ts:389</a></li>
  1540. </ul>
  1541. </aside>
  1542. <div class="tsd-comment tsd-typography">
  1543. <div class="lead">
  1544. <p>mute specified remote audio stream by muted</p>
  1545. </div>
  1546. <p>This method mutes specified remote audio stream by number uid and boolean muted.</p>
  1547. </div>
  1548. <h4 class="tsd-parameters-title">Parameters</h4>
  1549. <ul class="tsd-parameters">
  1550. <li>
  1551. <h5>uid: <span class="tsd-signature-type">number</span></h5>
  1552. </li>
  1553. <li>
  1554. <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
  1555. <div class="tsd-comment tsd-typography">
  1556. </div>
  1557. </li>
  1558. </ul>
  1559. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1560. </li>
  1561. </ul>
  1562. </section>
  1563. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1564. <a name="muteremotevideostream" class="tsd-anchor"></a>
  1565. <h3><span class="tsd-flag ts-flagStatic">Static</span> mute<wbr>Remote<wbr>Video<wbr>Stream</h3>
  1566. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1567. <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>
  1568. </ul>
  1569. <ul class="tsd-descriptions">
  1570. <li class="tsd-description">
  1571. <aside class="tsd-sources">
  1572. <ul>
  1573. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L321">RtcEngine.native.ts:321</a></li>
  1574. </ul>
  1575. </aside>
  1576. <div class="tsd-comment tsd-typography">
  1577. <div class="lead">
  1578. <p>mute specified remote video stream.</p>
  1579. </div>
  1580. <p>This method mutes remote video stream by the number of uid and boolean parameter.</p>
  1581. </div>
  1582. <h4 class="tsd-parameters-title">Parameters</h4>
  1583. <ul class="tsd-parameters">
  1584. <li>
  1585. <h5>uid: <span class="tsd-signature-type">number</span></h5>
  1586. </li>
  1587. <li>
  1588. <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
  1589. <div class="tsd-comment tsd-typography">
  1590. </div>
  1591. </li>
  1592. </ul>
  1593. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1594. </li>
  1595. </ul>
  1596. </section>
  1597. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1598. <a name="off" class="tsd-anchor"></a>
  1599. <h3><span class="tsd-flag ts-flagStatic">Static</span> off</h3>
  1600. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1601. <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>
  1602. </ul>
  1603. <ul class="tsd-descriptions">
  1604. <li class="tsd-description">
  1605. <aside class="tsd-sources">
  1606. <ul>
  1607. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L88">RtcEngine.native.ts:88</a></li>
  1608. </ul>
  1609. </aside>
  1610. <div class="tsd-comment tsd-typography">
  1611. <div class="lead">
  1612. <p>remove event listeners</p>
  1613. </div>
  1614. <p>This method unsubscribes specified eventType related all listeners. You should call this method when you want to unsubscribe some eventType.</p>
  1615. </div>
  1616. <h4 class="tsd-parameters-title">Parameters</h4>
  1617. <ul class="tsd-parameters">
  1618. <li>
  1619. <h5>eventType: <span class="tsd-signature-type">string</span></h5>
  1620. <div class="tsd-comment tsd-typography">
  1621. </div>
  1622. </li>
  1623. </ul>
  1624. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1625. </li>
  1626. </ul>
  1627. </section>
  1628. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1629. <a name="on" class="tsd-anchor"></a>
  1630. <h3><span class="tsd-flag ts-flagStatic">Static</span> on</h3>
  1631. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1632. <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>
  1633. </ul>
  1634. <ul class="tsd-descriptions">
  1635. <li class="tsd-description">
  1636. <aside class="tsd-sources">
  1637. <ul>
  1638. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L77">RtcEngine.native.ts:77</a></li>
  1639. </ul>
  1640. </aside>
  1641. <div class="tsd-comment tsd-typography">
  1642. <div class="lead">
  1643. <p>add event listener</p>
  1644. </div>
  1645. <p>This method subscribes specified eventType and run listener. You should call this method at first.</p>
  1646. </div>
  1647. <h4 class="tsd-parameters-title">Parameters</h4>
  1648. <ul class="tsd-parameters">
  1649. <li>
  1650. <h5>eventType: <span class="tsd-signature-type">string</span></h5>
  1651. </li>
  1652. <li>
  1653. <h5>listener: <span class="tsd-signature-type">function</span></h5>
  1654. <div class="tsd-comment tsd-typography">
  1655. </div>
  1656. <ul class="tsd-parameters">
  1657. <li class="tsd-parameter-siganture">
  1658. <ul class="tsd-signatures tsd-kind-type-literal">
  1659. <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>
  1660. </ul>
  1661. <ul class="tsd-descriptions">
  1662. <li class="tsd-description">
  1663. <h4 class="tsd-parameters-title">Parameters</h4>
  1664. <ul class="tsd-parameters">
  1665. <li>
  1666. <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>
  1667. </li>
  1668. </ul>
  1669. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
  1670. </li>
  1671. </ul>
  1672. </li>
  1673. </ul>
  1674. </li>
  1675. </ul>
  1676. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1677. </li>
  1678. </ul>
  1679. </section>
  1680. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1681. <a name="pausealleffects" class="tsd-anchor"></a>
  1682. <h3><span class="tsd-flag ts-flagStatic">Static</span> pause<wbr>All<wbr>Effects</h3>
  1683. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1684. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1685. </ul>
  1686. <ul class="tsd-descriptions">
  1687. <li class="tsd-description">
  1688. <aside class="tsd-sources">
  1689. <ul>
  1690. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L703">RtcEngine.native.ts:703</a></li>
  1691. </ul>
  1692. </aside>
  1693. <div class="tsd-comment tsd-typography">
  1694. <div class="lead">
  1695. <p>pause all effects for audio mixing</p>
  1696. </div>
  1697. <p>This method pause all effects for audio mixing.</p>
  1698. </div>
  1699. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1700. <p>Promise&lt;{success, value}&gt;</p>
  1701. </li>
  1702. </ul>
  1703. </section>
  1704. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1705. <a name="pauseaudiomixing" class="tsd-anchor"></a>
  1706. <h3><span class="tsd-flag ts-flagStatic">Static</span> pause<wbr>Audio<wbr>Mixing</h3>
  1707. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1708. <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>
  1709. </ul>
  1710. <ul class="tsd-descriptions">
  1711. <li class="tsd-description">
  1712. <aside class="tsd-sources">
  1713. <ul>
  1714. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L526">RtcEngine.native.ts:526</a></li>
  1715. </ul>
  1716. </aside>
  1717. <div class="tsd-comment tsd-typography">
  1718. <div class="lead">
  1719. <p>pause audio mixing</p>
  1720. </div>
  1721. <p>This method pauses for audio mixing.</p>
  1722. </div>
  1723. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1724. </li>
  1725. </ul>
  1726. </section>
  1727. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1728. <a name="pauseeffect" class="tsd-anchor"></a>
  1729. <h3><span class="tsd-flag ts-flagStatic">Static</span> pause<wbr>Effect</h3>
  1730. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1731. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1732. </ul>
  1733. <ul class="tsd-descriptions">
  1734. <li class="tsd-description">
  1735. <aside class="tsd-sources">
  1736. <ul>
  1737. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L692">RtcEngine.native.ts:692</a></li>
  1738. </ul>
  1739. </aside>
  1740. <div class="tsd-comment tsd-typography">
  1741. <div class="lead">
  1742. <p>pause the specified effect for audio mixing by soundid</p>
  1743. </div>
  1744. <p>This method pauses the specified effect for audio mixing by soundid.</p>
  1745. </div>
  1746. <h4 class="tsd-parameters-title">Parameters</h4>
  1747. <ul class="tsd-parameters">
  1748. <li>
  1749. <h5>soundId: <span class="tsd-signature-type">number</span></h5>
  1750. </li>
  1751. </ul>
  1752. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1753. <p>Promise&lt;{success, value}&gt;</p>
  1754. </li>
  1755. </ul>
  1756. </section>
  1757. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1758. <a name="playeffect" class="tsd-anchor"></a>
  1759. <h3><span class="tsd-flag ts-flagStatic">Static</span> play<wbr>Effect</h3>
  1760. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1761. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1762. </ul>
  1763. <ul class="tsd-descriptions">
  1764. <li class="tsd-description">
  1765. <aside class="tsd-sources">
  1766. <ul>
  1767. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L637">RtcEngine.native.ts:637</a></li>
  1768. </ul>
  1769. </aside>
  1770. <div class="tsd-comment tsd-typography">
  1771. <div class="lead">
  1772. <p>play specified effect for audio mixing</p>
  1773. </div>
  1774. <p>This methos plays the specified effect of audio mixing file by option config.</p>
  1775. </div>
  1776. <h4 class="tsd-parameters-title">Parameters</h4>
  1777. <ul class="tsd-parameters">
  1778. <li>
  1779. <h5>options: <span class="tsd-signature-type">PlayEffectOption</span></h5>
  1780. </li>
  1781. </ul>
  1782. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1783. <p>Promise&lt;{success, value}&gt;</p>
  1784. </li>
  1785. </ul>
  1786. </section>
  1787. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1788. <a name="preloadeffect" class="tsd-anchor"></a>
  1789. <h3><span class="tsd-flag ts-flagStatic">Static</span> preload<wbr>Effect</h3>
  1790. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1791. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1792. </ul>
  1793. <ul class="tsd-descriptions">
  1794. <li class="tsd-description">
  1795. <aside class="tsd-sources">
  1796. <ul>
  1797. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L670">RtcEngine.native.ts:670</a></li>
  1798. </ul>
  1799. </aside>
  1800. <div class="tsd-comment tsd-typography">
  1801. <div class="lead">
  1802. <p>preload effect for audio mixing file.</p>
  1803. </div>
  1804. <p>This methods preloads the specified audio mixing file to memory by the soundid</p>
  1805. </div>
  1806. <h4 class="tsd-parameters-title">Parameters</h4>
  1807. <ul class="tsd-parameters">
  1808. <li>
  1809. <h5>soundId: <span class="tsd-signature-type">number</span></h5>
  1810. </li>
  1811. <li>
  1812. <h5>filepath: <span class="tsd-signature-type">string</span></h5>
  1813. </li>
  1814. </ul>
  1815. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1816. <p>Promise&lt;{success, value}&gt;</p>
  1817. </li>
  1818. </ul>
  1819. </section>
  1820. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1821. <a name="removclearvideowatermarkse" class="tsd-anchor"></a>
  1822. <h3><span class="tsd-flag ts-flagStatic">Static</span> removclear<wbr>Video<wbr>Watermarkse</h3>
  1823. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1824. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1825. </ul>
  1826. <ul class="tsd-descriptions">
  1827. <li class="tsd-description">
  1828. <aside class="tsd-sources">
  1829. <ul>
  1830. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L860">RtcEngine.native.ts:860</a></li>
  1831. </ul>
  1832. </aside>
  1833. <div class="tsd-comment tsd-typography">
  1834. <div class="lead">
  1835. <p>clear video watermarks</p>
  1836. </div>
  1837. <p>This method removes the watermark image from the video stream added by addVideoWatermark.</p>
  1838. </div>
  1839. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1840. <p>Promise&lt;{success, value}&gt;</p>
  1841. </li>
  1842. </ul>
  1843. </section>
  1844. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1845. <a name="removealllisteners" class="tsd-anchor"></a>
  1846. <h3><span class="tsd-flag ts-flagStatic">Static</span> remove<wbr>All<wbr>Listeners</h3>
  1847. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1848. <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>
  1849. </ul>
  1850. <ul class="tsd-descriptions">
  1851. <li class="tsd-description">
  1852. <aside class="tsd-sources">
  1853. <ul>
  1854. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L100">RtcEngine.native.ts:100</a></li>
  1855. </ul>
  1856. </aside>
  1857. <div class="tsd-comment tsd-typography">
  1858. <div class="lead">
  1859. <p>remove all events listeners</p>
  1860. </div>
  1861. <p>This method unsubscribes all eventTypes related listeners.</p>
  1862. </div>
  1863. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  1864. </li>
  1865. </ul>
  1866. </section>
  1867. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1868. <a name="removeinjectstreamurl" class="tsd-anchor"></a>
  1869. <h3><span class="tsd-flag ts-flagStatic">Static</span> remove<wbr>Inject<wbr>Stream<wbr>Url</h3>
  1870. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1871. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1872. </ul>
  1873. <ul class="tsd-descriptions">
  1874. <li class="tsd-description">
  1875. <aside class="tsd-sources">
  1876. <ul>
  1877. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L944">RtcEngine.native.ts:944</a></li>
  1878. </ul>
  1879. </aside>
  1880. <div class="tsd-comment tsd-typography">
  1881. <div class="lead">
  1882. <p>remove inject stream url</p>
  1883. </div>
  1884. <p>This method removes stream by addInjectsStreamUrl.</p>
  1885. </div>
  1886. <h4 class="tsd-parameters-title">Parameters</h4>
  1887. <ul class="tsd-parameters">
  1888. <li>
  1889. <h5>options: <span class="tsd-signature-type">RemoveInjectStreamOption</span></h5>
  1890. </li>
  1891. </ul>
  1892. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1893. <p>Promise&lt;{success, value}&gt;</p>
  1894. </li>
  1895. </ul>
  1896. </section>
  1897. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1898. <a name="removepublishstreamurl" class="tsd-anchor"></a>
  1899. <h3><span class="tsd-flag ts-flagStatic">Static</span> remove<wbr>Publish<wbr>Stream<wbr>Url</h3>
  1900. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1901. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1902. </ul>
  1903. <ul class="tsd-descriptions">
  1904. <li class="tsd-description">
  1905. <aside class="tsd-sources">
  1906. <ul>
  1907. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1169">RtcEngine.native.ts:1169</a></li>
  1908. </ul>
  1909. </aside>
  1910. <div class="tsd-comment tsd-typography">
  1911. <div class="lead">
  1912. <p>remove publish stream url</p>
  1913. </div>
  1914. <p>This method remove publish stream by options.</p>
  1915. </div>
  1916. <h4 class="tsd-parameters-title">Parameters</h4>
  1917. <ul class="tsd-parameters">
  1918. <li>
  1919. <h5>options: <span class="tsd-signature-type">RemovePublishStreamOption</span></h5>
  1920. </li>
  1921. </ul>
  1922. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1923. <p>Promise&lt;{success, value}&gt;</p>
  1924. </li>
  1925. </ul>
  1926. </section>
  1927. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1928. <a name="renewtoken" class="tsd-anchor"></a>
  1929. <h3><span class="tsd-flag ts-flagStatic">Static</span> renew<wbr>Token</h3>
  1930. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1931. <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>
  1932. </ul>
  1933. <ul class="tsd-descriptions">
  1934. <li class="tsd-description">
  1935. <aside class="tsd-sources">
  1936. <ul>
  1937. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L113">RtcEngine.native.ts:113</a></li>
  1938. </ul>
  1939. </aside>
  1940. <div class="tsd-comment tsd-typography">
  1941. <div class="lead">
  1942. <p>renew token</p>
  1943. </div>
  1944. <p>This method renews a new token.</p>
  1945. </div>
  1946. <h4 class="tsd-parameters-title">Parameters</h4>
  1947. <ul class="tsd-parameters">
  1948. <li>
  1949. <h5>token: <span class="tsd-signature-type">string</span></h5>
  1950. <div class="tsd-comment tsd-typography">
  1951. </div>
  1952. </li>
  1953. </ul>
  1954. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
  1955. </li>
  1956. </ul>
  1957. </section>
  1958. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1959. <a name="resumealleffects" class="tsd-anchor"></a>
  1960. <h3><span class="tsd-flag ts-flagStatic">Static</span> resume<wbr>All<wbr>Effects</h3>
  1961. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1962. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  1963. </ul>
  1964. <ul class="tsd-descriptions">
  1965. <li class="tsd-description">
  1966. <aside class="tsd-sources">
  1967. <ul>
  1968. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L724">RtcEngine.native.ts:724</a></li>
  1969. </ul>
  1970. </aside>
  1971. <div class="tsd-comment tsd-typography">
  1972. <div class="lead">
  1973. <p>resume all audio mixing effects.</p>
  1974. </div>
  1975. <p>This method resumes all audio mixing effects.</p>
  1976. </div>
  1977. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  1978. <p>Promise&lt;{success, value}&gt;</p>
  1979. </li>
  1980. </ul>
  1981. </section>
  1982. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1983. <a name="resumeaudiomixing" class="tsd-anchor"></a>
  1984. <h3><span class="tsd-flag ts-flagStatic">Static</span> resume<wbr>Audio<wbr>Mixing</h3>
  1985. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  1986. <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>
  1987. </ul>
  1988. <ul class="tsd-descriptions">
  1989. <li class="tsd-description">
  1990. <aside class="tsd-sources">
  1991. <ul>
  1992. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L535">RtcEngine.native.ts:535</a></li>
  1993. </ul>
  1994. </aside>
  1995. <div class="tsd-comment tsd-typography">
  1996. <div class="lead">
  1997. <p>resume audio mixing</p>
  1998. </div>
  1999. <p>This method resumes for audio mixing.</p>
  2000. </div>
  2001. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  2002. </li>
  2003. </ul>
  2004. </section>
  2005. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2006. <a name="resumeeffect" class="tsd-anchor"></a>
  2007. <h3><span class="tsd-flag ts-flagStatic">Static</span> resume<wbr>Effect</h3>
  2008. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2009. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2010. </ul>
  2011. <ul class="tsd-descriptions">
  2012. <li class="tsd-description">
  2013. <aside class="tsd-sources">
  2014. <ul>
  2015. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L714">RtcEngine.native.ts:714</a></li>
  2016. </ul>
  2017. </aside>
  2018. <div class="tsd-comment tsd-typography">
  2019. <div class="lead">
  2020. <p>resume audio mixing effect by the specified soundid</p>
  2021. </div>
  2022. <p>This method resumes audio mixing effect by the specified soundid</p>
  2023. </div>
  2024. <h4 class="tsd-parameters-title">Parameters</h4>
  2025. <ul class="tsd-parameters">
  2026. <li>
  2027. <h5>soundId: <span class="tsd-signature-type">number</span></h5>
  2028. </li>
  2029. </ul>
  2030. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2031. <p>Promise&lt;{success, value}&gt;</p>
  2032. </li>
  2033. </ul>
  2034. </section>
  2035. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2036. <a name="sendmessage" class="tsd-anchor"></a>
  2037. <h3><span class="tsd-flag ts-flagStatic">Static</span> send<wbr>Message</h3>
  2038. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2039. <li class="tsd-signature tsd-kind-icon">send<wbr>Message<span class="tsd-signature-symbol">(</span>streamID<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>, reliable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, ordered<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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2040. </ul>
  2041. <ul class="tsd-descriptions">
  2042. <li class="tsd-description">
  2043. <aside class="tsd-sources">
  2044. <ul>
  2045. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1145">RtcEngine.native.ts:1145</a></li>
  2046. </ul>
  2047. </aside>
  2048. <div class="tsd-comment tsd-typography">
  2049. <div class="lead">
  2050. <p>send stream message</p>
  2051. </div>
  2052. <p>This method sends stream message by specified uid</p>
  2053. </div>
  2054. <h4 class="tsd-parameters-title">Parameters</h4>
  2055. <ul class="tsd-parameters">
  2056. <li>
  2057. <h5>streamID: <span class="tsd-signature-type">number</span></h5>
  2058. </li>
  2059. <li>
  2060. <h5>data: <span class="tsd-signature-type">any</span></h5>
  2061. </li>
  2062. <li>
  2063. <h5>reliable: <span class="tsd-signature-type">boolean</span></h5>
  2064. </li>
  2065. <li>
  2066. <h5>ordered: <span class="tsd-signature-type">boolean</span></h5>
  2067. </li>
  2068. </ul>
  2069. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2070. <p>Promise&lt;{success, value}&gt;</p>
  2071. </li>
  2072. </ul>
  2073. </section>
  2074. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2075. <a name="setaudiomixingposition" class="tsd-anchor"></a>
  2076. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Audio<wbr>Mixing<wbr>Position</h3>
  2077. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2078. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2079. </ul>
  2080. <ul class="tsd-descriptions">
  2081. <li class="tsd-description">
  2082. <aside class="tsd-sources">
  2083. <ul>
  2084. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L595">RtcEngine.native.ts:595</a></li>
  2085. </ul>
  2086. </aside>
  2087. <div class="tsd-comment tsd-typography">
  2088. <div class="lead">
  2089. <p>set audio mixing position</p>
  2090. </div>
  2091. <p>This method sets audio mixing position by the parameter pos</p>
  2092. </div>
  2093. <h4 class="tsd-parameters-title">Parameters</h4>
  2094. <ul class="tsd-parameters">
  2095. <li>
  2096. <h5>pos: <span class="tsd-signature-type">number</span></h5>
  2097. <div class="tsd-comment tsd-typography">
  2098. </div>
  2099. </li>
  2100. </ul>
  2101. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2102. </li>
  2103. </ul>
  2104. </section>
  2105. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2106. <a name="setaudiosessionoperationrestriction" class="tsd-anchor"></a>
  2107. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Audio<wbr>Session<wbr>Operation<wbr>Restriction</h3>
  2108. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2109. <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>
  2110. </ul>
  2111. <ul class="tsd-descriptions">
  2112. <li class="tsd-description">
  2113. <aside class="tsd-sources">
  2114. <ul>
  2115. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L757">RtcEngine.native.ts:757</a></li>
  2116. </ul>
  2117. </aside>
  2118. <div class="tsd-comment tsd-typography">
  2119. <div class="lead">
  2120. <p>set audio session operation restriction</p>
  2121. </div>
  2122. <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.
  2123. You can call this method at any time to return the control of the audio sessions to the SDK.
  2124. 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>
  2125. <dl class="tsd-comment-tags">
  2126. <dt>notice</dt>
  2127. <dd><p>iOS support only</p>
  2128. </dd>
  2129. </dl>
  2130. </div>
  2131. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  2132. </li>
  2133. </ul>
  2134. </section>
  2135. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2136. <a name="setbeautyeffectoptions" class="tsd-anchor"></a>
  2137. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Beauty<wbr>Effect<wbr>Options</h3>
  2138. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2139. <li class="tsd-signature tsd-kind-icon">set<wbr>Beauty<wbr>Effect<wbr>Options<span class="tsd-signature-symbol">(</span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BeautyOption</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2140. </ul>
  2141. <ul class="tsd-descriptions">
  2142. <li class="tsd-description">
  2143. <aside class="tsd-sources">
  2144. <ul>
  2145. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1218">RtcEngine.native.ts:1218</a></li>
  2146. </ul>
  2147. </aside>
  2148. <div class="tsd-comment tsd-typography">
  2149. <div class="lead">
  2150. <p>video pre-process/post-process</p>
  2151. </div>
  2152. <p>This method enables/disables image enhancement and sets the options.</p>
  2153. </div>
  2154. <h4 class="tsd-parameters-title">Parameters</h4>
  2155. <ul class="tsd-parameters">
  2156. <li>
  2157. <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
  2158. </li>
  2159. <li>
  2160. <h5>options: <span class="tsd-signature-type">BeautyOption</span></h5>
  2161. </li>
  2162. </ul>
  2163. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2164. <p>Promise&lt;{success, value}&gt;</p>
  2165. </li>
  2166. </ul>
  2167. </section>
  2168. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2169. <a name="setcameraautofocusfacemodeenabled" class="tsd-anchor"></a>
  2170. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Camera<wbr>Auto<wbr>Focus<wbr>Face<wbr>Mode<wbr>Enabled</h3>
  2171. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2172. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2173. </ul>
  2174. <ul class="tsd-descriptions">
  2175. <li class="tsd-description">
  2176. <aside class="tsd-sources">
  2177. <ul>
  2178. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1107">RtcEngine.native.ts:1107</a></li>
  2179. </ul>
  2180. </aside>
  2181. <div class="tsd-comment tsd-typography">
  2182. <div class="lead">
  2183. <p>set enable auto focus face mode</p>
  2184. </div>
  2185. <p>This method enables auto-focus face mode function.</p>
  2186. </div>
  2187. <h4 class="tsd-parameters-title">Parameters</h4>
  2188. <ul class="tsd-parameters">
  2189. <li>
  2190. <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
  2191. <div class="tsd-comment tsd-typography">
  2192. <p>boolean</p>
  2193. </div>
  2194. </li>
  2195. </ul>
  2196. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2197. <p>Promise&lt;{success, value}&gt;</p>
  2198. </li>
  2199. </ul>
  2200. </section>
  2201. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2202. <a name="setcameracapturerconfiguration" class="tsd-anchor"></a>
  2203. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Camera<wbr>Capturer<wbr>Configuration</h3>
  2204. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2205. <li class="tsd-signature tsd-kind-icon">set<wbr>Camera<wbr>Capturer<wbr>Configuration<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CameraCapturerConfiguration</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2206. </ul>
  2207. <ul class="tsd-descriptions">
  2208. <li class="tsd-description">
  2209. <aside class="tsd-sources">
  2210. <ul>
  2211. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1359">RtcEngine.native.ts:1359</a></li>
  2212. </ul>
  2213. </aside>
  2214. <div class="tsd-comment tsd-typography">
  2215. <div class="lead">
  2216. <p>set the camera capture preference.</p>
  2217. </div>
  2218. <p>note:
  2219. For a video call or live broadcast, generally the SDK controls the camera output parameters. When the default camera capture settings do not meet special requirements or cause performance problems, we recommend using this method to set the camera capture preference:
  2220. If the resolution or frame rate of the captured raw video data are higher than those set by setVideoEncoderConfiguration, processing video frames requires extra CPU and RAM usage and degrades performance. We recommend setting config as CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE(1) to avoid such problems.
  2221. If you do not need local video preview or are willing to sacrifice preview quality, we recommend setting config as CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE(1) to optimize CPU and RAM usage.
  2222. If you want better quality for the local video preview, we recommend setting config as CAPTURER_OUTPUT_PREFERENCE_PREVIEW(2).</p>
  2223. <p>This method will set the camera capture preference.</p>
  2224. </div>
  2225. <h4 class="tsd-parameters-title">Parameters</h4>
  2226. <ul class="tsd-parameters">
  2227. <li>
  2228. <h5>config: <span class="tsd-signature-type">CameraCapturerConfiguration</span></h5>
  2229. <div class="tsd-comment tsd-typography">
  2230. </div>
  2231. </li>
  2232. </ul>
  2233. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2234. <p>Promise&lt;{success, value}&gt;</p>
  2235. </li>
  2236. </ul>
  2237. </section>
  2238. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2239. <a name="setcameraexposureposition" class="tsd-anchor"></a>
  2240. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Camera<wbr>Exposure<wbr>Position</h3>
  2241. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2242. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2243. </ul>
  2244. <ul class="tsd-descriptions">
  2245. <li class="tsd-description">
  2246. <aside class="tsd-sources">
  2247. <ul>
  2248. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1083">RtcEngine.native.ts:1083</a></li>
  2249. </ul>
  2250. </aside>
  2251. <div class="tsd-comment tsd-typography">
  2252. <div class="lead">
  2253. <p>set camera exposure position</p>
  2254. </div>
  2255. <p>This method sets the mannual exposure position.</p>
  2256. </div>
  2257. <h4 class="tsd-parameters-title">Parameters</h4>
  2258. <ul class="tsd-parameters">
  2259. <li>
  2260. <h5>options: <span class="tsd-signature-type">PositionOption</span></h5>
  2261. </li>
  2262. </ul>
  2263. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2264. <p>Promise&lt;{success, value}&gt;</p>
  2265. </li>
  2266. </ul>
  2267. </section>
  2268. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2269. <a name="setcamerafocuspositioninpreview" class="tsd-anchor"></a>
  2270. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Camera<wbr>Focus<wbr>Position<wbr>InPreview</h3>
  2271. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2272. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2273. </ul>
  2274. <ul class="tsd-descriptions">
  2275. <li class="tsd-description">
  2276. <aside class="tsd-sources">
  2277. <ul>
  2278. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1071">RtcEngine.native.ts:1071</a></li>
  2279. </ul>
  2280. </aside>
  2281. <div class="tsd-comment tsd-typography">
  2282. <div class="lead">
  2283. <p>set camera focus position in preview</p>
  2284. </div>
  2285. <p>This method sets the mannual focus position.</p>
  2286. </div>
  2287. <h4 class="tsd-parameters-title">Parameters</h4>
  2288. <ul class="tsd-parameters">
  2289. <li>
  2290. <h5>options: <span class="tsd-signature-type">PositionOption</span></h5>
  2291. </li>
  2292. </ul>
  2293. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2294. <p>Promise&lt;{success, value}&gt;</p>
  2295. </li>
  2296. </ul>
  2297. </section>
  2298. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2299. <a name="setcameratorchon" class="tsd-anchor"></a>
  2300. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Camera<wbr>Torch<wbr>On</h3>
  2301. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2302. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2303. </ul>
  2304. <ul class="tsd-descriptions">
  2305. <li class="tsd-description">
  2306. <aside class="tsd-sources">
  2307. <ul>
  2308. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1095">RtcEngine.native.ts:1095</a></li>
  2309. </ul>
  2310. </aside>
  2311. <div class="tsd-comment tsd-typography">
  2312. <div class="lead">
  2313. <p>set camera torch on</p>
  2314. </div>
  2315. <p>This method enables the camera flash function.</p>
  2316. </div>
  2317. <h4 class="tsd-parameters-title">Parameters</h4>
  2318. <ul class="tsd-parameters">
  2319. <li>
  2320. <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
  2321. </li>
  2322. </ul>
  2323. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2324. <p>Promise&lt;{success, value}&gt;</p>
  2325. </li>
  2326. </ul>
  2327. </section>
  2328. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2329. <a name="setcamerazoomfactor" class="tsd-anchor"></a>
  2330. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Camera<wbr>Zoom<wbr>Factor</h3>
  2331. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2332. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2333. </ul>
  2334. <ul class="tsd-descriptions">
  2335. <li class="tsd-description">
  2336. <aside class="tsd-sources">
  2337. <ul>
  2338. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1047">RtcEngine.native.ts:1047</a></li>
  2339. </ul>
  2340. </aside>
  2341. <div class="tsd-comment tsd-typography">
  2342. <div class="lead">
  2343. <p>set camera zoom ratio</p>
  2344. </div>
  2345. <p>This method sets the camera zoom ratio.</p>
  2346. </div>
  2347. <h4 class="tsd-parameters-title">Parameters</h4>
  2348. <ul class="tsd-parameters">
  2349. <li>
  2350. <h5>zoomFactor: <span class="tsd-signature-type">number</span></h5>
  2351. </li>
  2352. </ul>
  2353. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2354. <p>Promise&lt;{success, value}&gt;</p>
  2355. </li>
  2356. </ul>
  2357. </section>
  2358. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2359. <a name="setclientrole" class="tsd-anchor"></a>
  2360. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Client<wbr>Role</h3>
  2361. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2362. <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>
  2363. </ul>
  2364. <ul class="tsd-descriptions">
  2365. <li class="tsd-description">
  2366. <aside class="tsd-sources">
  2367. <ul>
  2368. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L145">RtcEngine.native.ts:145</a></li>
  2369. </ul>
  2370. </aside>
  2371. <div class="tsd-comment tsd-typography">
  2372. <div class="lead">
  2373. <p>change the client role</p>
  2374. </div>
  2375. <p>This method changes the client of role.</p>
  2376. </div>
  2377. <h4 class="tsd-parameters-title">Parameters</h4>
  2378. <ul class="tsd-parameters">
  2379. <li>
  2380. <h5>role: <span class="tsd-signature-type">number</span></h5>
  2381. <div class="tsd-comment tsd-typography">
  2382. <p>(audience: 0, host: 1)</p>
  2383. </div>
  2384. </li>
  2385. </ul>
  2386. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  2387. </li>
  2388. </ul>
  2389. </section>
  2390. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2391. <a name="setdefaultaudioroutetospeakerphone" class="tsd-anchor"></a>
  2392. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Default<wbr>Audio<wbr>Route<wbr>ToSpeakerphone</h3>
  2393. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2394. <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>
  2395. </ul>
  2396. <ul class="tsd-descriptions">
  2397. <li class="tsd-description">
  2398. <aside class="tsd-sources">
  2399. <ul>
  2400. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L251">RtcEngine.native.ts:251</a></li>
  2401. </ul>
  2402. </aside>
  2403. <div class="tsd-comment tsd-typography">
  2404. <div class="lead">
  2405. <p>set default audio speaker</p>
  2406. </div>
  2407. <p>This method set the default audio speaker enable or disable by pass boolean parameter.</p>
  2408. </div>
  2409. <h4 class="tsd-parameters-title">Parameters</h4>
  2410. <ul class="tsd-parameters">
  2411. <li>
  2412. <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
  2413. <div class="tsd-comment tsd-typography">
  2414. </div>
  2415. </li>
  2416. </ul>
  2417. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  2418. </li>
  2419. </ul>
  2420. </section>
  2421. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2422. <a name="setdefaultmuteallremoteaudiostreams" class="tsd-anchor"></a>
  2423. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Default<wbr>Mute<wbr>All<wbr>Remote<wbr>Audio<wbr>Streams</h3>
  2424. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2425. <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>
  2426. </ul>
  2427. <ul class="tsd-descriptions">
  2428. <li class="tsd-description">
  2429. <aside class="tsd-sources">
  2430. <ul>
  2431. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L262">RtcEngine.native.ts:262</a></li>
  2432. </ul>
  2433. </aside>
  2434. <div class="tsd-comment tsd-typography">
  2435. <div class="lead">
  2436. <p>set default mute all remote audio streams</p>
  2437. </div>
  2438. <p>This method set default mute all remote audio streams enable or not by pass boolean parameter.</p>
  2439. </div>
  2440. <h4 class="tsd-parameters-title">Parameters</h4>
  2441. <ul class="tsd-parameters">
  2442. <li>
  2443. <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
  2444. <div class="tsd-comment tsd-typography">
  2445. </div>
  2446. </li>
  2447. </ul>
  2448. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  2449. </li>
  2450. </ul>
  2451. </section>
  2452. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2453. <a name="setdefaultmuteallremotevideostreams" class="tsd-anchor"></a>
  2454. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Default<wbr>Mute<wbr>All<wbr>Remote<wbr>Video<wbr>Streams</h3>
  2455. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2456. <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>
  2457. </ul>
  2458. <ul class="tsd-descriptions">
  2459. <li class="tsd-description">
  2460. <aside class="tsd-sources">
  2461. <ul>
  2462. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L331">RtcEngine.native.ts:331</a></li>
  2463. </ul>
  2464. </aside>
  2465. <div class="tsd-comment tsd-typography">
  2466. <div class="lead">
  2467. <p>set default mute all remote video stream</p>
  2468. </div>
  2469. <p>This method mutes all remote video stream default by the boolean parameter.</p>
  2470. </div>
  2471. <h4 class="tsd-parameters-title">Parameters</h4>
  2472. <ul class="tsd-parameters">
  2473. <li>
  2474. <h5>muted: <span class="tsd-signature-type">boolean</span></h5>
  2475. <div class="tsd-comment tsd-typography">
  2476. </div>
  2477. </li>
  2478. </ul>
  2479. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  2480. </li>
  2481. </ul>
  2482. </section>
  2483. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2484. <a name="seteffectsvolume" class="tsd-anchor"></a>
  2485. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Effects<wbr>Volume</h3>
  2486. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2487. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2488. </ul>
  2489. <ul class="tsd-descriptions">
  2490. <li class="tsd-description">
  2491. <aside class="tsd-sources">
  2492. <ul>
  2493. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L616">RtcEngine.native.ts:616</a></li>
  2494. </ul>
  2495. </aside>
  2496. <div class="tsd-comment tsd-typography">
  2497. <div class="lead">
  2498. <p>set effects volume</p>
  2499. </div>
  2500. <p>This methods set audio mixing effects volume by float parameter.</p>
  2501. </div>
  2502. <h4 class="tsd-parameters-title">Parameters</h4>
  2503. <ul class="tsd-parameters">
  2504. <li>
  2505. <h5>volume: <span class="tsd-signature-type">number</span></h5>
  2506. </li>
  2507. </ul>
  2508. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2509. <p>Promise&lt;{success, value}&gt;</p>
  2510. </li>
  2511. </ul>
  2512. </section>
  2513. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2514. <a name="setenablespeakerphone" class="tsd-anchor"></a>
  2515. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Enable<wbr>Speakerphone</h3>
  2516. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2517. <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>
  2518. </ul>
  2519. <ul class="tsd-descriptions">
  2520. <li class="tsd-description">
  2521. <aside class="tsd-sources">
  2522. <ul>
  2523. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L241">RtcEngine.native.ts:241</a></li>
  2524. </ul>
  2525. </aside>
  2526. <div class="tsd-comment tsd-typography">
  2527. <div class="lead">
  2528. <p>set enable speaker phone</p>
  2529. </div>
  2530. <p>This method set the speaker phone enable or disable by pass boolean parameter.</p>
  2531. </div>
  2532. <h4 class="tsd-parameters-title">Parameters</h4>
  2533. <ul class="tsd-parameters">
  2534. <li>
  2535. <h5>enabled: <span class="tsd-signature-type">boolean</span></h5>
  2536. <div class="tsd-comment tsd-typography">
  2537. </div>
  2538. </li>
  2539. </ul>
  2540. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  2541. </li>
  2542. </ul>
  2543. </section>
  2544. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2545. <a name="setinearmonitoringvolume" class="tsd-anchor"></a>
  2546. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>InEar<wbr>Monitoring<wbr>Volume</h3>
  2547. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2548. <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>
  2549. </ul>
  2550. <ul class="tsd-descriptions">
  2551. <li class="tsd-description">
  2552. <aside class="tsd-sources">
  2553. <ul>
  2554. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L463">RtcEngine.native.ts:463</a></li>
  2555. </ul>
  2556. </aside>
  2557. <div class="tsd-comment tsd-typography">
  2558. <div class="lead">
  2559. <p>set in-ear monitoring volume</p>
  2560. </div>
  2561. <p>This method sets the in-ear-monitoring volume by number parameter volume</p>
  2562. </div>
  2563. <h4 class="tsd-parameters-title">Parameters</h4>
  2564. <ul class="tsd-parameters">
  2565. <li>
  2566. <h5>volume: <span class="tsd-signature-type">number</span></h5>
  2567. <div class="tsd-comment tsd-typography">
  2568. </div>
  2569. </li>
  2570. </ul>
  2571. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  2572. </li>
  2573. </ul>
  2574. </section>
  2575. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2576. <a name="setlivetranscoding" class="tsd-anchor"></a>
  2577. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Live<wbr>Transcoding</h3>
  2578. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2579. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2580. </ul>
  2581. <ul class="tsd-descriptions">
  2582. <li class="tsd-description">
  2583. <aside class="tsd-sources">
  2584. <ul>
  2585. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1181">RtcEngine.native.ts:1181</a></li>
  2586. </ul>
  2587. </aside>
  2588. <div class="tsd-comment tsd-typography">
  2589. <div class="lead">
  2590. <p>set live transcoding</p>
  2591. </div>
  2592. <p>This method sets the video layout and audio settings for CDN live.</p>
  2593. </div>
  2594. <h4 class="tsd-parameters-title">Parameters</h4>
  2595. <ul class="tsd-parameters">
  2596. <li>
  2597. <h5>options: <span class="tsd-signature-type">LiveTranscodingOption</span></h5>
  2598. </li>
  2599. </ul>
  2600. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2601. <p>Promise&lt;{success, value}&gt;</p>
  2602. </li>
  2603. </ul>
  2604. </section>
  2605. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2606. <a name="setlocalpublishfallbackoption" class="tsd-anchor"></a>
  2607. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Publish<wbr>Fallback<wbr>Option</h3>
  2608. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2609. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2610. </ul>
  2611. <ul class="tsd-descriptions">
  2612. <li class="tsd-description">
  2613. <aside class="tsd-sources">
  2614. <ul>
  2615. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L872">RtcEngine.native.ts:872</a></li>
  2616. </ul>
  2617. </aside>
  2618. <div class="tsd-comment tsd-typography">
  2619. <div class="lead">
  2620. <p>set local publish fallback</p>
  2621. </div>
  2622. <p>This method sets the fallback option for the locally published video stream based on the network conditions.</p>
  2623. </div>
  2624. <h4 class="tsd-parameters-title">Parameters</h4>
  2625. <ul class="tsd-parameters">
  2626. <li>
  2627. <h5>option: <span class="tsd-signature-type">number</span></h5>
  2628. <div class="tsd-comment tsd-typography">
  2629. <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>
  2630. </div>
  2631. </li>
  2632. </ul>
  2633. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2634. <p>Promise&lt;{success, value}&gt;</p>
  2635. </li>
  2636. </ul>
  2637. </section>
  2638. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2639. <a name="setlocalrendermode" class="tsd-anchor"></a>
  2640. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Render<wbr>Mode</h3>
  2641. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2642. <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>
  2643. </ul>
  2644. <ul class="tsd-descriptions">
  2645. <li class="tsd-description">
  2646. <aside class="tsd-sources">
  2647. <ul>
  2648. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L200">RtcEngine.native.ts:200</a></li>
  2649. </ul>
  2650. </aside>
  2651. <div class="tsd-comment tsd-typography">
  2652. <div class="lead">
  2653. <p>set local video render mode</p>
  2654. </div>
  2655. <p>This method calls native sdk render mode for local video.</p>
  2656. </div>
  2657. <h4 class="tsd-parameters-title">Parameters</h4>
  2658. <ul class="tsd-parameters">
  2659. <li>
  2660. <h5>mode: <span class="tsd-signature-type">number</span></h5>
  2661. <div class="tsd-comment tsd-typography">
  2662. </div>
  2663. </li>
  2664. </ul>
  2665. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  2666. </li>
  2667. </ul>
  2668. </section>
  2669. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2670. <a name="setlocalvideomirrormode" class="tsd-anchor"></a>
  2671. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Video<wbr>Mirror<wbr>Mode</h3>
  2672. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2673. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2674. </ul>
  2675. <ul class="tsd-descriptions">
  2676. <li class="tsd-description">
  2677. <aside class="tsd-sources">
  2678. <ul>
  2679. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L969">RtcEngine.native.ts:969</a></li>
  2680. </ul>
  2681. </aside>
  2682. <div class="tsd-comment tsd-typography">
  2683. <div class="lead">
  2684. <p>set local video mirror mode</p>
  2685. </div>
  2686. <p>This method sets local video mirror mode</p>
  2687. </div>
  2688. <h4 class="tsd-parameters-title">Parameters</h4>
  2689. <ul class="tsd-parameters">
  2690. <li>
  2691. <h5>mode: <span class="tsd-signature-type">number</span></h5>
  2692. </li>
  2693. </ul>
  2694. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2695. <p>Promise&lt;{success, value}&gt;</p>
  2696. </li>
  2697. </ul>
  2698. </section>
  2699. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2700. <a name="setlocalvoicechanger" class="tsd-anchor"></a>
  2701. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Voice<wbr>Changer</h3>
  2702. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2703. <li class="tsd-signature tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Changer<span class="tsd-signature-symbol">(</span>voiceChanger<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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2704. </ul>
  2705. <ul class="tsd-descriptions">
  2706. <li class="tsd-description">
  2707. <aside class="tsd-sources">
  2708. <ul>
  2709. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1239">RtcEngine.native.ts:1239</a></li>
  2710. </ul>
  2711. </aside>
  2712. <div class="tsd-comment tsd-typography">
  2713. <div class="lead">
  2714. <p>set local voice change</p>
  2715. </div>
  2716. <p>This method changes local speaker voice with voiceChanger</p>
  2717. <dl class="tsd-comment-tags">
  2718. <dt>voicechanger</dt>
  2719. <dd><p>value ranges [
  2720. 0: &quot;The original voice&quot;,
  2721. 1: &quot;An old man’s voice&quot;,
  2722. 2: &quot;A little boy’s voice.&quot;,
  2723. 3: &quot;A little girl’s voice.&quot;,
  2724. 4: &quot;TBD&quot;,
  2725. 5: &quot;Ethereal vocal effects.&quot;,
  2726. 6: &quot;Hulk’s voice.&quot;
  2727. ]</p>
  2728. </dd>
  2729. </dl>
  2730. </div>
  2731. <h4 class="tsd-parameters-title">Parameters</h4>
  2732. <ul class="tsd-parameters">
  2733. <li>
  2734. <h5>voiceChanger: <span class="tsd-signature-type">number</span></h5>
  2735. <div class="tsd-comment tsd-typography">
  2736. <p>integer</p>
  2737. </div>
  2738. </li>
  2739. </ul>
  2740. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2741. <p>Promise&lt;{success, value}&gt;</p>
  2742. </li>
  2743. </ul>
  2744. </section>
  2745. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2746. <a name="setlocalvoiceequalization" class="tsd-anchor"></a>
  2747. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Voice<wbr>Equalization</h3>
  2748. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2749. <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>
  2750. </ul>
  2751. <ul class="tsd-descriptions">
  2752. <li class="tsd-description">
  2753. <aside class="tsd-sources">
  2754. <ul>
  2755. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L486">RtcEngine.native.ts:486</a></li>
  2756. </ul>
  2757. </aside>
  2758. <div class="tsd-comment tsd-typography">
  2759. <div class="lead">
  2760. <p>set local voice equalization</p>
  2761. </div>
  2762. <p>This method set local video equalization of band frequency by enum band number and number of gain</p>
  2763. </div>
  2764. <h4 class="tsd-parameters-title">Parameters</h4>
  2765. <ul class="tsd-parameters">
  2766. <li>
  2767. <h5>band: <span class="tsd-signature-type">number</span></h5>
  2768. </li>
  2769. <li>
  2770. <h5>gain: <span class="tsd-signature-type">number</span></h5>
  2771. <div class="tsd-comment tsd-typography">
  2772. </div>
  2773. </li>
  2774. </ul>
  2775. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  2776. </li>
  2777. </ul>
  2778. </section>
  2779. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2780. <a name="setlocalvoicepitch" class="tsd-anchor"></a>
  2781. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Voice<wbr>Pitch</h3>
  2782. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2783. <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>
  2784. </ul>
  2785. <ul class="tsd-descriptions">
  2786. <li class="tsd-description">
  2787. <aside class="tsd-sources">
  2788. <ul>
  2789. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L474">RtcEngine.native.ts:474</a></li>
  2790. </ul>
  2791. </aside>
  2792. <div class="tsd-comment tsd-typography">
  2793. <div class="lead">
  2794. <p>set local voice pitch</p>
  2795. </div>
  2796. <p>This method sets the local voice pitch by float parameter pitch</p>
  2797. </div>
  2798. <h4 class="tsd-parameters-title">Parameters</h4>
  2799. <ul class="tsd-parameters">
  2800. <li>
  2801. <h5>pitch: <span class="tsd-signature-type">number</span></h5>
  2802. <div class="tsd-comment tsd-typography">
  2803. </div>
  2804. </li>
  2805. </ul>
  2806. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  2807. </li>
  2808. </ul>
  2809. </section>
  2810. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2811. <a name="setlocalvoicereverb" class="tsd-anchor"></a>
  2812. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Voice<wbr>Reverb</h3>
  2813. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2814. <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>
  2815. </ul>
  2816. <ul class="tsd-descriptions">
  2817. <li class="tsd-description">
  2818. <aside class="tsd-sources">
  2819. <ul>
  2820. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L497">RtcEngine.native.ts:497</a></li>
  2821. </ul>
  2822. </aside>
  2823. <div class="tsd-comment tsd-typography">
  2824. <div class="lead">
  2825. <p>set local voice reverb</p>
  2826. </div>
  2827. <p>This method sets local voice by reverb and value</p>
  2828. </div>
  2829. <h4 class="tsd-parameters-title">Parameters</h4>
  2830. <ul class="tsd-parameters">
  2831. <li>
  2832. <h5>reverb: <span class="tsd-signature-type">number</span></h5>
  2833. </li>
  2834. <li>
  2835. <h5>value: <span class="tsd-signature-type">number</span></h5>
  2836. <div class="tsd-comment tsd-typography">
  2837. </div>
  2838. </li>
  2839. </ul>
  2840. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  2841. </li>
  2842. </ul>
  2843. </section>
  2844. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2845. <a name="setlocalvoicereverbpreset" class="tsd-anchor"></a>
  2846. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Local<wbr>Voice<wbr>Reverb<wbr>Preset</h3>
  2847. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2848. <li class="tsd-signature tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Reverb<wbr>Preset<span class="tsd-signature-symbol">(</span>preset<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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2849. </ul>
  2850. <ul class="tsd-descriptions">
  2851. <li class="tsd-description">
  2852. <aside class="tsd-sources">
  2853. <ul>
  2854. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1251">RtcEngine.native.ts:1251</a></li>
  2855. </ul>
  2856. </aside>
  2857. <div class="tsd-comment tsd-typography">
  2858. <div class="lead">
  2859. <p>set the preset local voice reverberation effect.</p>
  2860. </div>
  2861. <p>This method sets the preset local voice reverberation effect.</p>
  2862. </div>
  2863. <h4 class="tsd-parameters-title">Parameters</h4>
  2864. <ul class="tsd-parameters">
  2865. <li>
  2866. <h5>preset: <span class="tsd-signature-type">number</span></h5>
  2867. <div class="tsd-comment tsd-typography">
  2868. <p>integer</p>
  2869. </div>
  2870. </li>
  2871. </ul>
  2872. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2873. <p>Promise&lt;{success, value}&gt;</p>
  2874. </li>
  2875. </ul>
  2876. </section>
  2877. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2878. <a name="setlog" class="tsd-anchor"></a>
  2879. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Log</h3>
  2880. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2881. <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>, maxfileSize<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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2882. </ul>
  2883. <ul class="tsd-descriptions">
  2884. <li class="tsd-description">
  2885. <aside class="tsd-sources">
  2886. <ul>
  2887. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1132">RtcEngine.native.ts:1132</a></li>
  2888. </ul>
  2889. </aside>
  2890. <div class="tsd-comment tsd-typography">
  2891. <div class="lead">
  2892. <p>set log file and log filter</p>
  2893. </div>
  2894. <p>This method sets the log file generated path and specified the log level.</p>
  2895. </div>
  2896. <h4 class="tsd-parameters-title">Parameters</h4>
  2897. <ul class="tsd-parameters">
  2898. <li>
  2899. <h5>filepath: <span class="tsd-signature-type">string</span></h5>
  2900. <div class="tsd-comment tsd-typography">
  2901. <p>string</p>
  2902. </div>
  2903. </li>
  2904. <li>
  2905. <h5>level: <span class="tsd-signature-type">number</span></h5>
  2906. <div class="tsd-comment tsd-typography">
  2907. <p>enum</p>
  2908. </div>
  2909. </li>
  2910. <li>
  2911. <h5>maxfileSize: <span class="tsd-signature-type">number</span></h5>
  2912. <div class="tsd-comment tsd-typography">
  2913. <p>integer (KB)</p>
  2914. </div>
  2915. </li>
  2916. </ul>
  2917. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2918. <p>Promise&lt;{success, value}&gt;</p>
  2919. </li>
  2920. </ul>
  2921. </section>
  2922. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2923. <a name="setmixedaudioframeparameters" class="tsd-anchor"></a>
  2924. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Mixed<wbr>Audio<wbr>Frame<wbr>Parameters</h3>
  2925. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2926. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2927. </ul>
  2928. <ul class="tsd-descriptions">
  2929. <li class="tsd-description">
  2930. <aside class="tsd-sources">
  2931. <ul>
  2932. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L837">RtcEngine.native.ts:837</a></li>
  2933. </ul>
  2934. </aside>
  2935. <div class="tsd-comment tsd-typography">
  2936. <div class="lead">
  2937. <p>set mixed audio frame parameters</p>
  2938. </div>
  2939. <p>This method Sets the audio frame format for the mixedAudioFrame callback.</p>
  2940. </div>
  2941. <h4 class="tsd-parameters-title">Parameters</h4>
  2942. <ul class="tsd-parameters">
  2943. <li>
  2944. <h5>options: <span class="tsd-signature-type">MixedAudioFrameOption</span></h5>
  2945. </li>
  2946. </ul>
  2947. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2948. <p>Promise&lt;{success, value}&gt;</p>
  2949. </li>
  2950. </ul>
  2951. </section>
  2952. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2953. <a name="setplaybackaudioframeparameters" class="tsd-anchor"></a>
  2954. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Playback<wbr>Audio<wbr>Frame<wbr>Parameters</h3>
  2955. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2956. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2957. </ul>
  2958. <ul class="tsd-descriptions">
  2959. <li class="tsd-description">
  2960. <aside class="tsd-sources">
  2961. <ul>
  2962. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L825">RtcEngine.native.ts:825</a></li>
  2963. </ul>
  2964. </aside>
  2965. <div class="tsd-comment tsd-typography">
  2966. <div class="lead">
  2967. <p>set playback audio frame parameters</p>
  2968. </div>
  2969. <p>This method Sets the audio frame format for the playbackFrame callback.</p>
  2970. </div>
  2971. <h4 class="tsd-parameters-title">Parameters</h4>
  2972. <ul class="tsd-parameters">
  2973. <li>
  2974. <h5>options: <span class="tsd-signature-type">AudioFrameOption</span></h5>
  2975. </li>
  2976. </ul>
  2977. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  2978. <p>Promise&lt;{success, value}&gt;</p>
  2979. </li>
  2980. </ul>
  2981. </section>
  2982. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2983. <a name="setrecordingaudioframeparameters" class="tsd-anchor"></a>
  2984. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Recording<wbr>Audio<wbr>Frame<wbr>Parameters</h3>
  2985. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  2986. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  2987. </ul>
  2988. <ul class="tsd-descriptions">
  2989. <li class="tsd-description">
  2990. <aside class="tsd-sources">
  2991. <ul>
  2992. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L813">RtcEngine.native.ts:813</a></li>
  2993. </ul>
  2994. </aside>
  2995. <div class="tsd-comment tsd-typography">
  2996. <div class="lead">
  2997. <p>set recording audio frame parameters</p>
  2998. </div>
  2999. <p>This method Sets the audio recording format for the audioFrame callback.</p>
  3000. </div>
  3001. <h4 class="tsd-parameters-title">Parameters</h4>
  3002. <ul class="tsd-parameters">
  3003. <li>
  3004. <h5>options: <span class="tsd-signature-type">AudioFrameOption</span></h5>
  3005. </li>
  3006. </ul>
  3007. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3008. <p>Promise&lt;{success, value}&gt;</p>
  3009. </li>
  3010. </ul>
  3011. </section>
  3012. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3013. <a name="setremotedefaultvideostreamtype" class="tsd-anchor"></a>
  3014. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Remote<wbr>Default<wbr>Video<wbr>Stream<wbr>Type</h3>
  3015. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3016. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3017. </ul>
  3018. <ul class="tsd-descriptions">
  3019. <li class="tsd-description">
  3020. <aside class="tsd-sources">
  3021. <ul>
  3022. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L920">RtcEngine.native.ts:920</a></li>
  3023. </ul>
  3024. </aside>
  3025. <div class="tsd-comment tsd-typography">
  3026. <div class="lead">
  3027. <p>set remote default video stream type</p>
  3028. </div>
  3029. <p>This method sets the default video stream type.</p>
  3030. </div>
  3031. <h4 class="tsd-parameters-title">Parameters</h4>
  3032. <ul class="tsd-parameters">
  3033. <li>
  3034. <h5>options: <span class="tsd-signature-type">DefaultVideoStreamOption</span></h5>
  3035. </li>
  3036. </ul>
  3037. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3038. <p>Promise&lt;{success, value}&gt;</p>
  3039. </li>
  3040. </ul>
  3041. </section>
  3042. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3043. <a name="setremoterendermode" class="tsd-anchor"></a>
  3044. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Remote<wbr>Render<wbr>Mode</h3>
  3045. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3046. <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>
  3047. </ul>
  3048. <ul class="tsd-descriptions">
  3049. <li class="tsd-description">
  3050. <aside class="tsd-sources">
  3051. <ul>
  3052. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L212">RtcEngine.native.ts:212</a></li>
  3053. </ul>
  3054. </aside>
  3055. <div class="tsd-comment tsd-typography">
  3056. <div class="lead">
  3057. <p>set the specified remote video render mode</p>
  3058. </div>
  3059. <p>This method calls native sdk render mode for the specified remote video.</p>
  3060. </div>
  3061. <h4 class="tsd-parameters-title">Parameters</h4>
  3062. <ul class="tsd-parameters">
  3063. <li>
  3064. <h5>uid: <span class="tsd-signature-type">number</span></h5>
  3065. </li>
  3066. <li>
  3067. <h5>mode: <span class="tsd-signature-type">number</span></h5>
  3068. <div class="tsd-comment tsd-typography">
  3069. </div>
  3070. </li>
  3071. </ul>
  3072. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  3073. </li>
  3074. </ul>
  3075. </section>
  3076. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3077. <a name="setremotesubscribefallbackoption" class="tsd-anchor"></a>
  3078. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Remote<wbr>Subscribe<wbr>Fallback<wbr>Option</h3>
  3079. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3080. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3081. </ul>
  3082. <ul class="tsd-descriptions">
  3083. <li class="tsd-description">
  3084. <aside class="tsd-sources">
  3085. <ul>
  3086. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L884">RtcEngine.native.ts:884</a></li>
  3087. </ul>
  3088. </aside>
  3089. <div class="tsd-comment tsd-typography">
  3090. <div class="lead">
  3091. <p>set remote publish fallback</p>
  3092. </div>
  3093. <p>This method sets the fallback option for the remotely subscribed video stream based on the network conditions.</p>
  3094. </div>
  3095. <h4 class="tsd-parameters-title">Parameters</h4>
  3096. <ul class="tsd-parameters">
  3097. <li>
  3098. <h5>option: <span class="tsd-signature-type">number</span></h5>
  3099. <div class="tsd-comment tsd-typography">
  3100. <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>
  3101. </div>
  3102. </li>
  3103. </ul>
  3104. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3105. <p>Promise&lt;{success, value}&gt;</p>
  3106. </li>
  3107. </ul>
  3108. </section>
  3109. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3110. <a name="setremoteuserpriority" class="tsd-anchor"></a>
  3111. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Remote<wbr>User<wbr>Priority</h3>
  3112. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3113. <li class="tsd-signature tsd-kind-icon">set<wbr>Remote<wbr>User<wbr>Priority<span class="tsd-signature-symbol">(</span>uid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, userPrority<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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3114. </ul>
  3115. <ul class="tsd-descriptions">
  3116. <li class="tsd-description">
  3117. <aside class="tsd-sources">
  3118. <ul>
  3119. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1322">RtcEngine.native.ts:1322</a></li>
  3120. </ul>
  3121. </aside>
  3122. <div class="tsd-comment tsd-typography">
  3123. <div class="lead">
  3124. <p>sets the priority of a remote user&#39;s media stream.</p>
  3125. </div>
  3126. <p>note: Use this method with the setRemoteSubscribeFallbackOption method. If the fallback function is enabled for a subscribed stream, the SDK ensures the high-priority user gets the best possible stream quality.</p>
  3127. <p>This method sets the priority of a remote user&#39;s media stream.</p>
  3128. </div>
  3129. <h4 class="tsd-parameters-title">Parameters</h4>
  3130. <ul class="tsd-parameters">
  3131. <li>
  3132. <h5>uid: <span class="tsd-signature-type">number</span></h5>
  3133. <div class="tsd-comment tsd-typography">
  3134. <p>number</p>
  3135. </div>
  3136. </li>
  3137. <li>
  3138. <h5>userPrority: <span class="tsd-signature-type">number</span></h5>
  3139. </li>
  3140. </ul>
  3141. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3142. <p>Promise&lt;{success, value}&gt;</p>
  3143. </li>
  3144. </ul>
  3145. </section>
  3146. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3147. <a name="setremotevideostreamtype" class="tsd-anchor"></a>
  3148. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Remote<wbr>Video<wbr>Stream<wbr>Type</h3>
  3149. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3150. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3151. </ul>
  3152. <ul class="tsd-descriptions">
  3153. <li class="tsd-description">
  3154. <aside class="tsd-sources">
  3155. <ul>
  3156. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L908">RtcEngine.native.ts:908</a></li>
  3157. </ul>
  3158. </aside>
  3159. <div class="tsd-comment tsd-typography">
  3160. <div class="lead">
  3161. <p>set remote video stream type</p>
  3162. </div>
  3163. <p>This method sets the remote video stream type by uid and streamType.</p>
  3164. </div>
  3165. <h4 class="tsd-parameters-title">Parameters</h4>
  3166. <ul class="tsd-parameters">
  3167. <li>
  3168. <h5>options: <span class="tsd-signature-type">VideoStreamOption</span></h5>
  3169. </li>
  3170. </ul>
  3171. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3172. <p>Promise&lt;{success, value}&gt;</p>
  3173. </li>
  3174. </ul>
  3175. </section>
  3176. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3177. <a name="setremotevoiceposition" class="tsd-anchor"></a>
  3178. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Remote<wbr>Voice<wbr>Position</h3>
  3179. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3180. <li class="tsd-signature tsd-kind-icon">set<wbr>Remote<wbr>Voice<wbr>Position<span class="tsd-signature-symbol">(</span>uid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, pan<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3181. </ul>
  3182. <ul class="tsd-descriptions">
  3183. <li class="tsd-description">
  3184. <aside class="tsd-sources">
  3185. <ul>
  3186. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1281">RtcEngine.native.ts:1281</a></li>
  3187. </ul>
  3188. </aside>
  3189. <div class="tsd-comment tsd-typography">
  3190. <div class="lead">
  3191. <p>set the sound position of a remote user</p>
  3192. </div>
  3193. <p>This method sets the sound position of a remote user by uid</p>
  3194. <dl class="tsd-comment-tags">
  3195. <dt>pan</dt>
  3196. <dd><p> 0.0: the remote sound comes from the front.
  3197. -1.0: the remote sound comes from the left.
  3198. 1.0: the remote sound comes from the right.</p>
  3199. </dd>
  3200. </dl>
  3201. </div>
  3202. <h4 class="tsd-parameters-title">Parameters</h4>
  3203. <ul class="tsd-parameters">
  3204. <li>
  3205. <h5>uid: <span class="tsd-signature-type">number</span></h5>
  3206. <div class="tsd-comment tsd-typography">
  3207. <p>number | The ID of the remote user</p>
  3208. </div>
  3209. </li>
  3210. <li>
  3211. <h5>pan: <span class="tsd-signature-type">number</span></h5>
  3212. <div class="tsd-comment tsd-typography">
  3213. <p>float | The sound position of the remote user. The value ranges from -1.0 to 1.0</p>
  3214. </div>
  3215. </li>
  3216. <li>
  3217. <h5>gain: <span class="tsd-signature-type">number</span></h5>
  3218. <div class="tsd-comment tsd-typography">
  3219. <p>float | Gain of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original gain of the remote user). The smaller the value, the less the gain.</p>
  3220. </div>
  3221. </li>
  3222. </ul>
  3223. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3224. <p>Promise&lt;{success, value}&gt;</p>
  3225. </li>
  3226. </ul>
  3227. </section>
  3228. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3229. <a name="setvolumeofeffect" class="tsd-anchor"></a>
  3230. <h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Volume<wbr>OfEffect</h3>
  3231. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3232. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3233. </ul>
  3234. <ul class="tsd-descriptions">
  3235. <li class="tsd-description">
  3236. <aside class="tsd-sources">
  3237. <ul>
  3238. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L626">RtcEngine.native.ts:626</a></li>
  3239. </ul>
  3240. </aside>
  3241. <div class="tsd-comment tsd-typography">
  3242. <div class="lead">
  3243. <p>set volume for playing effects.</p>
  3244. </div>
  3245. <p>This methods set for playing audio mixing effects</p>
  3246. </div>
  3247. <h4 class="tsd-parameters-title">Parameters</h4>
  3248. <ul class="tsd-parameters">
  3249. <li>
  3250. <h5>volume: <span class="tsd-signature-type">number</span></h5>
  3251. </li>
  3252. </ul>
  3253. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3254. <p>Promise&lt;{success, value}&gt;</p>
  3255. </li>
  3256. </ul>
  3257. </section>
  3258. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3259. <a name="setuplocalvideo" class="tsd-anchor"></a>
  3260. <h3><span class="tsd-flag ts-flagStatic">Static</span> setup<wbr>Local<wbr>Video</h3>
  3261. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3262. <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>
  3263. </ul>
  3264. <ul class="tsd-descriptions">
  3265. <li class="tsd-description">
  3266. <aside class="tsd-sources">
  3267. <ul>
  3268. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L180">RtcEngine.native.ts:180</a></li>
  3269. </ul>
  3270. </aside>
  3271. <div class="tsd-comment tsd-typography">
  3272. <div class="lead">
  3273. <p>show local video</p>
  3274. </div>
  3275. <p>This method calls native sdk render canvas for local video.</p>
  3276. </div>
  3277. <h4 class="tsd-parameters-title">Parameters</h4>
  3278. <ul class="tsd-parameters">
  3279. <li>
  3280. <h5>options: <span class="tsd-signature-type">VideoOption</span></h5>
  3281. <div class="tsd-comment tsd-typography">
  3282. </div>
  3283. </li>
  3284. </ul>
  3285. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  3286. </li>
  3287. </ul>
  3288. </section>
  3289. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3290. <a name="setupremotevideo" class="tsd-anchor"></a>
  3291. <h3><span class="tsd-flag ts-flagStatic">Static</span> setup<wbr>Remote<wbr>Video</h3>
  3292. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3293. <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>
  3294. </ul>
  3295. <ul class="tsd-descriptions">
  3296. <li class="tsd-description">
  3297. <aside class="tsd-sources">
  3298. <ul>
  3299. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L190">RtcEngine.native.ts:190</a></li>
  3300. </ul>
  3301. </aside>
  3302. <div class="tsd-comment tsd-typography">
  3303. <div class="lead">
  3304. <p>show remote video</p>
  3305. </div>
  3306. <p>This method calls native sdk render canvas for remote video.</p>
  3307. </div>
  3308. <h4 class="tsd-parameters-title">Parameters</h4>
  3309. <ul class="tsd-parameters">
  3310. <li>
  3311. <h5>options: <span class="tsd-signature-type">VideoOption</span></h5>
  3312. <div class="tsd-comment tsd-typography">
  3313. </div>
  3314. </li>
  3315. </ul>
  3316. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  3317. </li>
  3318. </ul>
  3319. </section>
  3320. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3321. <a name="startaudiomixing" class="tsd-anchor"></a>
  3322. <h3><span class="tsd-flag ts-flagStatic">Static</span> start<wbr>Audio<wbr>Mixing</h3>
  3323. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3324. <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>
  3325. </ul>
  3326. <ul class="tsd-descriptions">
  3327. <li class="tsd-description">
  3328. <aside class="tsd-sources">
  3329. <ul>
  3330. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L508">RtcEngine.native.ts:508</a></li>
  3331. </ul>
  3332. </aside>
  3333. <div class="tsd-comment tsd-typography">
  3334. <div class="lead">
  3335. <p>start audio mixing</p>
  3336. </div>
  3337. <p>This method will start audio mixing by option config</p>
  3338. </div>
  3339. <h4 class="tsd-parameters-title">Parameters</h4>
  3340. <ul class="tsd-parameters">
  3341. <li>
  3342. <h5>options: <span class="tsd-signature-type">AudioMixingOption</span></h5>
  3343. <div class="tsd-comment tsd-typography">
  3344. </div>
  3345. </li>
  3346. </ul>
  3347. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  3348. </li>
  3349. </ul>
  3350. </section>
  3351. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3352. <a name="startaudiorecording" class="tsd-anchor"></a>
  3353. <h3><span class="tsd-flag ts-flagStatic">Static</span> start<wbr>Audio<wbr>Recording</h3>
  3354. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3355. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3356. </ul>
  3357. <ul class="tsd-descriptions">
  3358. <li class="tsd-description">
  3359. <aside class="tsd-sources">
  3360. <ul>
  3361. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L735">RtcEngine.native.ts:735</a></li>
  3362. </ul>
  3363. </aside>
  3364. <div class="tsd-comment tsd-typography">
  3365. <div class="lead">
  3366. <p>start audio recording by quality</p>
  3367. </div>
  3368. <p>This method start audio recording by quality config</p>
  3369. </div>
  3370. <h4 class="tsd-parameters-title">Parameters</h4>
  3371. <ul class="tsd-parameters">
  3372. <li>
  3373. <h5>options: <span class="tsd-signature-type">AudioRecordingOption</span></h5>
  3374. </li>
  3375. </ul>
  3376. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3377. <p>Promise&lt;{success, value}&gt;</p>
  3378. </li>
  3379. </ul>
  3380. </section>
  3381. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3382. <a name="startechotestwithinterval" class="tsd-anchor"></a>
  3383. <h3><span class="tsd-flag ts-flagStatic">Static</span> start<wbr>Echo<wbr>Test<wbr>With<wbr>Interval</h3>
  3384. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3385. <li class="tsd-signature tsd-kind-icon">start<wbr>Echo<wbr>Test<wbr>With<wbr>Interval<span class="tsd-signature-symbol">(</span>interval<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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3386. </ul>
  3387. <ul class="tsd-descriptions">
  3388. <li class="tsd-description">
  3389. <aside class="tsd-sources">
  3390. <ul>
  3391. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1340">RtcEngine.native.ts:1340</a></li>
  3392. </ul>
  3393. </aside>
  3394. <div class="tsd-comment tsd-typography">
  3395. <div class="lead">
  3396. <p>start an audio call test.</p>
  3397. </div>
  3398. <p>note:
  3399. Call this method before joining a channel.
  3400. After calling this method, call the stopEchoTest method to end the test. Otherwise, the app cannot run the next echo test, or call the joinchannel method.
  3401. In the Live-broadcast profile, only a host can call this method.
  3402. This method will start an audio call test with interval parameter.
  3403. In the audio call test, you record your voice. If the recording plays back within the set time interval, the audio devices and the network connection are working properly.</p>
  3404. </div>
  3405. <h4 class="tsd-parameters-title">Parameters</h4>
  3406. <ul class="tsd-parameters">
  3407. <li>
  3408. <h5>interval: <span class="tsd-signature-type">number</span></h5>
  3409. <div class="tsd-comment tsd-typography">
  3410. <p>number</p>
  3411. </div>
  3412. </li>
  3413. </ul>
  3414. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3415. <p>Promise&lt;{success, value}&gt;</p>
  3416. </li>
  3417. </ul>
  3418. </section>
  3419. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3420. <a name="startpreview" class="tsd-anchor"></a>
  3421. <h3><span class="tsd-flag ts-flagStatic">Static</span> start<wbr>Preview</h3>
  3422. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3423. <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>
  3424. </ul>
  3425. <ul class="tsd-descriptions">
  3426. <li class="tsd-description">
  3427. <aside class="tsd-sources">
  3428. <ul>
  3429. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L221">RtcEngine.native.ts:221</a></li>
  3430. </ul>
  3431. </aside>
  3432. <div class="tsd-comment tsd-typography">
  3433. <div class="lead">
  3434. <p>start video preview</p>
  3435. </div>
  3436. <p>This method start video preview for video.</p>
  3437. </div>
  3438. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  3439. </li>
  3440. </ul>
  3441. </section>
  3442. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3443. <a name="stopalleffects" class="tsd-anchor"></a>
  3444. <h3><span class="tsd-flag ts-flagStatic">Static</span> stop<wbr>All<wbr>Effects</h3>
  3445. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3446. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3447. </ul>
  3448. <ul class="tsd-descriptions">
  3449. <li class="tsd-description">
  3450. <aside class="tsd-sources">
  3451. <ul>
  3452. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L658">RtcEngine.native.ts:658</a></li>
  3453. </ul>
  3454. </aside>
  3455. <div class="tsd-comment tsd-typography">
  3456. <div class="lead">
  3457. <p>stop play all for effect audio mixing.</p>
  3458. </div>
  3459. <p>This methods stops all effect audio mixing.</p>
  3460. </div>
  3461. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3462. <p>Promise&lt;{success, value}&gt;</p>
  3463. </li>
  3464. </ul>
  3465. </section>
  3466. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3467. <a name="stopaudiomixing" class="tsd-anchor"></a>
  3468. <h3><span class="tsd-flag ts-flagStatic">Static</span> stop<wbr>Audio<wbr>Mixing</h3>
  3469. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3470. <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>
  3471. </ul>
  3472. <ul class="tsd-descriptions">
  3473. <li class="tsd-description">
  3474. <aside class="tsd-sources">
  3475. <ul>
  3476. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L517">RtcEngine.native.ts:517</a></li>
  3477. </ul>
  3478. </aside>
  3479. <div class="tsd-comment tsd-typography">
  3480. <div class="lead">
  3481. <p>stop audio mixing</p>
  3482. </div>
  3483. <p>This methods stops for audio mixing.</p>
  3484. </div>
  3485. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  3486. </li>
  3487. </ul>
  3488. </section>
  3489. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3490. <a name="stopaudiorecording" class="tsd-anchor"></a>
  3491. <h3><span class="tsd-flag ts-flagStatic">Static</span> stop<wbr>Audio<wbr>Recording</h3>
  3492. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3493. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3494. </ul>
  3495. <ul class="tsd-descriptions">
  3496. <li class="tsd-description">
  3497. <aside class="tsd-sources">
  3498. <ul>
  3499. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L745">RtcEngine.native.ts:745</a></li>
  3500. </ul>
  3501. </aside>
  3502. <div class="tsd-comment tsd-typography">
  3503. <div class="lead">
  3504. <p>stop audio recording</p>
  3505. </div>
  3506. <p>This method stops audio recording.</p>
  3507. </div>
  3508. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3509. <p>Promise&lt;{success, value}&gt;</p>
  3510. </li>
  3511. </ul>
  3512. </section>
  3513. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3514. <a name="stopechotest" class="tsd-anchor"></a>
  3515. <h3><span class="tsd-flag ts-flagStatic">Static</span> stop<wbr>Echo<wbr>Test</h3>
  3516. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3517. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3518. </ul>
  3519. <ul class="tsd-descriptions">
  3520. <li class="tsd-description">
  3521. <aside class="tsd-sources">
  3522. <ul>
  3523. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L779">RtcEngine.native.ts:779</a></li>
  3524. </ul>
  3525. </aside>
  3526. <div class="tsd-comment tsd-typography">
  3527. <div class="lead">
  3528. <p>stop echo test</p>
  3529. </div>
  3530. <p>This method stop launched an audio call test.</p>
  3531. </div>
  3532. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3533. <p>Promise&lt;{success, value}&gt;</p>
  3534. </li>
  3535. </ul>
  3536. </section>
  3537. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3538. <a name="stopeffect" class="tsd-anchor"></a>
  3539. <h3><span class="tsd-flag ts-flagStatic">Static</span> stop<wbr>Effect</h3>
  3540. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3541. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3542. </ul>
  3543. <ul class="tsd-descriptions">
  3544. <li class="tsd-description">
  3545. <aside class="tsd-sources">
  3546. <ul>
  3547. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L648">RtcEngine.native.ts:648</a></li>
  3548. </ul>
  3549. </aside>
  3550. <div class="tsd-comment tsd-typography">
  3551. <div class="lead">
  3552. <p>stop play effect for audio mixing</p>
  3553. </div>
  3554. <p>This methods stops the specified effect for audio mixing file by soundid.</p>
  3555. </div>
  3556. <h4 class="tsd-parameters-title">Parameters</h4>
  3557. <ul class="tsd-parameters">
  3558. <li>
  3559. <h5>soundId: <span class="tsd-signature-type">number</span></h5>
  3560. </li>
  3561. </ul>
  3562. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3563. <p>Promise&lt;{success, value}&gt;</p>
  3564. </li>
  3565. </ul>
  3566. </section>
  3567. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3568. <a name="stoplastmileprobetest" class="tsd-anchor"></a>
  3569. <h3><span class="tsd-flag ts-flagStatic">Static</span> stop<wbr>Lastmile<wbr>Probe<wbr>Test</h3>
  3570. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3571. <li class="tsd-signature tsd-kind-icon">stop<wbr>Lastmile<wbr>Probe<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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3572. </ul>
  3573. <ul class="tsd-descriptions">
  3574. <li class="tsd-description">
  3575. <aside class="tsd-sources">
  3576. <ul>
  3577. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L1307">RtcEngine.native.ts:1307</a></li>
  3578. </ul>
  3579. </aside>
  3580. <div class="tsd-comment tsd-typography">
  3581. <div class="lead">
  3582. <p>stop the lastmile probe test</p>
  3583. </div>
  3584. <p>This method stop the lastmile probe test.</p>
  3585. </div>
  3586. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3587. <p>Promise&lt;{success, value}&gt;</p>
  3588. </li>
  3589. </ul>
  3590. </section>
  3591. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3592. <a name="stoppreview" class="tsd-anchor"></a>
  3593. <h3><span class="tsd-flag ts-flagStatic">Static</span> stop<wbr>Preview</h3>
  3594. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3595. <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>
  3596. </ul>
  3597. <ul class="tsd-descriptions">
  3598. <li class="tsd-description">
  3599. <aside class="tsd-sources">
  3600. <ul>
  3601. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L231">RtcEngine.native.ts:231</a></li>
  3602. </ul>
  3603. </aside>
  3604. <div class="tsd-comment tsd-typography">
  3605. <div class="lead">
  3606. <p>stop video preview</p>
  3607. </div>
  3608. <p>This method stops video preview for video.</p>
  3609. </div>
  3610. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  3611. </li>
  3612. </ul>
  3613. </section>
  3614. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3615. <a name="switchcamera" class="tsd-anchor"></a>
  3616. <h3><span class="tsd-flag ts-flagStatic">Static</span> switch<wbr>Camera</h3>
  3617. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3618. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3619. </ul>
  3620. <ul class="tsd-descriptions">
  3621. <li class="tsd-description">
  3622. <aside class="tsd-sources">
  3623. <ul>
  3624. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L980">RtcEngine.native.ts:980</a></li>
  3625. </ul>
  3626. </aside>
  3627. <div class="tsd-comment tsd-typography">
  3628. <div class="lead">
  3629. <p>switch camera</p>
  3630. </div>
  3631. <p>This method switches camera between front and rear.</p>
  3632. </div>
  3633. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3634. <p>Promise&lt;{success, value}&gt;</p>
  3635. </li>
  3636. </ul>
  3637. </section>
  3638. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3639. <a name="unloadeffect" class="tsd-anchor"></a>
  3640. <h3><span class="tsd-flag ts-flagStatic">Static</span> unload<wbr>Effect</h3>
  3641. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3642. <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
  3643. </ul>
  3644. <ul class="tsd-descriptions">
  3645. <li class="tsd-description">
  3646. <aside class="tsd-sources">
  3647. <ul>
  3648. <li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/a5040a9/src/RtcEngine.native.ts#L681">RtcEngine.native.ts:681</a></li>
  3649. </ul>
  3650. </aside>
  3651. <div class="tsd-comment tsd-typography">
  3652. <div class="lead">
  3653. <p>unload effect</p>
  3654. </div>
  3655. <p>This methods unload the already loaded audio mixing file from memory by the soundid.</p>
  3656. </div>
  3657. <h4 class="tsd-parameters-title">Parameters</h4>
  3658. <ul class="tsd-parameters">
  3659. <li>
  3660. <h5>soundId: <span class="tsd-signature-type">number</span></h5>
  3661. </li>
  3662. </ul>
  3663. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
  3664. <p>Promise&lt;{success, value}&gt;</p>
  3665. </li>
  3666. </ul>
  3667. </section>
  3668. </section>
  3669. </div>
  3670. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  3671. <nav class="tsd-navigation primary">
  3672. <ul>
  3673. <li class="globals ">
  3674. <a href="../globals.html"><em>Globals</em></a>
  3675. </li>
  3676. </ul>
  3677. </nav>
  3678. <nav class="tsd-navigation secondary menu-sticky">
  3679. <ul class="before-current">
  3680. <li class=" tsd-kind-class tsd-has-type-parameter">
  3681. <a href="agoraview.html" class="tsd-kind-icon">Agora<wbr>View</a>
  3682. </li>
  3683. </ul>
  3684. <ul class="current">
  3685. <li class="current tsd-kind-class">
  3686. <a href="rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
  3687. <ul>
  3688. <li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
  3689. <a href="rtcengine.html#startlastmileprobetest" class="tsd-kind-icon">start<wbr>Lastmile<wbr>Probe<wbr>Test</a>
  3690. </li>
  3691. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
  3692. <a href="rtcengine.html#eventtypes" class="tsd-kind-icon">event<wbr>Types</a>
  3693. </li>
  3694. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3695. <a href="rtcengine.html#addinjectstreamurl" class="tsd-kind-icon">add<wbr>Inject<wbr>Stream<wbr>Url</a>
  3696. </li>
  3697. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3698. <a href="rtcengine.html#addpublishstreamurl" class="tsd-kind-icon">add<wbr>Publish<wbr>Stream<wbr>Url</a>
  3699. </li>
  3700. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3701. <a href="rtcengine.html#addvideowatermark" class="tsd-kind-icon">add<wbr>Video<wbr>Watermark</a>
  3702. </li>
  3703. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3704. <a href="rtcengine.html#adjustaudiomixingplayoutvolume" class="tsd-kind-icon">adjust<wbr>Audio<wbr>Mixing<wbr>Playout<wbr>Volume</a>
  3705. </li>
  3706. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3707. <a href="rtcengine.html#adjustaudiomixingpublishvolume" class="tsd-kind-icon">adjust<wbr>Audio<wbr>Mixing<wbr>Publish<wbr>Volume</a>
  3708. </li>
  3709. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3710. <a href="rtcengine.html#adjustaudiomixingvolume" class="tsd-kind-icon">adjust<wbr>Audio<wbr>Mixing<wbr>Volume</a>
  3711. </li>
  3712. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3713. <a href="rtcengine.html#adjustplaybacksignalvolume" class="tsd-kind-icon">adjust<wbr>Playback<wbr>Signal<wbr>Volume</a>
  3714. </li>
  3715. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3716. <a href="rtcengine.html#adjustrecordingsignalvolume" class="tsd-kind-icon">adjust<wbr>Recording<wbr>Signal<wbr>Volume</a>
  3717. </li>
  3718. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3719. <a href="rtcengine.html#createdatastream" class="tsd-kind-icon">create<wbr>Data<wbr>Stream</a>
  3720. </li>
  3721. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3722. <a href="rtcengine.html#destroy" class="tsd-kind-icon">destroy</a>
  3723. </li>
  3724. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3725. <a href="rtcengine.html#disableaudio" class="tsd-kind-icon">disable<wbr>Audio</a>
  3726. </li>
  3727. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3728. <a href="rtcengine.html#disablelastmiletest" class="tsd-kind-icon">disable<wbr>Lastmile<wbr>Test</a>
  3729. </li>
  3730. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3731. <a href="rtcengine.html#disablelocalaudio" class="tsd-kind-icon">disable<wbr>Local<wbr>Audio</a>
  3732. </li>
  3733. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3734. <a href="rtcengine.html#disablevideo" class="tsd-kind-icon">disable<wbr>Video</a>
  3735. </li>
  3736. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3737. <a href="rtcengine.html#enableaudio" class="tsd-kind-icon">enable<wbr>Audio</a>
  3738. </li>
  3739. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3740. <a href="rtcengine.html#enableaudiovolumeindication" class="tsd-kind-icon">enable<wbr>Audio<wbr>Volume<wbr>Indication</a>
  3741. </li>
  3742. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3743. <a href="rtcengine.html#enabledualstreammode" class="tsd-kind-icon">enable<wbr>Dual<wbr>Stream<wbr>Mode</a>
  3744. </li>
  3745. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3746. <a href="rtcengine.html#enableinearmonitoring" class="tsd-kind-icon">enable<wbr>InEar<wbr>Monitoring</a>
  3747. </li>
  3748. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3749. <a href="rtcengine.html#enablelastmiletest" class="tsd-kind-icon">enable<wbr>Lastmile<wbr>Test</a>
  3750. </li>
  3751. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3752. <a href="rtcengine.html#enablelocalaudio" class="tsd-kind-icon">enable<wbr>Local<wbr>Audio</a>
  3753. </li>
  3754. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3755. <a href="rtcengine.html#enablelocalvideo" class="tsd-kind-icon">enable<wbr>Local<wbr>Video</a>
  3756. </li>
  3757. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3758. <a href="rtcengine.html#enablesoundpositionindication" class="tsd-kind-icon">enable<wbr>Sound<wbr>Position<wbr>Indication</a>
  3759. </li>
  3760. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3761. <a href="rtcengine.html#enablevideo" class="tsd-kind-icon">enable<wbr>Video</a>
  3762. </li>
  3763. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3764. <a href="rtcengine.html#enablewebsdkinteroperability" class="tsd-kind-icon">enable<wbr>Web<wbr>Sdk<wbr>Interoperability</a>
  3765. </li>
  3766. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3767. <a href="rtcengine.html#getaudiomixingcurrentposition" class="tsd-kind-icon">get<wbr>Audio<wbr>Mixing<wbr>Current<wbr>Position</a>
  3768. </li>
  3769. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3770. <a href="rtcengine.html#getaudiomixingduration" class="tsd-kind-icon">get<wbr>Audio<wbr>Mixing<wbr>Duration</a>
  3771. </li>
  3772. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3773. <a href="rtcengine.html#getcallid" class="tsd-kind-icon">get<wbr>Call<wbr>Id</a>
  3774. </li>
  3775. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3776. <a href="rtcengine.html#getcameramaxzoomfactor" class="tsd-kind-icon">get<wbr>Camera<wbr>Max<wbr>Zoom<wbr>Factor</a>
  3777. </li>
  3778. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3779. <a href="rtcengine.html#getconnectionstate" class="tsd-kind-icon">get<wbr>Connection<wbr>State</a>
  3780. </li>
  3781. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3782. <a href="rtcengine.html#geteffectsvolume" class="tsd-kind-icon">get<wbr>Effects<wbr>Volume</a>
  3783. </li>
  3784. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3785. <a href="rtcengine.html#getsdkversion" class="tsd-kind-icon">get<wbr>Sdk<wbr>Version</a>
  3786. </li>
  3787. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3788. <a href="rtcengine.html#init" class="tsd-kind-icon">init</a>
  3789. </li>
  3790. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3791. <a href="rtcengine.html#iscameraautofocusfacemodesupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Auto<wbr>Focus<wbr>Face<wbr>Mode<wbr>Supported</a>
  3792. </li>
  3793. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3794. <a href="rtcengine.html#iscameraexposurepositionsupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Exposure<wbr>Position<wbr>Supported</a>
  3795. </li>
  3796. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3797. <a href="rtcengine.html#iscamerafocussupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Focus<wbr>Supported</a>
  3798. </li>
  3799. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3800. <a href="rtcengine.html#iscameratorchsupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Torch<wbr>Supported</a>
  3801. </li>
  3802. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3803. <a href="rtcengine.html#iscamerazoomsupported" class="tsd-kind-icon">is<wbr>Camera<wbr>Zoom<wbr>Supported</a>
  3804. </li>
  3805. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3806. <a href="rtcengine.html#joinchannel" class="tsd-kind-icon">join<wbr>Channel</a>
  3807. </li>
  3808. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3809. <a href="rtcengine.html#leavechannel" class="tsd-kind-icon">leave<wbr>Channel</a>
  3810. </li>
  3811. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3812. <a href="rtcengine.html#methodisspeakerphoneenabled" class="tsd-kind-icon">methodis<wbr>Speakerphone<wbr>Enabled</a>
  3813. </li>
  3814. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3815. <a href="rtcengine.html#muteallremoteaudiostreams" class="tsd-kind-icon">mute<wbr>All<wbr>Remote<wbr>Audio<wbr>Streams</a>
  3816. </li>
  3817. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3818. <a href="rtcengine.html#muteallremotevideostreams" class="tsd-kind-icon">mute<wbr>All<wbr>Remote<wbr>Video<wbr>Streams</a>
  3819. </li>
  3820. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3821. <a href="rtcengine.html#mutelocalaudiostream" class="tsd-kind-icon">mute<wbr>Local<wbr>Audio<wbr>Stream</a>
  3822. </li>
  3823. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3824. <a href="rtcengine.html#mutelocalvideostream" class="tsd-kind-icon">mute<wbr>Local<wbr>Video<wbr>Stream</a>
  3825. </li>
  3826. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3827. <a href="rtcengine.html#muteremoteaudiostream" class="tsd-kind-icon">mute<wbr>Remote<wbr>Audio<wbr>Stream</a>
  3828. </li>
  3829. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3830. <a href="rtcengine.html#muteremotevideostream" class="tsd-kind-icon">mute<wbr>Remote<wbr>Video<wbr>Stream</a>
  3831. </li>
  3832. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3833. <a href="rtcengine.html#off" class="tsd-kind-icon">off</a>
  3834. </li>
  3835. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3836. <a href="rtcengine.html#on" class="tsd-kind-icon">on</a>
  3837. </li>
  3838. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3839. <a href="rtcengine.html#pausealleffects" class="tsd-kind-icon">pause<wbr>All<wbr>Effects</a>
  3840. </li>
  3841. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3842. <a href="rtcengine.html#pauseaudiomixing" class="tsd-kind-icon">pause<wbr>Audio<wbr>Mixing</a>
  3843. </li>
  3844. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3845. <a href="rtcengine.html#pauseeffect" class="tsd-kind-icon">pause<wbr>Effect</a>
  3846. </li>
  3847. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3848. <a href="rtcengine.html#playeffect" class="tsd-kind-icon">play<wbr>Effect</a>
  3849. </li>
  3850. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3851. <a href="rtcengine.html#preloadeffect" class="tsd-kind-icon">preload<wbr>Effect</a>
  3852. </li>
  3853. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3854. <a href="rtcengine.html#removclearvideowatermarkse" class="tsd-kind-icon">removclear<wbr>Video<wbr>Watermarkse</a>
  3855. </li>
  3856. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3857. <a href="rtcengine.html#removealllisteners" class="tsd-kind-icon">remove<wbr>All<wbr>Listeners</a>
  3858. </li>
  3859. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3860. <a href="rtcengine.html#removeinjectstreamurl" class="tsd-kind-icon">remove<wbr>Inject<wbr>Stream<wbr>Url</a>
  3861. </li>
  3862. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3863. <a href="rtcengine.html#removepublishstreamurl" class="tsd-kind-icon">remove<wbr>Publish<wbr>Stream<wbr>Url</a>
  3864. </li>
  3865. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3866. <a href="rtcengine.html#renewtoken" class="tsd-kind-icon">renew<wbr>Token</a>
  3867. </li>
  3868. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3869. <a href="rtcengine.html#resumealleffects" class="tsd-kind-icon">resume<wbr>All<wbr>Effects</a>
  3870. </li>
  3871. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3872. <a href="rtcengine.html#resumeaudiomixing" class="tsd-kind-icon">resume<wbr>Audio<wbr>Mixing</a>
  3873. </li>
  3874. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3875. <a href="rtcengine.html#resumeeffect" class="tsd-kind-icon">resume<wbr>Effect</a>
  3876. </li>
  3877. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3878. <a href="rtcengine.html#sendmessage" class="tsd-kind-icon">send<wbr>Message</a>
  3879. </li>
  3880. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3881. <a href="rtcengine.html#setaudiomixingposition" class="tsd-kind-icon">set<wbr>Audio<wbr>Mixing<wbr>Position</a>
  3882. </li>
  3883. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3884. <a href="rtcengine.html#setaudiosessionoperationrestriction" class="tsd-kind-icon">set<wbr>Audio<wbr>Session<wbr>Operation<wbr>Restriction</a>
  3885. </li>
  3886. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3887. <a href="rtcengine.html#setbeautyeffectoptions" class="tsd-kind-icon">set<wbr>Beauty<wbr>Effect<wbr>Options</a>
  3888. </li>
  3889. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3890. <a href="rtcengine.html#setcameraautofocusfacemodeenabled" class="tsd-kind-icon">set<wbr>Camera<wbr>Auto<wbr>Focus<wbr>Face<wbr>Mode<wbr>Enabled</a>
  3891. </li>
  3892. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3893. <a href="rtcengine.html#setcameracapturerconfiguration" class="tsd-kind-icon">set<wbr>Camera<wbr>Capturer<wbr>Configuration</a>
  3894. </li>
  3895. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3896. <a href="rtcengine.html#setcameraexposureposition" class="tsd-kind-icon">set<wbr>Camera<wbr>Exposure<wbr>Position</a>
  3897. </li>
  3898. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3899. <a href="rtcengine.html#setcamerafocuspositioninpreview" class="tsd-kind-icon">set<wbr>Camera<wbr>Focus<wbr>Position<wbr>InPreview</a>
  3900. </li>
  3901. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3902. <a href="rtcengine.html#setcameratorchon" class="tsd-kind-icon">set<wbr>Camera<wbr>Torch<wbr>On</a>
  3903. </li>
  3904. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3905. <a href="rtcengine.html#setcamerazoomfactor" class="tsd-kind-icon">set<wbr>Camera<wbr>Zoom<wbr>Factor</a>
  3906. </li>
  3907. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3908. <a href="rtcengine.html#setclientrole" class="tsd-kind-icon">set<wbr>Client<wbr>Role</a>
  3909. </li>
  3910. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3911. <a href="rtcengine.html#setdefaultaudioroutetospeakerphone" class="tsd-kind-icon">set<wbr>Default<wbr>Audio<wbr>Route<wbr>ToSpeakerphone</a>
  3912. </li>
  3913. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3914. <a href="rtcengine.html#setdefaultmuteallremoteaudiostreams" class="tsd-kind-icon">set<wbr>Default<wbr>Mute<wbr>All<wbr>Remote<wbr>Audio<wbr>Streams</a>
  3915. </li>
  3916. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3917. <a href="rtcengine.html#setdefaultmuteallremotevideostreams" class="tsd-kind-icon">set<wbr>Default<wbr>Mute<wbr>All<wbr>Remote<wbr>Video<wbr>Streams</a>
  3918. </li>
  3919. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3920. <a href="rtcengine.html#seteffectsvolume" class="tsd-kind-icon">set<wbr>Effects<wbr>Volume</a>
  3921. </li>
  3922. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3923. <a href="rtcengine.html#setenablespeakerphone" class="tsd-kind-icon">set<wbr>Enable<wbr>Speakerphone</a>
  3924. </li>
  3925. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3926. <a href="rtcengine.html#setinearmonitoringvolume" class="tsd-kind-icon">set<wbr>InEar<wbr>Monitoring<wbr>Volume</a>
  3927. </li>
  3928. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3929. <a href="rtcengine.html#setlivetranscoding" class="tsd-kind-icon">set<wbr>Live<wbr>Transcoding</a>
  3930. </li>
  3931. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3932. <a href="rtcengine.html#setlocalpublishfallbackoption" class="tsd-kind-icon">set<wbr>Local<wbr>Publish<wbr>Fallback<wbr>Option</a>
  3933. </li>
  3934. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3935. <a href="rtcengine.html#setlocalrendermode" class="tsd-kind-icon">set<wbr>Local<wbr>Render<wbr>Mode</a>
  3936. </li>
  3937. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3938. <a href="rtcengine.html#setlocalvideomirrormode" class="tsd-kind-icon">set<wbr>Local<wbr>Video<wbr>Mirror<wbr>Mode</a>
  3939. </li>
  3940. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3941. <a href="rtcengine.html#setlocalvoicechanger" class="tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Changer</a>
  3942. </li>
  3943. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3944. <a href="rtcengine.html#setlocalvoiceequalization" class="tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Equalization</a>
  3945. </li>
  3946. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3947. <a href="rtcengine.html#setlocalvoicepitch" class="tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Pitch</a>
  3948. </li>
  3949. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3950. <a href="rtcengine.html#setlocalvoicereverb" class="tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Reverb</a>
  3951. </li>
  3952. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3953. <a href="rtcengine.html#setlocalvoicereverbpreset" class="tsd-kind-icon">set<wbr>Local<wbr>Voice<wbr>Reverb<wbr>Preset</a>
  3954. </li>
  3955. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3956. <a href="rtcengine.html#setlog" class="tsd-kind-icon">set<wbr>Log</a>
  3957. </li>
  3958. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3959. <a href="rtcengine.html#setmixedaudioframeparameters" class="tsd-kind-icon">set<wbr>Mixed<wbr>Audio<wbr>Frame<wbr>Parameters</a>
  3960. </li>
  3961. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3962. <a href="rtcengine.html#setplaybackaudioframeparameters" class="tsd-kind-icon">set<wbr>Playback<wbr>Audio<wbr>Frame<wbr>Parameters</a>
  3963. </li>
  3964. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3965. <a href="rtcengine.html#setrecordingaudioframeparameters" class="tsd-kind-icon">set<wbr>Recording<wbr>Audio<wbr>Frame<wbr>Parameters</a>
  3966. </li>
  3967. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3968. <a href="rtcengine.html#setremotedefaultvideostreamtype" class="tsd-kind-icon">set<wbr>Remote<wbr>Default<wbr>Video<wbr>Stream<wbr>Type</a>
  3969. </li>
  3970. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3971. <a href="rtcengine.html#setremoterendermode" class="tsd-kind-icon">set<wbr>Remote<wbr>Render<wbr>Mode</a>
  3972. </li>
  3973. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3974. <a href="rtcengine.html#setremotesubscribefallbackoption" class="tsd-kind-icon">set<wbr>Remote<wbr>Subscribe<wbr>Fallback<wbr>Option</a>
  3975. </li>
  3976. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3977. <a href="rtcengine.html#setremoteuserpriority" class="tsd-kind-icon">set<wbr>Remote<wbr>User<wbr>Priority</a>
  3978. </li>
  3979. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3980. <a href="rtcengine.html#setremotevideostreamtype" class="tsd-kind-icon">set<wbr>Remote<wbr>Video<wbr>Stream<wbr>Type</a>
  3981. </li>
  3982. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3983. <a href="rtcengine.html#setremotevoiceposition" class="tsd-kind-icon">set<wbr>Remote<wbr>Voice<wbr>Position</a>
  3984. </li>
  3985. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3986. <a href="rtcengine.html#setvolumeofeffect" class="tsd-kind-icon">set<wbr>Volume<wbr>OfEffect</a>
  3987. </li>
  3988. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3989. <a href="rtcengine.html#setuplocalvideo" class="tsd-kind-icon">setup<wbr>Local<wbr>Video</a>
  3990. </li>
  3991. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3992. <a href="rtcengine.html#setupremotevideo" class="tsd-kind-icon">setup<wbr>Remote<wbr>Video</a>
  3993. </li>
  3994. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3995. <a href="rtcengine.html#startaudiomixing" class="tsd-kind-icon">start<wbr>Audio<wbr>Mixing</a>
  3996. </li>
  3997. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  3998. <a href="rtcengine.html#startaudiorecording" class="tsd-kind-icon">start<wbr>Audio<wbr>Recording</a>
  3999. </li>
  4000. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  4001. <a href="rtcengine.html#startechotestwithinterval" class="tsd-kind-icon">start<wbr>Echo<wbr>Test<wbr>With<wbr>Interval</a>
  4002. </li>
  4003. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  4004. <a href="rtcengine.html#startpreview" class="tsd-kind-icon">start<wbr>Preview</a>
  4005. </li>
  4006. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  4007. <a href="rtcengine.html#stopalleffects" class="tsd-kind-icon">stop<wbr>All<wbr>Effects</a>
  4008. </li>
  4009. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  4010. <a href="rtcengine.html#stopaudiomixing" class="tsd-kind-icon">stop<wbr>Audio<wbr>Mixing</a>
  4011. </li>
  4012. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  4013. <a href="rtcengine.html#stopaudiorecording" class="tsd-kind-icon">stop<wbr>Audio<wbr>Recording</a>
  4014. </li>
  4015. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  4016. <a href="rtcengine.html#stopechotest" class="tsd-kind-icon">stop<wbr>Echo<wbr>Test</a>
  4017. </li>
  4018. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  4019. <a href="rtcengine.html#stopeffect" class="tsd-kind-icon">stop<wbr>Effect</a>
  4020. </li>
  4021. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  4022. <a href="rtcengine.html#stoplastmileprobetest" class="tsd-kind-icon">stop<wbr>Lastmile<wbr>Probe<wbr>Test</a>
  4023. </li>
  4024. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  4025. <a href="rtcengine.html#stoppreview" class="tsd-kind-icon">stop<wbr>Preview</a>
  4026. </li>
  4027. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  4028. <a href="rtcengine.html#switchcamera" class="tsd-kind-icon">switch<wbr>Camera</a>
  4029. </li>
  4030. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
  4031. <a href="rtcengine.html#unloadeffect" class="tsd-kind-icon">unload<wbr>Effect</a>
  4032. </li>
  4033. </ul>
  4034. </li>
  4035. </ul>
  4036. <ul class="after-current">
  4037. <li class=" tsd-kind-variable tsd-is-not-exported">
  4038. <a href="../globals.html#agora" class="tsd-kind-icon">Agora</a>
  4039. </li>
  4040. <li class=" tsd-kind-variable tsd-is-not-exported">
  4041. <a href="../globals.html#agoraeventemitter" class="tsd-kind-icon">Agora<wbr>Event<wbr>Emitter</a>
  4042. </li>
  4043. <li class=" tsd-kind-variable tsd-is-not-exported">
  4044. <a href="../globals.html#rctagoraview" class="tsd-kind-icon">RCTAgora<wbr>View</a>
  4045. </li>
  4046. </ul>
  4047. </nav>
  4048. </div>
  4049. </div>
  4050. </div>
  4051. <footer class="with-border-bottom">
  4052. <div class="container">
  4053. <h2>Legend</h2>
  4054. <div class="tsd-legend-group">
  4055. <ul class="tsd-legend">
  4056. <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
  4057. <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
  4058. <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
  4059. <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
  4060. <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
  4061. <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
  4062. <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
  4063. </ul>
  4064. <ul class="tsd-legend">
  4065. <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
  4066. <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
  4067. <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
  4068. <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
  4069. </ul>
  4070. <ul class="tsd-legend">
  4071. <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
  4072. <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
  4073. <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
  4074. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  4075. <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
  4076. <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
  4077. </ul>
  4078. <ul class="tsd-legend">
  4079. <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
  4080. <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
  4081. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  4082. <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
  4083. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  4084. <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
  4085. <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
  4086. </ul>
  4087. <ul class="tsd-legend">
  4088. <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
  4089. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  4090. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  4091. <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
  4092. </ul>
  4093. <ul class="tsd-legend">
  4094. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
  4095. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
  4096. <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
  4097. </ul>
  4098. <ul class="tsd-legend">
  4099. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
  4100. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
  4101. <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
  4102. </ul>
  4103. <ul class="tsd-legend">
  4104. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
  4105. <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
  4106. </ul>
  4107. </div>
  4108. </div>
  4109. </footer>
  4110. <div class="container tsd-generator">
  4111. <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
  4112. </div>
  4113. <div class="overlay"></div>
  4114. <script src="../assets/js/main.js"></script>
  4115. <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
  4116. </body>
  4117. </html>