Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.

JitsiConference.js 141KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226
  1. import { getLogger } from '@jitsi/logger';
  2. import EventEmitter from 'events';
  3. import $ from 'jquery';
  4. import isEqual from 'lodash.isequal';
  5. import { Strophe } from 'strophe.js';
  6. import * as JitsiConferenceErrors from './JitsiConferenceErrors';
  7. import JitsiConferenceEventManager from './JitsiConferenceEventManager';
  8. import * as JitsiConferenceEvents from './JitsiConferenceEvents';
  9. import JitsiParticipant from './JitsiParticipant';
  10. import JitsiTrackError from './JitsiTrackError';
  11. import * as JitsiTrackErrors from './JitsiTrackErrors';
  12. import * as JitsiTrackEvents from './JitsiTrackEvents';
  13. import authenticateAndUpgradeRole from './authenticateAndUpgradeRole';
  14. import { CodecSelection } from './modules/RTC/CodecSelection';
  15. import RTC from './modules/RTC/RTC';
  16. import { SS_DEFAULT_FRAME_RATE } from './modules/RTC/ScreenObtainer';
  17. import browser from './modules/browser';
  18. import ConnectionQuality from './modules/connectivity/ConnectionQuality';
  19. import IceFailedHandling
  20. from './modules/connectivity/IceFailedHandling';
  21. import ParticipantConnectionStatusHandler
  22. from './modules/connectivity/ParticipantConnectionStatus';
  23. import * as DetectionEvents from './modules/detection/DetectionEvents';
  24. import NoAudioSignalDetection from './modules/detection/NoAudioSignalDetection';
  25. import P2PDominantSpeakerDetection from './modules/detection/P2PDominantSpeakerDetection';
  26. import VADAudioAnalyser from './modules/detection/VADAudioAnalyser';
  27. import VADNoiseDetection from './modules/detection/VADNoiseDetection';
  28. import VADTalkMutedDetection from './modules/detection/VADTalkMutedDetection';
  29. import { E2EEncryption } from './modules/e2ee/E2EEncryption';
  30. import E2ePing from './modules/e2eping/e2eping';
  31. import Jvb121EventGenerator from './modules/event/Jvb121EventGenerator';
  32. import FeatureFlags from './modules/flags/FeatureFlags';
  33. import ReceiveVideoController from './modules/qualitycontrol/ReceiveVideoController';
  34. import SendVideoController from './modules/qualitycontrol/SendVideoController';
  35. import RecordingManager from './modules/recording/RecordingManager';
  36. import Settings from './modules/settings/Settings';
  37. import AudioOutputProblemDetector from './modules/statistics/AudioOutputProblemDetector';
  38. import AvgRTPStatsReporter from './modules/statistics/AvgRTPStatsReporter';
  39. import SpeakerStatsCollector from './modules/statistics/SpeakerStatsCollector';
  40. import Statistics from './modules/statistics/statistics';
  41. import Transcriber from './modules/transcription/transcriber';
  42. import GlobalOnErrorHandler from './modules/util/GlobalOnErrorHandler';
  43. import RandomUtil from './modules/util/RandomUtil';
  44. import ComponentsVersions from './modules/version/ComponentsVersions';
  45. import VideoSIPGW from './modules/videosipgw/VideoSIPGW';
  46. import * as VideoSIPGWConstants from './modules/videosipgw/VideoSIPGWConstants';
  47. import SignalingLayerImpl from './modules/xmpp/SignalingLayerImpl';
  48. import {
  49. FEATURE_E2EE,
  50. FEATURE_JIGASI,
  51. JITSI_MEET_MUC_TYPE
  52. } from './modules/xmpp/xmpp';
  53. import BridgeVideoType from './service/RTC/BridgeVideoType';
  54. import CodecMimeType from './service/RTC/CodecMimeType';
  55. import { MediaType } from './service/RTC/MediaType';
  56. import RTCEvents from './service/RTC/RTCEvents';
  57. import { getSourceNameForJitsiTrack } from './service/RTC/SignalingLayer';
  58. import { VideoType } from './service/RTC/VideoType';
  59. import {
  60. ACTION_JINGLE_RESTART,
  61. ACTION_JINGLE_SI_RECEIVED,
  62. ACTION_JINGLE_SI_TIMEOUT,
  63. ACTION_JINGLE_TERMINATE,
  64. ACTION_P2P_DECLINED,
  65. ACTION_P2P_ESTABLISHED,
  66. ACTION_P2P_FAILED,
  67. ACTION_P2P_SWITCH_TO_JVB,
  68. ICE_ESTABLISHMENT_DURATION_DIFF,
  69. createConferenceEvent,
  70. createJingleEvent,
  71. createP2PEvent
  72. } from './service/statistics/AnalyticsEvents';
  73. import { XMPPEvents } from './service/xmpp/XMPPEvents';
  74. const logger = getLogger(__filename);
  75. /**
  76. * How long since Jicofo is supposed to send a session-initiate, before
  77. * {@link ACTION_JINGLE_SI_TIMEOUT} analytics event is sent (in ms).
  78. * @type {number}
  79. */
  80. const JINGLE_SI_TIMEOUT = 5000;
  81. /**
  82. * Creates a JitsiConference object with the given name and properties.
  83. * Note: this constructor is not a part of the public API (objects should be
  84. * created using JitsiConnection.createConference).
  85. * @param options.config properties / settings related to the conference that
  86. * will be created.
  87. * @param options.name the name of the conference
  88. * @param options.connection the JitsiConnection object for this
  89. * JitsiConference.
  90. * @param {number} [options.config.avgRtpStatsN=15] how many samples are to be
  91. * collected by {@link AvgRTPStatsReporter}, before arithmetic mean is
  92. * calculated and submitted to the analytics module.
  93. * @param {boolean} [options.config.enableIceRestart=false] - enables the ICE
  94. * restart logic.
  95. * @param {boolean} [options.config.p2p.enabled] when set to <tt>true</tt>
  96. * the peer to peer mode will be enabled. It means that when there are only 2
  97. * participants in the conference an attempt to make direct connection will be
  98. * made. If the connection succeeds the conference will stop sending data
  99. * through the JVB connection and will use the direct one instead.
  100. * @param {number} [options.config.p2p.backToP2PDelay=5] a delay given in
  101. * seconds, before the conference switches back to P2P, after the 3rd
  102. * participant has left the room.
  103. * @param {number} [options.config.channelLastN=-1] The requested amount of
  104. * videos are going to be delivered after the value is in effect. Set to -1 for
  105. * unlimited or all available videos.
  106. * @param {number} [options.config.forceJVB121Ratio]
  107. * "Math.random() < forceJVB121Ratio" will determine whether a 2 people
  108. * conference should be moved to the JVB instead of P2P. The decision is made on
  109. * the responder side, after ICE succeeds on the P2P connection.
  110. * @constructor
  111. *
  112. * FIXME Make all methods which are called from lib-internal classes
  113. * to non-public (use _). To name a few:
  114. * {@link JitsiConference.onLocalRoleChanged}
  115. * {@link JitsiConference.onUserRoleChanged}
  116. * {@link JitsiConference.onMemberLeft}
  117. * and so on...
  118. */
  119. export default function JitsiConference(options) {
  120. if (!options.name || options.name.toLowerCase() !== options.name.toString()) {
  121. const errmsg
  122. = 'Invalid conference name (no conference name passed or it '
  123. + 'contains invalid characters like capital letters)!';
  124. logger.error(errmsg);
  125. throw new Error(errmsg);
  126. }
  127. this.connection = options.connection;
  128. this.xmpp = this.connection?.xmpp;
  129. if (this.xmpp.isRoomCreated(options.name, options.customDomain)) {
  130. const errmsg = 'A conference with the same name has already been created!';
  131. delete this.connection;
  132. delete this.xmpp;
  133. logger.error(errmsg);
  134. throw new Error(errmsg);
  135. }
  136. this.eventEmitter = new EventEmitter();
  137. this.options = options;
  138. this.eventManager = new JitsiConferenceEventManager(this);
  139. this.participants = {};
  140. /**
  141. * The signaling layer instance.
  142. * @type {SignalingLayerImpl}
  143. * @private
  144. */
  145. this._signalingLayer = new SignalingLayerImpl();
  146. this._init(options);
  147. this.componentsVersions = new ComponentsVersions(this);
  148. /**
  149. * Jingle session instance for the JVB connection.
  150. * @type {JingleSessionPC}
  151. */
  152. this.jvbJingleSession = null;
  153. this.lastDominantSpeaker = null;
  154. this.dtmfManager = null;
  155. this.somebodySupportsDTMF = false;
  156. this.authEnabled = false;
  157. this.startAudioMuted = false;
  158. this.startVideoMuted = false;
  159. this.startMutedPolicy = {
  160. audio: false,
  161. video: false
  162. };
  163. this.isMutedByFocus = false;
  164. // when muted by focus we receive the jid of the initiator of the mute
  165. this.mutedByFocusActor = null;
  166. this.isVideoMutedByFocus = false;
  167. // when video muted by focus we receive the jid of the initiator of the mute
  168. this.mutedVideoByFocusActor = null;
  169. // Flag indicates if the 'onCallEnded' method was ever called on this
  170. // instance. Used to log extra analytics event for debugging purpose.
  171. // We need to know if the potential issue happened before or after
  172. // the restart.
  173. this.wasStopped = false;
  174. // Conference properties, maintained by jicofo.
  175. this.properties = {};
  176. /**
  177. * The object which monitors local and remote connection statistics (e.g.
  178. * sending bitrate) and calculates a number which represents the connection
  179. * quality.
  180. */
  181. this.connectionQuality
  182. = new ConnectionQuality(this, this.eventEmitter, options);
  183. /**
  184. * Reports average RTP statistics to the analytics module.
  185. * @type {AvgRTPStatsReporter}
  186. */
  187. this.avgRtpStatsReporter
  188. = new AvgRTPStatsReporter(this, options.config.avgRtpStatsN || 15);
  189. /**
  190. * Detects issues with the audio of remote participants.
  191. * @type {AudioOutputProblemDetector}
  192. */
  193. if (!options.config.disableAudioLevels) {
  194. this._audioOutputProblemDetector = new AudioOutputProblemDetector(this);
  195. }
  196. /**
  197. * Indicates whether the connection is interrupted or not.
  198. */
  199. this.isJvbConnectionInterrupted = false;
  200. /**
  201. * The object which tracks active speaker times
  202. */
  203. this.speakerStatsCollector = new SpeakerStatsCollector(this);
  204. /* P2P related fields below: */
  205. /**
  206. * Stores reference to deferred start P2P task. It's created when 3rd
  207. * participant leaves the room in order to avoid ping pong effect (it
  208. * could be just a page reload).
  209. * @type {number|null}
  210. */
  211. this.deferredStartP2PTask = null;
  212. const delay
  213. = parseInt(options.config.p2p && options.config.p2p.backToP2PDelay, 10);
  214. /**
  215. * A delay given in seconds, before the conference switches back to P2P
  216. * after the 3rd participant has left.
  217. * @type {number}
  218. */
  219. this.backToP2PDelay = isNaN(delay) ? 5 : delay;
  220. logger.info(`backToP2PDelay: ${this.backToP2PDelay}`);
  221. /**
  222. * If set to <tt>true</tt> it means the P2P ICE is no longer connected.
  223. * When <tt>false</tt> it means that P2P ICE (media) connection is up
  224. * and running.
  225. * @type {boolean}
  226. */
  227. this.isP2PConnectionInterrupted = false;
  228. /**
  229. * Flag set to <tt>true</tt> when P2P session has been established
  230. * (ICE has been connected) and this conference is currently in the peer to
  231. * peer mode (P2P connection is the active one).
  232. * @type {boolean}
  233. */
  234. this.p2p = false;
  235. /**
  236. * A JingleSession for the direct peer to peer connection.
  237. * @type {JingleSessionPC}
  238. */
  239. this.p2pJingleSession = null;
  240. this.videoSIPGWHandler = new VideoSIPGW(this.room);
  241. this.recordingManager = new RecordingManager(this.room);
  242. /**
  243. * If the conference.joined event has been sent this will store the timestamp when it happened.
  244. *
  245. * @type {undefined|number}
  246. * @private
  247. */
  248. this._conferenceJoinAnalyticsEventSent = undefined;
  249. /**
  250. * End-to-End Encryption. Make it available if supported.
  251. */
  252. if (this.isE2EESupported()) {
  253. logger.info('End-to-End Encryption is supported');
  254. this._e2eEncryption = new E2EEncryption(this);
  255. }
  256. /**
  257. * Flag set to <tt>true</tt> when Jicofo sends a presence message indicating that the max audio sender limit has
  258. * been reached for the call. Once this is set, unmuting audio will be disabled from the client until it gets reset
  259. * again by Jicofo.
  260. */
  261. this._audioSenderLimitReached = undefined;
  262. /**
  263. * Flag set to <tt>true</tt> when Jicofo sends a presence message indicating that the max video sender limit has
  264. * been reached for the call. Once this is set, unmuting video will be disabled from the client until it gets reset
  265. * again by Jicofo.
  266. */
  267. this._videoSenderLimitReached = undefined;
  268. }
  269. // FIXME convert JitsiConference to ES6 - ASAP !
  270. JitsiConference.prototype.constructor = JitsiConference;
  271. /**
  272. * Create a resource for the a jid. We use the room nickname (the resource part
  273. * of the occupant JID, see XEP-0045) as the endpoint ID in colibri. We require
  274. * endpoint IDs to be 8 hex digits because in some cases they get serialized
  275. * into a 32bit field.
  276. *
  277. * @param {string} jid - The id set onto the XMPP connection.
  278. * @param {boolean} isAuthenticatedUser - Whether or not the user has connected
  279. * to the XMPP service with a password.
  280. * @returns {string}
  281. * @static
  282. */
  283. JitsiConference.resourceCreator = function(jid, isAuthenticatedUser) {
  284. let mucNickname;
  285. if (isAuthenticatedUser) {
  286. // For authenticated users generate a random ID.
  287. mucNickname = RandomUtil.randomHexString(8).toLowerCase();
  288. } else {
  289. // We try to use the first part of the node (which for anonymous users
  290. // on prosody is a UUID) to match the previous behavior (and maybe make
  291. // debugging easier).
  292. mucNickname = Strophe.getNodeFromJid(jid)?.substr(0, 8)
  293. .toLowerCase();
  294. // But if this doesn't have the required format we just generate a new
  295. // random nickname.
  296. const re = /[0-9a-f]{8}/g;
  297. if (!mucNickname || !re.test(mucNickname)) {
  298. mucNickname = RandomUtil.randomHexString(8).toLowerCase();
  299. }
  300. }
  301. return mucNickname;
  302. };
  303. /**
  304. * Initializes the conference object properties
  305. * @param options {object}
  306. * @param options.connection {JitsiConnection} overrides this.connection
  307. */
  308. JitsiConference.prototype._init = function(options = {}) {
  309. this.eventManager.setupXMPPListeners();
  310. const { config } = this.options;
  311. // Get the codec preference settings from config.js.
  312. // 'preferH264' and 'disableH264' settings have been deprecated for a while,
  313. // 'preferredCodec' and 'disabledCodec' will have precedence over them.
  314. const codecSettings = {
  315. disabledCodec: config.videoQuality
  316. ? config.videoQuality.disabledCodec
  317. : config.p2p && config.p2p.disableH264 && CodecMimeType.H264,
  318. enforcePreferredCodec: config.videoQuality && config.videoQuality.enforcePreferredCodec,
  319. jvbCodec: (config.videoQuality && config.videoQuality.preferredCodec)
  320. || (config.preferH264 && CodecMimeType.H264),
  321. p2pCodec: config.p2p
  322. ? config.p2p.preferredCodec || (config.p2p.preferH264 && CodecMimeType.H264)
  323. : CodecMimeType.VP8
  324. };
  325. this.codecSelection = new CodecSelection(this, codecSettings);
  326. this._statsCurrentId = config.statisticsId ? config.statisticsId : Settings.callStatsUserName;
  327. this.room = this.xmpp.createRoom(
  328. this.options.name, {
  329. ...config,
  330. statsId: this._statsCurrentId
  331. },
  332. JitsiConference.resourceCreator
  333. );
  334. this._signalingLayer.setChatRoom(this.room);
  335. // Connection interrupted/restored listeners
  336. this._onIceConnectionInterrupted
  337. = this._onIceConnectionInterrupted.bind(this);
  338. this.room.addListener(
  339. XMPPEvents.CONNECTION_INTERRUPTED, this._onIceConnectionInterrupted);
  340. this._onIceConnectionRestored = this._onIceConnectionRestored.bind(this);
  341. this.room.addListener(
  342. XMPPEvents.CONNECTION_RESTORED, this._onIceConnectionRestored);
  343. this._onIceConnectionEstablished
  344. = this._onIceConnectionEstablished.bind(this);
  345. this.room.addListener(
  346. XMPPEvents.CONNECTION_ESTABLISHED, this._onIceConnectionEstablished);
  347. this._updateProperties = this._updateProperties.bind(this);
  348. this.room.addListener(XMPPEvents.CONFERENCE_PROPERTIES_CHANGED,
  349. this._updateProperties);
  350. this._sendConferenceJoinAnalyticsEvent = this._sendConferenceJoinAnalyticsEvent.bind(this);
  351. this.room.addListener(XMPPEvents.MEETING_ID_SET, this._sendConferenceJoinAnalyticsEvent);
  352. this._removeLocalSourceOnReject = this._removeLocalSourceOnReject.bind(this);
  353. this._updateRoomPresence = this._updateRoomPresence.bind(this);
  354. this.room.addListener(XMPPEvents.SESSION_ACCEPT, this._updateRoomPresence);
  355. this.room.addListener(XMPPEvents.SOURCE_ADD, this._updateRoomPresence);
  356. this.room.addListener(XMPPEvents.SOURCE_ADD_ERROR, this._removeLocalSourceOnReject);
  357. this.room.addListener(XMPPEvents.SOURCE_REMOVE, this._updateRoomPresence);
  358. if (config.e2eping?.enabled) {
  359. this.e2eping = new E2ePing(
  360. this,
  361. config,
  362. (message, to) => {
  363. try {
  364. this.sendMessage(message, to, true /* sendThroughVideobridge */);
  365. } catch (error) {
  366. logger.warn('Failed to send E2E ping request or response.', error && error.msg);
  367. }
  368. });
  369. }
  370. if (!this.rtc) {
  371. this.rtc = new RTC(this, options);
  372. this.eventManager.setupRTCListeners();
  373. if (FeatureFlags.isSourceNameSignalingEnabled()) {
  374. this._registerRtcListeners(this.rtc);
  375. }
  376. }
  377. this.receiveVideoController = new ReceiveVideoController(this, this.rtc);
  378. this.sendVideoController = new SendVideoController(this, this.rtc);
  379. // Do not initialize ParticipantConnectionStatusHandler when source-name signaling is enabled.
  380. if (!FeatureFlags.isSourceNameSignalingEnabled()) {
  381. this.participantConnectionStatus
  382. = new ParticipantConnectionStatusHandler(
  383. this.rtc,
  384. this,
  385. {
  386. // These options are not public API, leaving it here only as an entry point through config for tuning
  387. // up purposes. Default values should be adjusted as soon as optimal values are discovered.
  388. p2pRtcMuteTimeout: config._p2pConnStatusRtcMuteTimeout,
  389. rtcMuteTimeout: config._peerConnStatusRtcMuteTimeout,
  390. outOfLastNTimeout: config._peerConnStatusOutOfLastNTimeout
  391. });
  392. this.participantConnectionStatus.init();
  393. }
  394. // Add the ability to enable callStats only on a percentage of users based on config.js settings.
  395. let enableCallStats = true;
  396. if (config.testing && config.testing.callStatsThreshold) {
  397. enableCallStats = (Math.random() * 100) <= config.testing.callStatsThreshold;
  398. }
  399. if (!this.statistics) {
  400. this.statistics = new Statistics(this.xmpp, {
  401. aliasName: this._statsCurrentId,
  402. userName: config.statisticsDisplayName ? config.statisticsDisplayName : this.myUserId(),
  403. confID: config.confID || `${this.connection.options.hosts.domain}/${this.options.name}`,
  404. siteID: config.siteID,
  405. customScriptUrl: config.callStatsCustomScriptUrl,
  406. callStatsID: config.callStatsID,
  407. callStatsSecret: config.callStatsSecret,
  408. callStatsApplicationLogsDisabled: config.callStatsApplicationLogsDisabled,
  409. enableCallStats,
  410. roomName: this.options.name,
  411. applicationName: config.applicationName,
  412. getWiFiStatsMethod: config.getWiFiStatsMethod,
  413. configParams: config.callStatsConfigParams
  414. });
  415. Statistics.analytics.addPermanentProperties({
  416. 'callstats_name': this._statsCurrentId
  417. });
  418. // Start performance observer for monitoring long tasks
  419. if (config.longTasksStatsInterval) {
  420. this.statistics.attachLongTasksStats(this);
  421. }
  422. }
  423. this.eventManager.setupChatRoomListeners();
  424. // Always add listeners because on reload we are executing leave and the
  425. // listeners are removed from statistics module.
  426. this.eventManager.setupStatisticsListeners();
  427. // Disable VAD processing on Safari since it causes audio input to
  428. // fail on some of the mobile devices.
  429. if (config.enableTalkWhileMuted && browser.supportsVADDetection()) {
  430. // If VAD processor factory method is provided uses VAD based detection, otherwise fallback to audio level
  431. // based detection.
  432. if (config.createVADProcessor) {
  433. logger.info('Using VAD detection for generating talk while muted events');
  434. if (!this._audioAnalyser) {
  435. this._audioAnalyser = new VADAudioAnalyser(this, config.createVADProcessor);
  436. }
  437. const vadTalkMutedDetection = new VADTalkMutedDetection();
  438. vadTalkMutedDetection.on(DetectionEvents.VAD_TALK_WHILE_MUTED, () =>
  439. this.eventEmitter.emit(JitsiConferenceEvents.TALK_WHILE_MUTED));
  440. this._audioAnalyser.addVADDetectionService(vadTalkMutedDetection);
  441. } else {
  442. logger.warn('No VAD Processor was provided. Talk while muted detection service was not initialized!');
  443. }
  444. }
  445. // Disable noisy mic detection on safari since it causes the audio input to
  446. // fail on Safari on iPadOS.
  447. if (config.enableNoisyMicDetection && browser.supportsVADDetection()) {
  448. if (config.createVADProcessor) {
  449. if (!this._audioAnalyser) {
  450. this._audioAnalyser = new VADAudioAnalyser(this, config.createVADProcessor);
  451. }
  452. const vadNoiseDetection = new VADNoiseDetection();
  453. vadNoiseDetection.on(DetectionEvents.VAD_NOISY_DEVICE, () =>
  454. this.eventEmitter.emit(JitsiConferenceEvents.NOISY_MIC));
  455. this._audioAnalyser.addVADDetectionService(vadNoiseDetection);
  456. } else {
  457. logger.warn('No VAD Processor was provided. Noisy microphone detection service was not initialized!');
  458. }
  459. }
  460. // Generates events based on no audio input detector.
  461. if (config.enableNoAudioDetection) {
  462. this._noAudioSignalDetection = new NoAudioSignalDetection(this);
  463. this._noAudioSignalDetection.on(DetectionEvents.NO_AUDIO_INPUT, () => {
  464. this.eventEmitter.emit(JitsiConferenceEvents.NO_AUDIO_INPUT);
  465. });
  466. this._noAudioSignalDetection.on(DetectionEvents.AUDIO_INPUT_STATE_CHANGE, hasAudioSignal => {
  467. this.eventEmitter.emit(JitsiConferenceEvents.AUDIO_INPUT_STATE_CHANGE, hasAudioSignal);
  468. });
  469. }
  470. if ('channelLastN' in config) {
  471. this.setLastN(config.channelLastN);
  472. }
  473. /**
  474. * Emits {@link JitsiConferenceEvents.JVB121_STATUS}.
  475. * @type {Jvb121EventGenerator}
  476. */
  477. this.jvb121Status = new Jvb121EventGenerator(this);
  478. // creates dominant speaker detection that works only in p2p mode
  479. this.p2pDominantSpeakerDetection = new P2PDominantSpeakerDetection(this);
  480. if (config && config.deploymentInfo && config.deploymentInfo.userRegion) {
  481. this.setLocalParticipantProperty(
  482. 'region', config.deploymentInfo.userRegion);
  483. }
  484. // Publish the codec type to presence.
  485. this.setLocalParticipantProperty('codecType', this.codecSelection.getPreferredCodec());
  486. // Set transcription language presence extension.
  487. // In case the language config is undefined or has the default value that the transcriber uses
  488. // (in our case Jigasi uses 'en-US'), don't set the participant property in order to avoid
  489. // needlessly polluting the presence stanza.
  490. if (config && config.transcriptionLanguage && config.transcriptionLanguage !== 'en-US') {
  491. this.setLocalParticipantProperty('transcription_language', config.transcriptionLanguage);
  492. }
  493. };
  494. /**
  495. * Joins the conference.
  496. * @param password {string} the password
  497. * @param replaceParticipant {boolean} whether the current join replaces
  498. * an existing participant with same jwt from the meeting.
  499. */
  500. JitsiConference.prototype.join = function(password, replaceParticipant = false) {
  501. if (this.room) {
  502. this.room.join(password, replaceParticipant).then(() => this._maybeSetSITimeout());
  503. }
  504. };
  505. /**
  506. * Authenticates and upgrades the role of the local participant/user.
  507. *
  508. * @returns {Object} A <tt>thenable</tt> which (1) settles when the process of
  509. * authenticating and upgrading the role of the local participant/user finishes
  510. * and (2) has a <tt>cancel</tt> method that allows the caller to interrupt the
  511. * process.
  512. */
  513. JitsiConference.prototype.authenticateAndUpgradeRole = function(options) {
  514. return authenticateAndUpgradeRole.call(this, {
  515. ...options,
  516. onCreateResource: JitsiConference.resourceCreator
  517. });
  518. };
  519. /**
  520. * Check if joined to the conference.
  521. */
  522. JitsiConference.prototype.isJoined = function() {
  523. return this.room && this.room.joined;
  524. };
  525. /**
  526. * Tells whether or not the P2P mode is enabled in the configuration.
  527. * @return {boolean}
  528. */
  529. JitsiConference.prototype.isP2PEnabled = function() {
  530. return Boolean(this.options.config.p2p && this.options.config.p2p.enabled)
  531. // FIXME: remove once we have a default config template. -saghul
  532. || typeof this.options.config.p2p === 'undefined';
  533. };
  534. /**
  535. * When in P2P test mode, the conference will not automatically switch to P2P
  536. * when there 2 participants.
  537. * @return {boolean}
  538. */
  539. JitsiConference.prototype.isP2PTestModeEnabled = function() {
  540. return Boolean(this.options.config.testing
  541. && this.options.config.testing.p2pTestMode);
  542. };
  543. /**
  544. * Leaves the conference.
  545. * @param reason {string|undefined} The reason for leaving the conference.
  546. * @returns {Promise}
  547. */
  548. JitsiConference.prototype.leave = async function(reason) {
  549. if (this.participantConnectionStatus) {
  550. this.participantConnectionStatus.dispose();
  551. this.participantConnectionStatus = null;
  552. }
  553. if (this.avgRtpStatsReporter) {
  554. this.avgRtpStatsReporter.dispose();
  555. this.avgRtpStatsReporter = null;
  556. }
  557. if (this._audioOutputProblemDetector) {
  558. this._audioOutputProblemDetector.dispose();
  559. this._audioOutputProblemDetector = null;
  560. }
  561. if (this.e2eping) {
  562. this.e2eping.stop();
  563. this.e2eping = null;
  564. }
  565. this.getLocalTracks().forEach(track => this.onLocalTrackRemoved(track));
  566. this.rtc.closeBridgeChannel();
  567. this._sendConferenceLeftAnalyticsEvent();
  568. if (this.statistics) {
  569. this.statistics.dispose();
  570. }
  571. this._delayedIceFailed && this._delayedIceFailed.cancel();
  572. this._maybeClearSITimeout();
  573. // Close both JVb and P2P JingleSessions
  574. if (this.jvbJingleSession) {
  575. this.jvbJingleSession.close();
  576. this.jvbJingleSession = null;
  577. }
  578. if (this.p2pJingleSession) {
  579. this.p2pJingleSession.close();
  580. this.p2pJingleSession = null;
  581. }
  582. // Leave the conference. If this.room == null we are calling second time leave().
  583. if (!this.room) {
  584. throw new Error('You have already left the conference');
  585. }
  586. const room = this.room;
  587. // Unregister connection state listeners
  588. room.removeListener(
  589. XMPPEvents.CONNECTION_INTERRUPTED,
  590. this._onIceConnectionInterrupted);
  591. room.removeListener(
  592. XMPPEvents.CONNECTION_RESTORED,
  593. this._onIceConnectionRestored);
  594. room.removeListener(
  595. XMPPEvents.CONNECTION_ESTABLISHED,
  596. this._onIceConnectionEstablished);
  597. room.removeListener(
  598. XMPPEvents.CONFERENCE_PROPERTIES_CHANGED,
  599. this._updateProperties);
  600. room.removeListener(XMPPEvents.MEETING_ID_SET, this._sendConferenceJoinAnalyticsEvent);
  601. room.removeListener(XMPPEvents.SESSION_ACCEPT, this._updateRoomPresence);
  602. room.removeListener(XMPPEvents.SOURCE_ADD, this._updateRoomPresence);
  603. room.removeListener(XMPPEvents.SOURCE_ADD_ERROR, this._removeLocalSourceOnReject);
  604. room.removeListener(XMPPEvents.SOURCE_REMOVE, this._updateRoomPresence);
  605. this.eventManager.removeXMPPListeners();
  606. this._signalingLayer.setChatRoom(null);
  607. this.room = null;
  608. let leaveError;
  609. try {
  610. await room.leave(reason);
  611. } catch (err) {
  612. leaveError = err;
  613. // Remove all participants because currently the conference
  614. // won't be usable anyway. This is done on success automatically
  615. // by the ChatRoom instance.
  616. this.getParticipants().forEach(
  617. participant => this.onMemberLeft(participant.getJid()));
  618. }
  619. if (this.rtc) {
  620. this.rtc.destroy();
  621. }
  622. if (leaveError) {
  623. throw leaveError;
  624. }
  625. };
  626. /**
  627. * Returns <tt>true</tt> if end conference support is enabled in the backend.
  628. *
  629. * @returns {boolean} whether end conference is supported in the backend.
  630. */
  631. JitsiConference.prototype.isEndConferenceSupported = function() {
  632. return Boolean(this.room && this.room.xmpp.endConferenceComponentAddress);
  633. };
  634. /**
  635. * Ends the conference.
  636. */
  637. JitsiConference.prototype.end = function() {
  638. if (!this.isEndConferenceSupported()) {
  639. logger.warn('Cannot end conference: is not supported.');
  640. return;
  641. }
  642. if (!this.room) {
  643. throw new Error('The conference has been already left');
  644. }
  645. this.room.end();
  646. };
  647. /**
  648. * Returns the currently active media session if any.
  649. *
  650. * @returns {JingleSessionPC|undefined}
  651. */
  652. JitsiConference.prototype.getActiveMediaSession = function() {
  653. return this.isP2PActive() ? this.p2pJingleSession : this.jvbJingleSession;
  654. };
  655. /**
  656. * Returns an array containing all media sessions existing in this conference.
  657. *
  658. * @returns {Array<JingleSessionPC>}
  659. */
  660. JitsiConference.prototype.getMediaSessions = function() {
  661. const sessions = [];
  662. this.jvbJingleSession && sessions.push(this.jvbJingleSession);
  663. this.p2pJingleSession && sessions.push(this.p2pJingleSession);
  664. return sessions;
  665. };
  666. /**
  667. * Registers event listeners on the RTC instance.
  668. * @param {RTC} rtc - the RTC module instance used by this conference.
  669. * @private
  670. * @returns {void}
  671. */
  672. JitsiConference.prototype._registerRtcListeners = function(rtc) {
  673. rtc.addListener(RTCEvents.DATA_CHANNEL_OPEN, () => {
  674. for (const localTrack of this.rtc.localTracks) {
  675. localTrack.isVideoTrack() && this._sendBridgeVideoTypeMessage(localTrack);
  676. }
  677. });
  678. };
  679. /**
  680. * Sends the 'VideoTypeMessage' to the bridge on the bridge channel so that the bridge can make bitrate allocation
  681. * decisions based on the video type of the local source.
  682. *
  683. * @param {JitsiLocalTrack} localtrack - The track associated with the local source signaled to the bridge.
  684. * @returns {void}
  685. * @private
  686. */
  687. JitsiConference.prototype._sendBridgeVideoTypeMessage = function(localtrack) {
  688. let videoType = !localtrack || localtrack.isMuted() ? BridgeVideoType.NONE : localtrack.getVideoType();
  689. if (videoType === BridgeVideoType.DESKTOP && this._desktopSharingFrameRate > SS_DEFAULT_FRAME_RATE) {
  690. videoType = BridgeVideoType.DESKTOP_HIGH_FPS;
  691. }
  692. if (FeatureFlags.isSourceNameSignalingEnabled() && localtrack) {
  693. this.rtc.sendSourceVideoType(localtrack.getSourceName(), videoType);
  694. } else if (!FeatureFlags.isSourceNameSignalingEnabled()) {
  695. this.rtc.setVideoType(videoType);
  696. }
  697. };
  698. /**
  699. * Returns name of this conference.
  700. */
  701. JitsiConference.prototype.getName = function() {
  702. return this.options.name.toString();
  703. };
  704. /**
  705. * Returns the {@link JitsiConnection} used by this this conference.
  706. */
  707. JitsiConference.prototype.getConnection = function() {
  708. return this.connection;
  709. };
  710. /**
  711. * Check if authentication is enabled for this conference.
  712. */
  713. JitsiConference.prototype.isAuthEnabled = function() {
  714. return this.authEnabled;
  715. };
  716. /**
  717. * Check if user is logged in.
  718. */
  719. JitsiConference.prototype.isLoggedIn = function() {
  720. return Boolean(this.authIdentity);
  721. };
  722. /**
  723. * Get authorized login.
  724. */
  725. JitsiConference.prototype.getAuthLogin = function() {
  726. return this.authIdentity;
  727. };
  728. /**
  729. * Check if external authentication is enabled for this conference.
  730. */
  731. JitsiConference.prototype.isExternalAuthEnabled = function() {
  732. return this.room && this.room.moderator.isExternalAuthEnabled();
  733. };
  734. /**
  735. * Get url for external authentication.
  736. * @param {boolean} [urlForPopup] if true then return url for login popup,
  737. * else url of login page.
  738. * @returns {Promise}
  739. */
  740. JitsiConference.prototype.getExternalAuthUrl = function(urlForPopup) {
  741. return new Promise((resolve, reject) => {
  742. if (!this.isExternalAuthEnabled()) {
  743. reject();
  744. return;
  745. }
  746. if (urlForPopup) {
  747. this.room.moderator.getPopupLoginUrl(resolve, reject);
  748. } else {
  749. this.room.moderator.getLoginUrl(resolve, reject);
  750. }
  751. });
  752. };
  753. /**
  754. * Returns the local tracks of the given media type, or all local tracks if no
  755. * specific type is given.
  756. * @param {MediaType} [mediaType] Optional media type (audio or video).
  757. */
  758. JitsiConference.prototype.getLocalTracks = function(mediaType) {
  759. let tracks = [];
  760. if (this.rtc) {
  761. tracks = this.rtc.getLocalTracks(mediaType);
  762. }
  763. return tracks;
  764. };
  765. /**
  766. * Obtains local audio track.
  767. * @return {JitsiLocalTrack|null}
  768. */
  769. JitsiConference.prototype.getLocalAudioTrack = function() {
  770. return this.rtc ? this.rtc.getLocalAudioTrack() : null;
  771. };
  772. /**
  773. * Obtains local video track.
  774. * @return {JitsiLocalTrack|null}
  775. */
  776. JitsiConference.prototype.getLocalVideoTrack = function() {
  777. return this.rtc ? this.rtc.getLocalVideoTrack() : null;
  778. };
  779. /**
  780. * Returns all the local video tracks.
  781. * @returns {Array<JitsiLocalTrack>}
  782. */
  783. JitsiConference.prototype.getLocalVideoTracks = function() {
  784. return this.rtc ? this.rtc.getLocalVideoTracks() : null;
  785. };
  786. /**
  787. * Obtains the performance statistics.
  788. * @returns {Object|null}
  789. */
  790. JitsiConference.prototype.getPerformanceStats = function() {
  791. return {
  792. longTasksStats: this.statistics.getLongTasksStats()
  793. };
  794. };
  795. /**
  796. * Attaches a handler for events(For example - "participant joined".) in the
  797. * conference. All possible event are defined in JitsiConferenceEvents.
  798. * @param eventId the event ID.
  799. * @param handler handler for the event.
  800. *
  801. * Note: consider adding eventing functionality by extending an EventEmitter
  802. * impl, instead of rolling ourselves
  803. */
  804. JitsiConference.prototype.on = function(eventId, handler) {
  805. if (this.eventEmitter) {
  806. this.eventEmitter.on(eventId, handler);
  807. }
  808. };
  809. /**
  810. * Removes event listener
  811. * @param eventId the event ID.
  812. * @param [handler] optional, the specific handler to unbind
  813. *
  814. * Note: consider adding eventing functionality by extending an EventEmitter
  815. * impl, instead of rolling ourselves
  816. */
  817. JitsiConference.prototype.off = function(eventId, handler) {
  818. if (this.eventEmitter) {
  819. this.eventEmitter.removeListener(eventId, handler);
  820. }
  821. };
  822. // Common aliases for event emitter
  823. JitsiConference.prototype.addEventListener = JitsiConference.prototype.on;
  824. JitsiConference.prototype.removeEventListener = JitsiConference.prototype.off;
  825. /**
  826. * Receives notifications from other participants about commands / custom events
  827. * (sent by sendCommand or sendCommandOnce methods).
  828. * @param command {String} the name of the command
  829. * @param handler {Function} handler for the command
  830. */
  831. JitsiConference.prototype.addCommandListener = function(command, handler) {
  832. if (this.room) {
  833. this.room.addPresenceListener(command, handler);
  834. }
  835. };
  836. /**
  837. * Removes command listener
  838. * @param command {String} the name of the command
  839. * @param handler {Function} handler to remove for the command
  840. */
  841. JitsiConference.prototype.removeCommandListener = function(command, handler) {
  842. if (this.room) {
  843. this.room.removePresenceListener(command, handler);
  844. }
  845. };
  846. /**
  847. * Sends text message to the other participants in the conference
  848. * @param message the text message.
  849. * @param elementName the element name to encapsulate the message.
  850. * @deprecated Use 'sendMessage' instead. TODO: this should be private.
  851. */
  852. JitsiConference.prototype.sendTextMessage = function(message, elementName = 'body') {
  853. if (this.room) {
  854. this.room.sendMessage(message, elementName);
  855. }
  856. };
  857. /**
  858. * Send private text message to another participant of the conference
  859. * @param id the id of the participant to send a private message.
  860. * @param message the text message.
  861. * @param elementName the element name to encapsulate the message.
  862. * @deprecated Use 'sendMessage' instead. TODO: this should be private.
  863. */
  864. JitsiConference.prototype.sendPrivateTextMessage = function(id, message, elementName = 'body') {
  865. if (this.room) {
  866. this.room.sendPrivateMessage(id, message, elementName);
  867. }
  868. };
  869. /**
  870. * Send presence command.
  871. * @param name {String} the name of the command.
  872. * @param values {Object} with keys and values that will be sent.
  873. **/
  874. JitsiConference.prototype.sendCommand = function(name, values) {
  875. if (this.room) {
  876. this.room.addOrReplaceInPresence(name, values) && this.room.sendPresence();
  877. } else {
  878. logger.warn('Not sending a command, room not initialized.');
  879. }
  880. };
  881. /**
  882. * Send presence command one time.
  883. * @param name {String} the name of the command.
  884. * @param values {Object} with keys and values that will be sent.
  885. **/
  886. JitsiConference.prototype.sendCommandOnce = function(name, values) {
  887. this.sendCommand(name, values);
  888. this.removeCommand(name);
  889. };
  890. /**
  891. * Removes presence command.
  892. * @param name {String} the name of the command.
  893. **/
  894. JitsiConference.prototype.removeCommand = function(name) {
  895. if (this.room) {
  896. this.room.removeFromPresence(name);
  897. }
  898. };
  899. /**
  900. * Sets the display name for this conference.
  901. * @param name the display name to set
  902. */
  903. JitsiConference.prototype.setDisplayName = function(name) {
  904. if (this.room) {
  905. const nickKey = 'nick';
  906. // if there is no display name already set, avoid setting an empty one
  907. if (!name && !this.room.getFromPresence(nickKey)) {
  908. return;
  909. }
  910. this.room.addOrReplaceInPresence(nickKey, {
  911. attributes: { xmlns: 'http://jabber.org/protocol/nick' },
  912. value: name
  913. }) && this.room.sendPresence();
  914. }
  915. };
  916. /**
  917. * Set new subject for this conference. (available only for moderator)
  918. * @param {string} subject new subject
  919. */
  920. JitsiConference.prototype.setSubject = function(subject) {
  921. if (this.room && this.isModerator()) {
  922. this.room.setSubject(subject);
  923. } else {
  924. logger.warn(`Failed to set subject, ${this.room ? '' : 'not in a room, '}${
  925. this.isModerator() ? '' : 'participant is not a moderator'}`);
  926. }
  927. };
  928. /**
  929. * Get a transcriber object for all current participants in this conference
  930. * @return {Transcriber} the transcriber object
  931. */
  932. JitsiConference.prototype.getTranscriber = function() {
  933. if (this.transcriber === undefined) {
  934. this.transcriber = new Transcriber();
  935. // add all existing local audio tracks to the transcriber
  936. const localAudioTracks = this.getLocalTracks(MediaType.AUDIO);
  937. for (const localAudio of localAudioTracks) {
  938. this.transcriber.addTrack(localAudio);
  939. }
  940. // and all remote audio tracks
  941. const remoteAudioTracks = this.rtc.getRemoteTracks(MediaType.AUDIO);
  942. for (const remoteTrack of remoteAudioTracks) {
  943. this.transcriber.addTrack(remoteTrack);
  944. }
  945. }
  946. return this.transcriber;
  947. };
  948. /**
  949. * Returns the transcription status.
  950. *
  951. * @returns {String} "on" or "off".
  952. */
  953. JitsiConference.prototype.getTranscriptionStatus = function() {
  954. return this.room.transcriptionStatus;
  955. };
  956. /**
  957. * Adds JitsiLocalTrack object to the conference.
  958. * @param {JitsiLocalTrack} track the JitsiLocalTrack object.
  959. * @returns {Promise<JitsiLocalTrack>}
  960. * @throws {Error} if the specified track is a video track and there is already
  961. * another video track in the conference.
  962. */
  963. JitsiConference.prototype.addTrack = function(track) {
  964. const mediaType = track.getType();
  965. const localTracks = this.rtc.getLocalTracks(mediaType);
  966. // Ensure there's exactly 1 local track of each media type in the conference.
  967. if (localTracks.length > 0) {
  968. // Don't be excessively harsh and severe if the API client happens to attempt to add the same local track twice.
  969. if (track === localTracks[0]) {
  970. return Promise.resolve(track);
  971. }
  972. // Currently, only adding multiple video streams of different video types is supported.
  973. // TODO - remove this limitation once issues with jitsi-meet trying to add multiple camera streams is fixed.
  974. if (FeatureFlags.isMultiStreamSupportEnabled()
  975. && mediaType === MediaType.VIDEO
  976. && !localTracks.find(t => t.getVideoType() === track.getVideoType())) {
  977. const sourceName = getSourceNameForJitsiTrack(
  978. this.myUserId(),
  979. mediaType,
  980. this.getLocalTracks(mediaType)?.length);
  981. track.setSourceName(sourceName);
  982. const addTrackPromises = [];
  983. this.p2pJingleSession && addTrackPromises.push(this.p2pJingleSession.addTracks([ track ]));
  984. this.jvbJingleSession && addTrackPromises.push(this.jvbJingleSession.addTracks([ track ]));
  985. return Promise.all(addTrackPromises)
  986. .then(() => {
  987. this._setupNewTrack(track);
  988. this._sendBridgeVideoTypeMessage(track);
  989. this._updateRoomPresence(this.getActiveMediaSession());
  990. if (this.isMutedByFocus || this.isVideoMutedByFocus) {
  991. this._fireMuteChangeEvent(track);
  992. }
  993. });
  994. }
  995. return Promise.reject(new Error(`Cannot add second ${mediaType} track to the conference`));
  996. }
  997. return this.replaceTrack(null, track)
  998. .then(() => {
  999. // Presence needs to be sent here for desktop track since we need the presence to reach the remote peer
  1000. // before signaling so that a fake participant tile is created for screenshare. Otherwise, presence will
  1001. // only be sent after a session-accept or source-add is ack'ed.
  1002. if (track.getVideoType() === VideoType.DESKTOP && FeatureFlags.isMultiStreamSupportEnabled()) {
  1003. this._updateRoomPresence(this.getActiveMediaSession());
  1004. }
  1005. });
  1006. };
  1007. /**
  1008. * Fires TRACK_AUDIO_LEVEL_CHANGED change conference event (for local tracks).
  1009. * @param {number} audioLevel the audio level
  1010. * @param {TraceablePeerConnection} [tpc]
  1011. */
  1012. JitsiConference.prototype._fireAudioLevelChangeEvent = function(audioLevel, tpc) {
  1013. const activeTpc = this.getActivePeerConnection();
  1014. // There will be no TraceablePeerConnection if audio levels do not come from
  1015. // a peerconnection. LocalStatsCollector.js measures audio levels using Web
  1016. // Audio Analyser API and emits local audio levels events through
  1017. // JitsiTrack.setAudioLevel, but does not provide TPC instance which is
  1018. // optional.
  1019. if (!tpc || activeTpc === tpc) {
  1020. this.eventEmitter.emit(
  1021. JitsiConferenceEvents.TRACK_AUDIO_LEVEL_CHANGED,
  1022. this.myUserId(), audioLevel);
  1023. }
  1024. };
  1025. /**
  1026. * Fires TRACK_MUTE_CHANGED change conference event.
  1027. * @param track the JitsiTrack object related to the event.
  1028. */
  1029. JitsiConference.prototype._fireMuteChangeEvent = function(track) {
  1030. // check if track was muted by focus and now is unmuted by user
  1031. if (this.isMutedByFocus && track.isAudioTrack() && !track.isMuted()) {
  1032. this.isMutedByFocus = false;
  1033. // unmute local user on server
  1034. this.room.muteParticipant(this.room.myroomjid, false, MediaType.AUDIO);
  1035. } else if (this.isVideoMutedByFocus && track.isVideoTrack() && !track.isMuted()) {
  1036. this.isVideoMutedByFocus = false;
  1037. // unmute local user on server
  1038. this.room.muteParticipant(this.room.myroomjid, false, MediaType.VIDEO);
  1039. }
  1040. let actorParticipant;
  1041. if (this.mutedByFocusActor && track.isAudioTrack()) {
  1042. const actorId = Strophe.getResourceFromJid(this.mutedByFocusActor);
  1043. actorParticipant = this.participants[actorId];
  1044. } else if (this.mutedVideoByFocusActor && track.isVideoTrack()) {
  1045. const actorId = Strophe.getResourceFromJid(this.mutedVideoByFocusActor);
  1046. actorParticipant = this.participants[actorId];
  1047. }
  1048. // Send the video type message to the bridge if the track is not removed/added to the pc as part of
  1049. // the mute/unmute operation. This currently happens only on Firefox.
  1050. if (track.isVideoTrack() && !browser.doesVideoMuteByStreamRemove()) {
  1051. this._sendBridgeVideoTypeMessage(track);
  1052. }
  1053. this.eventEmitter.emit(JitsiConferenceEvents.TRACK_MUTE_CHANGED, track, actorParticipant);
  1054. };
  1055. /**
  1056. * Returns the list of local tracks that need to be added to the peerconnection on join.
  1057. * This takes the startAudioMuted/startVideoMuted flags into consideration since we do not
  1058. * want to add the tracks if the user joins the call audio/video muted. The tracks will be
  1059. * added when the user unmutes for the first time.
  1060. * @returns {Array<JitsiLocalTrack>} - list of local tracks that are unmuted.
  1061. */
  1062. JitsiConference.prototype._getInitialLocalTracks = function() {
  1063. // Always add the audio track on certain platforms:
  1064. // * Safari / WebKit: because of a known issue where audio playout doesn't happen
  1065. // if the user joins audio and video muted.
  1066. // * React Native: after iOS 15, if a user joins muted they won't be able to unmute.
  1067. return this.getLocalTracks()
  1068. .filter(track => {
  1069. const trackType = track.getType();
  1070. if (trackType === MediaType.AUDIO
  1071. && (!this.isStartAudioMuted() || browser.isWebKitBased() || browser.isReactNative())) {
  1072. return true;
  1073. } else if (trackType === MediaType.VIDEO && !this.isStartVideoMuted()) {
  1074. return true;
  1075. }
  1076. return false;
  1077. });
  1078. };
  1079. /**
  1080. * Clear JitsiLocalTrack properties and listeners.
  1081. * @param track the JitsiLocalTrack object.
  1082. */
  1083. JitsiConference.prototype.onLocalTrackRemoved = function(track) {
  1084. track.setConference(null);
  1085. this.rtc.removeLocalTrack(track);
  1086. track.removeEventListener(JitsiTrackEvents.TRACK_MUTE_CHANGED, track.muteHandler);
  1087. if (track.isAudioTrack()) {
  1088. track.removeEventListener(JitsiTrackEvents.TRACK_AUDIO_LEVEL_CHANGED, track.audioLevelHandler);
  1089. }
  1090. // send event for stopping screen sharing
  1091. // FIXME: we assume we have only one screen sharing track
  1092. // if we change this we need to fix this check
  1093. if (track.isVideoTrack() && track.videoType === VideoType.DESKTOP) {
  1094. this.statistics.sendScreenSharingEvent(false);
  1095. }
  1096. this.eventEmitter.emit(JitsiConferenceEvents.TRACK_REMOVED, track);
  1097. };
  1098. /**
  1099. * Removes JitsiLocalTrack from the conference and performs
  1100. * a new offer/answer cycle.
  1101. * @param {JitsiLocalTrack} track
  1102. * @returns {Promise}
  1103. */
  1104. JitsiConference.prototype.removeTrack = function(track) {
  1105. return this.replaceTrack(track, null);
  1106. };
  1107. /**
  1108. * Replaces oldTrack with newTrack and performs a single offer/answer
  1109. * cycle after both operations are done. Either oldTrack or newTrack
  1110. * can be null; replacing a valid 'oldTrack' with a null 'newTrack'
  1111. * effectively just removes 'oldTrack'
  1112. * @param {JitsiLocalTrack} oldTrack the current stream in use to be replaced
  1113. * @param {JitsiLocalTrack} newTrack the new stream to use
  1114. * @returns {Promise} resolves when the replacement is finished
  1115. */
  1116. JitsiConference.prototype.replaceTrack = function(oldTrack, newTrack) {
  1117. const oldVideoType = oldTrack?.getVideoType();
  1118. const mediaType = oldTrack?.getType() || newTrack?.getType();
  1119. const newVideoType = newTrack?.getVideoType();
  1120. if (FeatureFlags.isMultiStreamSupportEnabled() && oldTrack && newTrack && oldVideoType !== newVideoType) {
  1121. throw new Error(`Replacing a track of videoType=${oldVideoType} with a track of videoType=${newVideoType} is`
  1122. + ' not supported in this mode.');
  1123. }
  1124. if (FeatureFlags.isSourceNameSignalingEnabled() && newTrack) {
  1125. if (oldTrack) {
  1126. newTrack.setSourceName(oldTrack.getSourceName());
  1127. } else {
  1128. const sourceName = getSourceNameForJitsiTrack(
  1129. this.myUserId(),
  1130. mediaType,
  1131. this.getLocalTracks(mediaType)?.length);
  1132. newTrack.setSourceName(sourceName);
  1133. }
  1134. }
  1135. const oldTrackBelongsToConference = this === oldTrack?.conference;
  1136. if (oldTrackBelongsToConference && oldTrack.disposed) {
  1137. return Promise.reject(new JitsiTrackError(JitsiTrackErrors.TRACK_IS_DISPOSED));
  1138. }
  1139. if (newTrack?.disposed) {
  1140. return Promise.reject(new JitsiTrackError(JitsiTrackErrors.TRACK_IS_DISPOSED));
  1141. }
  1142. if (oldTrack && !oldTrackBelongsToConference) {
  1143. logger.warn(`JitsiConference.replaceTrack oldTrack (${oldTrack} does not belong to this conference`);
  1144. }
  1145. // Now replace the stream at the lower levels
  1146. return this._doReplaceTrack(oldTrackBelongsToConference ? oldTrack : null, newTrack)
  1147. .then(() => {
  1148. oldTrackBelongsToConference && this.onLocalTrackRemoved(oldTrack);
  1149. newTrack && this._setupNewTrack(newTrack);
  1150. // Send 'VideoTypeMessage' on the bridge channel when a video track is added/removed.
  1151. if ((oldTrackBelongsToConference && oldTrack?.isVideoTrack()) || newTrack?.isVideoTrack()) {
  1152. this._sendBridgeVideoTypeMessage(newTrack);
  1153. }
  1154. this._updateRoomPresence(this.getActiveMediaSession());
  1155. if (newTrack !== null && (this.isMutedByFocus || this.isVideoMutedByFocus)) {
  1156. this._fireMuteChangeEvent(newTrack);
  1157. }
  1158. return Promise.resolve();
  1159. })
  1160. .catch(error => {
  1161. logger.error(`replaceTrack failed: ${error?.stack}`);
  1162. return Promise.reject(error);
  1163. });
  1164. };
  1165. /**
  1166. * Replaces the tracks at the lower level by going through the Jingle session
  1167. * and WebRTC peer connection. The method will resolve immediately if there is
  1168. * currently no JingleSession started.
  1169. * @param {JitsiLocalTrack|null} oldTrack the track to be removed during
  1170. * the process or <tt>null</t> if the method should act as "add track"
  1171. * @param {JitsiLocalTrack|null} newTrack the new track to be added or
  1172. * <tt>null</tt> if the method should act as "remove track"
  1173. * @return {Promise} resolved when the process is done or rejected with a string
  1174. * which describes the error.
  1175. * @private
  1176. */
  1177. JitsiConference.prototype._doReplaceTrack = function(oldTrack, newTrack) {
  1178. const replaceTrackPromises = [];
  1179. if (this.jvbJingleSession) {
  1180. replaceTrackPromises.push(this.jvbJingleSession.replaceTrack(oldTrack, newTrack));
  1181. } else {
  1182. logger.info('_doReplaceTrack - no JVB JingleSession');
  1183. }
  1184. if (this.p2pJingleSession) {
  1185. replaceTrackPromises.push(this.p2pJingleSession.replaceTrack(oldTrack, newTrack));
  1186. } else {
  1187. logger.info('_doReplaceTrack - no P2P JingleSession');
  1188. }
  1189. return Promise.all(replaceTrackPromises);
  1190. };
  1191. /**
  1192. * Handler for when a source-add for a local source is rejected by Jicofo.
  1193. *
  1194. * @param {JingleSessionPC} jingleSession - The media session.
  1195. * @param {Error} error - The error message.
  1196. * @param {MediaType} mediaType - The media type of the track associated with the source that was rejected.
  1197. * @returns {void}
  1198. */
  1199. JitsiConference.prototype._removeLocalSourceOnReject = function(jingleSession, error, mediaType) {
  1200. if (!jingleSession) {
  1201. return;
  1202. }
  1203. logger.warn(`Source-add rejected on ${jingleSession}, reason="${error?.reason}", message="${error?.msg}"`);
  1204. const track = this.getLocalTracks(mediaType)[0];
  1205. this.eventEmitter.emit(JitsiConferenceEvents.TRACK_UNMUTE_REJECTED, track);
  1206. };
  1207. /**
  1208. * Operations related to creating a new track
  1209. * @param {JitsiLocalTrack} newTrack the new track being created
  1210. */
  1211. JitsiConference.prototype._setupNewTrack = function(newTrack) {
  1212. const mediaType = newTrack.getType();
  1213. if (newTrack.isAudioTrack() || (newTrack.isVideoTrack() && newTrack.videoType !== VideoType.DESKTOP)) {
  1214. // Report active device to statistics
  1215. const devices = RTC.getCurrentlyAvailableMediaDevices();
  1216. const device = devices
  1217. .find(d => d.kind === `${newTrack.getTrack().kind}input` && d.label === newTrack.getTrack().label);
  1218. if (device) {
  1219. Statistics.sendActiveDeviceListEvent(RTC.getEventDataForActiveDevice(device));
  1220. }
  1221. }
  1222. // Create a source name for this track if it doesn't exist.
  1223. if (FeatureFlags.isSourceNameSignalingEnabled() && !newTrack.getSourceName()) {
  1224. const sourceName = getSourceNameForJitsiTrack(
  1225. this.myUserId(),
  1226. mediaType,
  1227. this.getLocalTracks(mediaType)?.length);
  1228. newTrack.setSourceName(sourceName);
  1229. }
  1230. this.rtc.addLocalTrack(newTrack);
  1231. newTrack.setConference(this);
  1232. // Add event handlers.
  1233. newTrack.muteHandler = this._fireMuteChangeEvent.bind(this, newTrack);
  1234. newTrack.addEventListener(JitsiTrackEvents.TRACK_MUTE_CHANGED, newTrack.muteHandler);
  1235. if (newTrack.isAudioTrack()) {
  1236. newTrack.audioLevelHandler = this._fireAudioLevelChangeEvent.bind(this);
  1237. newTrack.addEventListener(JitsiTrackEvents.TRACK_AUDIO_LEVEL_CHANGED, newTrack.audioLevelHandler);
  1238. }
  1239. this.eventEmitter.emit(JitsiConferenceEvents.TRACK_ADDED, newTrack);
  1240. };
  1241. /**
  1242. * Sets the video type.
  1243. * @param track
  1244. * @return <tt>true</tt> if video type was changed in presence.
  1245. * @private
  1246. */
  1247. JitsiConference.prototype._setNewVideoType = function(track) {
  1248. let videoTypeChanged = false;
  1249. if (FeatureFlags.isSourceNameSignalingEnabled() && track) {
  1250. videoTypeChanged = this._signalingLayer.setTrackVideoType(track.getSourceName(), track.videoType);
  1251. }
  1252. if (!FeatureFlags.isMultiStreamSupportEnabled()) {
  1253. const videoTypeTagName = 'videoType';
  1254. // If track is missing we revert to default type Camera, the case where we screenshare and
  1255. // we return to be video muted.
  1256. const trackVideoType = track ? track.videoType : VideoType.CAMERA;
  1257. // If video type is camera and there is no videoType in presence, we skip adding it, as this is the default one
  1258. if (trackVideoType !== VideoType.CAMERA || this.room.getFromPresence(videoTypeTagName)) {
  1259. // We will not use this.sendCommand here to avoid sending the presence immediately, as later we may also
  1260. // set the mute status.
  1261. const legacyTypeChanged = this.room.addOrReplaceInPresence(videoTypeTagName, { value: trackVideoType });
  1262. videoTypeChanged = videoTypeChanged || legacyTypeChanged;
  1263. }
  1264. }
  1265. return videoTypeChanged;
  1266. };
  1267. /**
  1268. * Sets mute status.
  1269. * @param mediaType
  1270. * @param localTrack
  1271. * @param isMuted
  1272. * @param <tt>true</tt> when presence was changed, <tt>false</tt> otherwise.
  1273. * @private
  1274. */
  1275. JitsiConference.prototype._setTrackMuteStatus = function(mediaType, localTrack, isMuted) {
  1276. let presenceChanged = false;
  1277. if (FeatureFlags.isSourceNameSignalingEnabled() && localTrack) {
  1278. presenceChanged = this._signalingLayer.setTrackMuteStatus(localTrack.getSourceName(), isMuted);
  1279. }
  1280. // Add the 'audioMuted' and 'videoMuted' tags when source name signaling is enabled for backward compatibility.
  1281. // It won't be used anymore when multiple stream support is enabled.
  1282. if (!FeatureFlags.isMultiStreamSupportEnabled()) {
  1283. let audioMuteChanged, videoMuteChanged;
  1284. if (!this.room) {
  1285. return false;
  1286. }
  1287. if (mediaType === MediaType.AUDIO) {
  1288. audioMuteChanged = this.room.addAudioInfoToPresence(isMuted);
  1289. } else {
  1290. videoMuteChanged = this.room.addVideoInfoToPresence(isMuted);
  1291. }
  1292. presenceChanged = presenceChanged || audioMuteChanged || videoMuteChanged;
  1293. }
  1294. return presenceChanged;
  1295. };
  1296. /**
  1297. * Method called by the {@link JitsiLocalTrack} in order to add the underlying MediaStream to the RTCPeerConnection.
  1298. *
  1299. * @param {JitsiLocalTrack} track the local track that will be added to the pc.
  1300. * @return {Promise} resolved when the process is done or rejected with a string which describes the error.
  1301. */
  1302. JitsiConference.prototype._addLocalTrackToPc = function(track) {
  1303. const addPromises = [];
  1304. if (this.jvbJingleSession) {
  1305. addPromises.push(this.jvbJingleSession.addTrackToPc(track));
  1306. } else {
  1307. logger.debug('Add local MediaStream - no JVB Jingle session started yet');
  1308. }
  1309. if (this.p2pJingleSession) {
  1310. addPromises.push(this.p2pJingleSession.addTrackToPc(track));
  1311. } else {
  1312. logger.debug('Add local MediaStream - no P2P Jingle session started yet');
  1313. }
  1314. return Promise.allSettled(addPromises);
  1315. };
  1316. /**
  1317. * Method called by the {@link JitsiLocalTrack} in order to remove the underlying MediaStream from the
  1318. * RTCPeerConnection.
  1319. *
  1320. * @param {JitsiLocalTrack} track the local track that will be removed.
  1321. * @return {Promise} resolved when the process is done or rejected with a string which describes the error.
  1322. */
  1323. JitsiConference.prototype._removeLocalTrackFromPc = function(track) {
  1324. const removePromises = [];
  1325. if (this.jvbJingleSession) {
  1326. removePromises.push(this.jvbJingleSession.removeTrackFromPc(track));
  1327. } else {
  1328. logger.debug('Remove local MediaStream - no JVB JingleSession started yet');
  1329. }
  1330. if (this.p2pJingleSession) {
  1331. removePromises.push(this.p2pJingleSession.removeTrackFromPc(track));
  1332. } else {
  1333. logger.debug('Remove local MediaStream - no P2P JingleSession started yet');
  1334. }
  1335. return Promise.allSettled(removePromises);
  1336. };
  1337. /**
  1338. * Get role of the local user.
  1339. * @returns {string} user role: 'moderator' or 'none'
  1340. */
  1341. JitsiConference.prototype.getRole = function() {
  1342. return this.room.role;
  1343. };
  1344. /**
  1345. * Returns whether or not the current conference has been joined as a hidden
  1346. * user.
  1347. *
  1348. * @returns {boolean|null} True if hidden, false otherwise. Will return null if
  1349. * no connection is active.
  1350. */
  1351. JitsiConference.prototype.isHidden = function() {
  1352. if (!this.connection) {
  1353. return null;
  1354. }
  1355. return Strophe.getDomainFromJid(this.connection.getJid())
  1356. === this.options.config.hiddenDomain;
  1357. };
  1358. /**
  1359. * Check if local user is moderator.
  1360. * @returns {boolean|null} true if local user is moderator, false otherwise. If
  1361. * we're no longer in the conference room then <tt>null</tt> is returned.
  1362. */
  1363. JitsiConference.prototype.isModerator = function() {
  1364. return this.room ? this.room.isModerator() : null;
  1365. };
  1366. /**
  1367. * Set password for the room.
  1368. * @param {string} password new password for the room.
  1369. * @returns {Promise}
  1370. */
  1371. JitsiConference.prototype.lock = function(password) {
  1372. if (!this.isModerator()) {
  1373. return Promise.reject(new Error('You are not moderator.'));
  1374. }
  1375. return new Promise((resolve, reject) => {
  1376. this.room.lockRoom(
  1377. password || '',
  1378. () => resolve(),
  1379. err => reject(err),
  1380. () => reject(JitsiConferenceErrors.PASSWORD_NOT_SUPPORTED));
  1381. });
  1382. };
  1383. /**
  1384. * Remove password from the room.
  1385. * @returns {Promise}
  1386. */
  1387. JitsiConference.prototype.unlock = function() {
  1388. return this.lock();
  1389. };
  1390. /**
  1391. * Elects the participant with the given id to be the selected participant in
  1392. * order to receive higher video quality (if simulcast is enabled).
  1393. * Or cache it if channel is not created and send it once channel is available.
  1394. * @param participantId the identifier of the participant
  1395. * @throws NetworkError or InvalidStateError or Error if the operation fails.
  1396. * @returns {void}
  1397. */
  1398. JitsiConference.prototype.selectParticipant = function(participantId) {
  1399. this.selectParticipants([ participantId ]);
  1400. };
  1401. /*
  1402. * Elects participants with given ids to be the selected participants in order
  1403. * to receive higher video quality (if simulcast is enabled). The argument
  1404. * should be an array of participant id strings or an empty array; an error will
  1405. * be thrown if a non-array is passed in. The error is thrown as a layer of
  1406. * protection against passing an invalid argument, as the error will happen in
  1407. * the bridge and may not be visible in the client.
  1408. *
  1409. * @param {Array<strings>} participantIds - An array of identifiers for
  1410. * participants.
  1411. * @returns {void}
  1412. */
  1413. JitsiConference.prototype.selectParticipants = function(participantIds) {
  1414. if (!Array.isArray(participantIds)) {
  1415. throw new Error('Invalid argument; participantIds must be an array.');
  1416. }
  1417. this.receiveVideoController.selectEndpoints(participantIds);
  1418. };
  1419. /**
  1420. * Obtains the current value for "lastN". See {@link setLastN} for more info.
  1421. * @returns {number}
  1422. */
  1423. JitsiConference.prototype.getLastN = function() {
  1424. return this.receiveVideoController.getLastN();
  1425. };
  1426. /**
  1427. * Obtains the forwarded sources list in this conference.
  1428. * @return {Array<string>|null}
  1429. */
  1430. JitsiConference.prototype.getForwardedSources = function() {
  1431. return this.rtc.getForwardedSources();
  1432. };
  1433. /**
  1434. * Selects a new value for "lastN". The requested amount of videos are going
  1435. * to be delivered after the value is in effect. Set to -1 for unlimited or
  1436. * all available videos.
  1437. * @param lastN the new number of videos the user would like to receive.
  1438. * @throws Error or RangeError if the given value is not a number or is smaller
  1439. * than -1.
  1440. */
  1441. JitsiConference.prototype.setLastN = function(lastN) {
  1442. if (!Number.isInteger(lastN) && !Number.parseInt(lastN, 10)) {
  1443. throw new Error(`Invalid value for lastN: ${lastN}`);
  1444. }
  1445. const n = Number(lastN);
  1446. if (n < -1) {
  1447. throw new RangeError('lastN cannot be smaller than -1');
  1448. }
  1449. this.receiveVideoController.setLastN(n);
  1450. // If the P2P session is not fully established yet, we wait until it gets
  1451. // established.
  1452. if (this.p2pJingleSession) {
  1453. const isVideoActive = n !== 0;
  1454. this.p2pJingleSession
  1455. .setMediaTransferActive(true, isVideoActive)
  1456. .catch(error => {
  1457. logger.error(
  1458. `Failed to adjust video transfer status (${isVideoActive})`,
  1459. error);
  1460. });
  1461. }
  1462. };
  1463. /**
  1464. * Checks if the participant given by participantId is currently included in
  1465. * the last N.
  1466. * @param {string} participantId the identifier of the participant we would
  1467. * like to check.
  1468. * @return {boolean} true if the participant with id is in the last N set or
  1469. * if there's no last N set, false otherwise.
  1470. * @deprecated this method should never be used to figure out the UI, but
  1471. * {@link ParticipantConnectionStatus} should be used instead.
  1472. */
  1473. JitsiConference.prototype.isInLastN = function(participantId) {
  1474. return this.rtc.isInLastN(participantId);
  1475. };
  1476. /**
  1477. * @return Array<JitsiParticipant> an array of all participants in this
  1478. * conference.
  1479. */
  1480. JitsiConference.prototype.getParticipants = function() {
  1481. return Object.values(this.participants);
  1482. };
  1483. /**
  1484. * Returns the number of participants in the conference, including the local
  1485. * participant.
  1486. * @param countHidden {boolean} Whether or not to include hidden participants
  1487. * in the count. Default: false.
  1488. **/
  1489. JitsiConference.prototype.getParticipantCount = function(countHidden = false) {
  1490. let participants = this.getParticipants();
  1491. if (!countHidden) {
  1492. participants = participants.filter(p => !p.isHidden());
  1493. }
  1494. // Add one for the local participant.
  1495. return participants.length + 1;
  1496. };
  1497. /**
  1498. * @returns {JitsiParticipant} the participant in this conference with the
  1499. * specified id (or undefined if there isn't one).
  1500. * @param id the id of the participant.
  1501. */
  1502. JitsiConference.prototype.getParticipantById = function(id) {
  1503. return this.participants[id];
  1504. };
  1505. /**
  1506. * Grant owner rights to the participant.
  1507. * @param {string} id id of the participant to grant owner rights to.
  1508. */
  1509. JitsiConference.prototype.grantOwner = function(id) {
  1510. const participant = this.getParticipantById(id);
  1511. if (!participant) {
  1512. return;
  1513. }
  1514. this.room.setAffiliation(participant.getConnectionJid(), 'owner');
  1515. };
  1516. /**
  1517. * Revoke owner rights to the participant or local Participant as
  1518. * the user might want to refuse to be a moderator.
  1519. * @param {string} id id of the participant to revoke owner rights to.
  1520. */
  1521. JitsiConference.prototype.revokeOwner = function(id) {
  1522. const participant = this.getParticipantById(id);
  1523. const isMyself = this.myUserId() === id;
  1524. const role = this.isMembersOnly() ? 'member' : 'none';
  1525. if (isMyself) {
  1526. this.room.setAffiliation(this.connection.getJid(), role);
  1527. } else if (participant) {
  1528. this.room.setAffiliation(participant.getConnectionJid(), role);
  1529. }
  1530. };
  1531. /**
  1532. * Kick participant from this conference.
  1533. * @param {string} id id of the participant to kick
  1534. * @param {string} reason reason of the participant to kick
  1535. */
  1536. JitsiConference.prototype.kickParticipant = function(id, reason) {
  1537. const participant = this.getParticipantById(id);
  1538. if (!participant) {
  1539. return;
  1540. }
  1541. this.room.kick(participant.getJid(), reason);
  1542. };
  1543. /**
  1544. * Maybe clears the timeout which emits {@link ACTION_JINGLE_SI_TIMEOUT}
  1545. * analytics event.
  1546. * @private
  1547. */
  1548. JitsiConference.prototype._maybeClearSITimeout = function() {
  1549. if (this._sessionInitiateTimeout
  1550. && (this.jvbJingleSession || this.getParticipantCount() < 2)) {
  1551. window.clearTimeout(this._sessionInitiateTimeout);
  1552. this._sessionInitiateTimeout = null;
  1553. }
  1554. };
  1555. /**
  1556. * Sets a timeout which will emit {@link ACTION_JINGLE_SI_TIMEOUT} analytics
  1557. * event.
  1558. * @private
  1559. */
  1560. JitsiConference.prototype._maybeSetSITimeout = function() {
  1561. // Jicofo is supposed to invite if there are at least 2 participants
  1562. if (!this.jvbJingleSession
  1563. && this.getParticipantCount() >= 2
  1564. && !this._sessionInitiateTimeout) {
  1565. this._sessionInitiateTimeout = window.setTimeout(() => {
  1566. this._sessionInitiateTimeout = null;
  1567. Statistics.sendAnalytics(createJingleEvent(
  1568. ACTION_JINGLE_SI_TIMEOUT,
  1569. {
  1570. p2p: false,
  1571. value: JINGLE_SI_TIMEOUT
  1572. }));
  1573. }, JINGLE_SI_TIMEOUT);
  1574. }
  1575. };
  1576. /**
  1577. * Mutes a participant.
  1578. * @param {string} id The id of the participant to mute.
  1579. */
  1580. JitsiConference.prototype.muteParticipant = function(id, mediaType) {
  1581. const muteMediaType = mediaType ? mediaType : MediaType.AUDIO;
  1582. if (muteMediaType !== MediaType.AUDIO && muteMediaType !== MediaType.VIDEO) {
  1583. logger.error(`Unsupported media type: ${muteMediaType}`);
  1584. return;
  1585. }
  1586. const participant = this.getParticipantById(id);
  1587. if (!participant) {
  1588. return;
  1589. }
  1590. this.room.muteParticipant(participant.getJid(), true, muteMediaType);
  1591. };
  1592. /* eslint-disable max-params */
  1593. /**
  1594. * Notifies this JitsiConference that a new member has joined its chat room.
  1595. *
  1596. * FIXME This should NOT be exposed!
  1597. *
  1598. * @param jid the jid of the participant in the MUC
  1599. * @param nick the display name of the participant
  1600. * @param role the role of the participant in the MUC
  1601. * @param isHidden indicates if this is a hidden participant (system
  1602. * participant for example a recorder).
  1603. * @param statsID the participant statsID (optional)
  1604. * @param status the initial status if any
  1605. * @param identity the member identity, if any
  1606. * @param botType the member botType, if any
  1607. * @param fullJid the member full jid, if any
  1608. * @param features the member botType, if any
  1609. * @param isReplaceParticipant whether this join replaces a participant with
  1610. * the same jwt.
  1611. */
  1612. JitsiConference.prototype.onMemberJoined = function(
  1613. jid, nick, role, isHidden, statsID, status, identity, botType, fullJid, features, isReplaceParticipant) {
  1614. const id = Strophe.getResourceFromJid(jid);
  1615. if (id === 'focus' || this.myUserId() === id) {
  1616. return;
  1617. }
  1618. const participant
  1619. = new JitsiParticipant(jid, this, nick, isHidden, statsID, status, identity);
  1620. participant.setConnectionJid(fullJid);
  1621. participant.setRole(role);
  1622. participant.setBotType(botType);
  1623. participant.setFeatures(features);
  1624. participant.setIsReplacing(isReplaceParticipant);
  1625. this.participants[id] = participant;
  1626. this.eventEmitter.emit(
  1627. JitsiConferenceEvents.USER_JOINED,
  1628. id,
  1629. participant);
  1630. this._updateFeatures(participant);
  1631. // maybeStart only if we had finished joining as then we will have information for the number of participants
  1632. if (this.isJoined()) {
  1633. this._maybeStartOrStopP2P();
  1634. }
  1635. this._maybeSetSITimeout();
  1636. };
  1637. /* eslint-enable max-params */
  1638. /**
  1639. * Get notified when we joined the room.
  1640. *
  1641. * FIXME This should NOT be exposed!
  1642. *
  1643. * @private
  1644. */
  1645. JitsiConference.prototype._onMucJoined = function() {
  1646. this._maybeStartOrStopP2P();
  1647. };
  1648. /**
  1649. * Updates features for a participant.
  1650. * @param {JitsiParticipant} participant - The participant to query for features.
  1651. * @returns {void}
  1652. * @private
  1653. */
  1654. JitsiConference.prototype._updateFeatures = function(participant) {
  1655. participant.getFeatures()
  1656. .then(features => {
  1657. participant._supportsDTMF = features.has('urn:xmpp:jingle:dtmf:0');
  1658. this.updateDTMFSupport();
  1659. if (features.has(FEATURE_JIGASI)) {
  1660. participant.setProperty('features_jigasi', true);
  1661. }
  1662. if (features.has(FEATURE_E2EE)) {
  1663. participant.setProperty('features_e2ee', true);
  1664. }
  1665. })
  1666. .catch(() => false);
  1667. };
  1668. /**
  1669. * Get notified when member bot type had changed.
  1670. * @param jid the member jid
  1671. * @param botType the new botType value
  1672. * @private
  1673. */
  1674. JitsiConference.prototype._onMemberBotTypeChanged = function(jid, botType) {
  1675. // find the participant and mark it as non bot, as the real one will join
  1676. // in a moment
  1677. const peers = this.getParticipants();
  1678. const botParticipant = peers.find(p => p.getJid() === jid);
  1679. if (botParticipant) {
  1680. botParticipant.setBotType(botType);
  1681. const id = Strophe.getResourceFromJid(jid);
  1682. this.eventEmitter.emit(
  1683. JitsiConferenceEvents.BOT_TYPE_CHANGED,
  1684. id,
  1685. botType);
  1686. }
  1687. // if botType changed to undefined, botType was removed, in case of
  1688. // poltergeist mode this is the moment when the poltergeist had exited and
  1689. // the real participant had already replaced it.
  1690. // In this case we can check and try p2p
  1691. if (!botParticipant.getBotType()) {
  1692. this._maybeStartOrStopP2P();
  1693. }
  1694. };
  1695. JitsiConference.prototype.onMemberLeft = function(jid, reason) {
  1696. const id = Strophe.getResourceFromJid(jid);
  1697. if (id === 'focus' || this.myUserId() === id) {
  1698. return;
  1699. }
  1700. const participant = this.participants[id];
  1701. const mediaSessions = this.getMediaSessions();
  1702. let tracksToBeRemoved = [];
  1703. for (const session of mediaSessions) {
  1704. const remoteTracks = session.peerconnection.getRemoteTracks(id);
  1705. remoteTracks && (tracksToBeRemoved = [ ...tracksToBeRemoved, ...remoteTracks ]);
  1706. // Remove the ssrcs from the remote description and renegotiate.
  1707. session.removeRemoteStreamsOnLeave(id);
  1708. }
  1709. // Fire the event before renegotiation is done so that the thumbnails can be removed immediately.
  1710. tracksToBeRemoved.forEach(track => {
  1711. this.eventEmitter.emit(JitsiConferenceEvents.TRACK_REMOVED, track);
  1712. });
  1713. if (participant) {
  1714. delete this.participants[id];
  1715. this.eventEmitter.emit(JitsiConferenceEvents.USER_LEFT, id, participant, reason);
  1716. }
  1717. if (this.room !== null) { // Skip if we have left the room already.
  1718. this._maybeStartOrStopP2P(true /* triggered by user left event */);
  1719. this._maybeClearSITimeout();
  1720. }
  1721. };
  1722. /* eslint-disable max-params */
  1723. /**
  1724. * Designates an event indicating that we were kicked from the XMPP MUC.
  1725. * @param {boolean} isSelfPresence - whether it is for local participant
  1726. * or another participant.
  1727. * @param {string} actorId - the id of the participant who was initiator
  1728. * of the kick.
  1729. * @param {string?} kickedParticipantId - when it is not a kick for local participant,
  1730. * this is the id of the participant which was kicked.
  1731. * @param {string} reason - reason of the participant to kick
  1732. * @param {boolean?} isReplaceParticipant - whether this is a server initiated kick in order
  1733. * to replace it with a participant with same jwt.
  1734. */
  1735. JitsiConference.prototype.onMemberKicked = function(
  1736. isSelfPresence,
  1737. actorId,
  1738. kickedParticipantId,
  1739. reason,
  1740. isReplaceParticipant) {
  1741. // This check which be true when we kick someone else. With the introduction of lobby
  1742. // the ChatRoom KICKED event is now also emitted for ourselves (the kicker) so we want to
  1743. // avoid emitting an event where `undefined` kicked someone.
  1744. if (actorId === this.myUserId()) {
  1745. return;
  1746. }
  1747. const actorParticipant = this.participants[actorId];
  1748. if (isSelfPresence) {
  1749. this.eventEmitter.emit(
  1750. JitsiConferenceEvents.KICKED, actorParticipant, reason, isReplaceParticipant);
  1751. this.leave();
  1752. return;
  1753. }
  1754. const kickedParticipant = this.participants[kickedParticipantId];
  1755. kickedParticipant.setIsReplaced(isReplaceParticipant);
  1756. this.eventEmitter.emit(
  1757. JitsiConferenceEvents.PARTICIPANT_KICKED, actorParticipant, kickedParticipant, reason);
  1758. };
  1759. /**
  1760. * Method called on local MUC role change.
  1761. * @param {string} role the name of new user's role as defined by XMPP MUC.
  1762. */
  1763. JitsiConference.prototype.onLocalRoleChanged = function(role) {
  1764. // Emit role changed for local JID
  1765. this.eventEmitter.emit(
  1766. JitsiConferenceEvents.USER_ROLE_CHANGED, this.myUserId(), role);
  1767. };
  1768. JitsiConference.prototype.onUserRoleChanged = function(jid, role) {
  1769. const id = Strophe.getResourceFromJid(jid);
  1770. const participant = this.getParticipantById(id);
  1771. if (!participant) {
  1772. return;
  1773. }
  1774. participant.setRole(role);
  1775. this.eventEmitter.emit(JitsiConferenceEvents.USER_ROLE_CHANGED, id, role);
  1776. };
  1777. JitsiConference.prototype.onDisplayNameChanged = function(jid, displayName) {
  1778. const id = Strophe.getResourceFromJid(jid);
  1779. const participant = this.getParticipantById(id);
  1780. if (!participant) {
  1781. return;
  1782. }
  1783. if (participant._displayName === displayName) {
  1784. return;
  1785. }
  1786. participant._displayName = displayName;
  1787. this.eventEmitter.emit(
  1788. JitsiConferenceEvents.DISPLAY_NAME_CHANGED,
  1789. id,
  1790. displayName);
  1791. };
  1792. /**
  1793. * Notifies this JitsiConference that a JitsiRemoteTrack was added to the conference.
  1794. *
  1795. * @param {JitsiRemoteTrack} track the JitsiRemoteTrack which was added to this JitsiConference.
  1796. */
  1797. JitsiConference.prototype.onRemoteTrackAdded = function(track) {
  1798. if (track.isP2P && !this.isP2PActive()) {
  1799. logger.info('Trying to add remote P2P track, when not in P2P - IGNORED');
  1800. return;
  1801. } else if (!track.isP2P && this.isP2PActive()) {
  1802. logger.info('Trying to add remote JVB track, when in P2P - IGNORED');
  1803. return;
  1804. }
  1805. const id = track.getParticipantId();
  1806. const participant = this.getParticipantById(id);
  1807. if (!participant) {
  1808. logger.error(`No participant found for id: ${id}`);
  1809. return;
  1810. }
  1811. // Add track to JitsiParticipant.
  1812. participant._tracks.push(track);
  1813. if (this.transcriber) {
  1814. this.transcriber.addTrack(track);
  1815. }
  1816. const emitter = this.eventEmitter;
  1817. track.addEventListener(
  1818. JitsiTrackEvents.TRACK_MUTE_CHANGED,
  1819. () => emitter.emit(JitsiConferenceEvents.TRACK_MUTE_CHANGED, track));
  1820. track.isAudioTrack() && track.addEventListener(
  1821. JitsiTrackEvents.TRACK_AUDIO_LEVEL_CHANGED,
  1822. (audioLevel, tpc) => {
  1823. const activeTPC = this.getActivePeerConnection();
  1824. if (activeTPC === tpc) {
  1825. emitter.emit(JitsiConferenceEvents.TRACK_AUDIO_LEVEL_CHANGED, id, audioLevel);
  1826. }
  1827. }
  1828. );
  1829. emitter.emit(JitsiConferenceEvents.TRACK_ADDED, track);
  1830. };
  1831. /**
  1832. * Callback called by the Jingle plugin when 'session-answer' is received.
  1833. * @param {JingleSessionPC} session the Jingle session for which an answer was
  1834. * received.
  1835. * @param {jQuery} answer a jQuery selector pointing to 'jingle' IQ element
  1836. */
  1837. // eslint-disable-next-line no-unused-vars
  1838. JitsiConference.prototype.onCallAccepted = function(session, answer) {
  1839. if (this.p2pJingleSession === session) {
  1840. logger.info('P2P setAnswer');
  1841. this.p2pJingleSession.setAnswer(answer);
  1842. this.eventEmitter.emit(JitsiConferenceEvents._MEDIA_SESSION_STARTED, this.p2pJingleSession);
  1843. }
  1844. };
  1845. /**
  1846. * Callback called by the Jingle plugin when 'transport-info' is received.
  1847. * @param {JingleSessionPC} session the Jingle session for which the IQ was
  1848. * received
  1849. * @param {jQuery} transportInfo a jQuery selector pointing to 'jingle' IQ
  1850. * element
  1851. */
  1852. // eslint-disable-next-line no-unused-vars
  1853. JitsiConference.prototype.onTransportInfo = function(session, transportInfo) {
  1854. if (this.p2pJingleSession === session) {
  1855. logger.info('P2P addIceCandidates');
  1856. this.p2pJingleSession.addIceCandidates(transportInfo);
  1857. }
  1858. };
  1859. /**
  1860. * Notifies this JitsiConference that a JitsiRemoteTrack was removed from
  1861. * the conference.
  1862. *
  1863. * @param {JitsiRemoteTrack} removedTrack
  1864. */
  1865. JitsiConference.prototype.onRemoteTrackRemoved = function(removedTrack) {
  1866. this.getParticipants().forEach(participant => {
  1867. const tracks = participant.getTracks();
  1868. for (let i = 0; i < tracks.length; i++) {
  1869. if (tracks[i] === removedTrack) {
  1870. // Since the tracks have been compared and are
  1871. // considered equal the result of splice can be ignored.
  1872. participant._tracks.splice(i, 1);
  1873. this.eventEmitter.emit(JitsiConferenceEvents.TRACK_REMOVED, removedTrack);
  1874. if (this.transcriber) {
  1875. this.transcriber.removeTrack(removedTrack);
  1876. }
  1877. break;
  1878. }
  1879. }
  1880. }, this);
  1881. };
  1882. /**
  1883. * Handles an incoming call event for the P2P jingle session.
  1884. */
  1885. JitsiConference.prototype._onIncomingCallP2P = function(jingleSession, jingleOffer) {
  1886. let rejectReason;
  1887. const usesUnifiedPlan = browser.supportsUnifiedPlan()
  1888. && (!browser.isChromiumBased() || (this.options.config.enableUnifiedOnChrome ?? true));
  1889. const contentName = jingleOffer.find('>content').attr('name');
  1890. const peerUsesUnifiedPlan = contentName === '0' || contentName === '1';
  1891. // Reject P2P between endpoints that are not running in the same mode w.r.t to SDPs (plan-b and unified plan).
  1892. if (usesUnifiedPlan !== peerUsesUnifiedPlan) {
  1893. rejectReason = {
  1894. reason: 'decline',
  1895. reasonDescription: 'P2P disabled',
  1896. errorMsg: 'P2P across two endpoints in different SDP modes is disabled'
  1897. };
  1898. } else if ((!this.isP2PEnabled() && !this.isP2PTestModeEnabled())
  1899. || browser.isFirefox()
  1900. || browser.isWebKitBased()) {
  1901. rejectReason = {
  1902. reason: 'decline',
  1903. reasonDescription: 'P2P disabled',
  1904. errorMsg: 'P2P mode disabled in the configuration or browser unsupported'
  1905. };
  1906. } else if (this.p2pJingleSession) {
  1907. // Reject incoming P2P call (already in progress)
  1908. rejectReason = {
  1909. reason: 'busy',
  1910. reasonDescription: 'P2P already in progress',
  1911. errorMsg: 'Duplicated P2P "session-initiate"'
  1912. };
  1913. } else if (!this._shouldBeInP2PMode()) {
  1914. rejectReason = {
  1915. reason: 'decline',
  1916. reasonDescription: 'P2P requirements not met',
  1917. errorMsg: 'Received P2P "session-initiate" when should not be in P2P mode'
  1918. };
  1919. Statistics.sendAnalytics(createJingleEvent(ACTION_P2P_DECLINED));
  1920. }
  1921. if (rejectReason) {
  1922. this._rejectIncomingCall(jingleSession, rejectReason);
  1923. } else {
  1924. this._acceptP2PIncomingCall(jingleSession, jingleOffer);
  1925. }
  1926. };
  1927. /**
  1928. * Handles an incoming call event.
  1929. */
  1930. JitsiConference.prototype.onIncomingCall = function(jingleSession, jingleOffer, now) {
  1931. // Handle incoming P2P call
  1932. if (jingleSession.isP2P) {
  1933. this._onIncomingCallP2P(jingleSession, jingleOffer);
  1934. } else {
  1935. if (!this.isFocus(jingleSession.remoteJid)) {
  1936. const description = 'Rejecting session-initiate from non-focus.';
  1937. this._rejectIncomingCall(
  1938. jingleSession, {
  1939. reason: 'security-error',
  1940. reasonDescription: description,
  1941. errorMsg: description
  1942. });
  1943. return;
  1944. }
  1945. this._acceptJvbIncomingCall(jingleSession, jingleOffer, now);
  1946. }
  1947. };
  1948. /**
  1949. * Accepts an incoming call event for the JVB jingle session.
  1950. */
  1951. JitsiConference.prototype._acceptJvbIncomingCall = function(jingleSession, jingleOffer, now) {
  1952. // Accept incoming call
  1953. this.jvbJingleSession = jingleSession;
  1954. this.room.connectionTimes['session.initiate'] = now;
  1955. this._sendConferenceJoinAnalyticsEvent();
  1956. if (this.wasStopped) {
  1957. Statistics.sendAnalyticsAndLog(createJingleEvent(ACTION_JINGLE_RESTART, { p2p: false }));
  1958. }
  1959. const serverRegion
  1960. = $(jingleOffer)
  1961. .find('>bridge-session[xmlns="http://jitsi.org/protocol/focus"]')
  1962. .attr('region');
  1963. this.eventEmitter.emit(JitsiConferenceEvents.SERVER_REGION_CHANGED, serverRegion);
  1964. this._maybeClearSITimeout();
  1965. Statistics.sendAnalytics(createJingleEvent(
  1966. ACTION_JINGLE_SI_RECEIVED,
  1967. {
  1968. p2p: false,
  1969. value: now
  1970. }));
  1971. try {
  1972. jingleSession.initialize(
  1973. this.room,
  1974. this.rtc,
  1975. this._signalingLayer,
  1976. {
  1977. ...this.options.config,
  1978. enableInsertableStreams: this.isE2EEEnabled()
  1979. });
  1980. } catch (error) {
  1981. GlobalOnErrorHandler.callErrorHandler(error);
  1982. logger.error(error);
  1983. return;
  1984. }
  1985. // Open a channel with the videobridge.
  1986. this._setBridgeChannel(jingleOffer, jingleSession.peerconnection);
  1987. const localTracks = this._getInitialLocalTracks();
  1988. try {
  1989. jingleSession.acceptOffer(
  1990. jingleOffer,
  1991. () => {
  1992. // If for any reason invite for the JVB session arrived after
  1993. // the P2P has been established already the media transfer needs
  1994. // to be turned off here.
  1995. if (this.isP2PActive() && this.jvbJingleSession) {
  1996. this._suspendMediaTransferForJvbConnection();
  1997. }
  1998. this.eventEmitter.emit(JitsiConferenceEvents._MEDIA_SESSION_STARTED, jingleSession);
  1999. if (!this.isP2PActive()) {
  2000. this.eventEmitter.emit(JitsiConferenceEvents._MEDIA_SESSION_ACTIVE_CHANGED, jingleSession);
  2001. }
  2002. },
  2003. error => {
  2004. GlobalOnErrorHandler.callErrorHandler(error);
  2005. logger.error('Failed to accept incoming Jingle session', error);
  2006. },
  2007. localTracks
  2008. );
  2009. // Enable or disable simulcast for plan-b screensharing based on the capture fps if it is set through the UI.
  2010. this._desktopSharingFrameRate
  2011. && jingleSession.peerconnection.setDesktopSharingFrameRate(this._desktopSharingFrameRate);
  2012. // Start callstats as soon as peerconnection is initialized,
  2013. // do not wait for XMPPEvents.PEERCONNECTION_READY, as it may never
  2014. // happen in case if user doesn't have or denied permission to
  2015. // both camera and microphone.
  2016. logger.info('Starting CallStats for JVB connection...');
  2017. this.statistics.startCallStats(
  2018. this.jvbJingleSession.peerconnection,
  2019. 'jitsi' /* Remote user ID for JVB is 'jitsi' */);
  2020. this.statistics.startRemoteStats(this.jvbJingleSession.peerconnection);
  2021. } catch (e) {
  2022. GlobalOnErrorHandler.callErrorHandler(e);
  2023. logger.error(e);
  2024. }
  2025. };
  2026. /**
  2027. * Sets the BridgeChannel.
  2028. *
  2029. * @param {jQuery} offerIq a jQuery selector pointing to the jingle element of
  2030. * the offer IQ which may carry the WebSocket URL for the 'websocket'
  2031. * BridgeChannel mode.
  2032. * @param {TraceablePeerConnection} pc the peer connection which will be used
  2033. * to listen for new WebRTC Data Channels (in the 'datachannel' mode).
  2034. */
  2035. JitsiConference.prototype._setBridgeChannel = function(offerIq, pc) {
  2036. let wsUrl = null;
  2037. const webSocket
  2038. = $(offerIq)
  2039. .find('>content>transport>web-socket')
  2040. .first();
  2041. if (webSocket.length === 1) {
  2042. wsUrl = webSocket[0].getAttribute('url');
  2043. }
  2044. if (wsUrl) {
  2045. // If the offer contains a websocket use it.
  2046. this.rtc.initializeBridgeChannel(null, wsUrl);
  2047. } else {
  2048. // Otherwise, fall back to an attempt to use SCTP.
  2049. this.rtc.initializeBridgeChannel(pc, null);
  2050. }
  2051. };
  2052. /**
  2053. * Rejects incoming Jingle call.
  2054. * @param {JingleSessionPC} jingleSession the session instance to be rejected.
  2055. * @param {object} [options]
  2056. * @param {string} options.reason the name of the reason element as defined
  2057. * by Jingle
  2058. * @param {string} options.reasonDescription the reason description which will
  2059. * be included in Jingle 'session-terminate' message.
  2060. * @param {string} options.errorMsg an error message to be logged on global
  2061. * error handler
  2062. * @private
  2063. */
  2064. JitsiConference.prototype._rejectIncomingCall = function(jingleSession, options) {
  2065. if (options?.errorMsg) {
  2066. logger.warn(options.errorMsg);
  2067. }
  2068. // Terminate the jingle session with a reason
  2069. jingleSession.terminate(
  2070. null /* success callback => we don't care */,
  2071. error => {
  2072. logger.warn(
  2073. 'An error occurred while trying to terminate'
  2074. + ' invalid Jingle session', error);
  2075. }, {
  2076. reason: options && options.reason,
  2077. reasonDescription: options && options.reasonDescription,
  2078. sendSessionTerminate: true
  2079. });
  2080. };
  2081. /**
  2082. * Handles the call ended event.
  2083. * XXX is this due to the remote side terminating the Jingle session?
  2084. *
  2085. * @param {JingleSessionPC} jingleSession the jingle session which has been
  2086. * terminated.
  2087. * @param {String} reasonCondition the Jingle reason condition.
  2088. * @param {String|null} reasonText human readable reason text which may provide
  2089. * more details about why the call has been terminated.
  2090. */
  2091. JitsiConference.prototype.onCallEnded = function(jingleSession, reasonCondition, reasonText) {
  2092. logger.info(
  2093. `Call ended: ${reasonCondition} - ${reasonText} P2P ?${
  2094. jingleSession.isP2P}`);
  2095. if (jingleSession === this.jvbJingleSession) {
  2096. this.wasStopped = true;
  2097. Statistics.sendAnalytics(
  2098. createJingleEvent(ACTION_JINGLE_TERMINATE, { p2p: false }));
  2099. // Stop the stats
  2100. if (this.statistics) {
  2101. this.statistics.stopRemoteStats(
  2102. this.jvbJingleSession.peerconnection);
  2103. logger.info('Stopping JVB CallStats');
  2104. this.statistics.stopCallStats(
  2105. this.jvbJingleSession.peerconnection);
  2106. }
  2107. // Current JVB JingleSession is no longer valid, so set it to null
  2108. this.jvbJingleSession = null;
  2109. // Let the RTC service do any cleanups
  2110. this.rtc.onCallEnded();
  2111. } else if (jingleSession === this.p2pJingleSession) {
  2112. const stopOptions = {};
  2113. // It's the responder who decides to enforce JVB mode, so that both
  2114. // initiator and responder are aware if it was intentional.
  2115. if (reasonCondition === 'decline' && reasonText === 'force JVB121') {
  2116. logger.info('In forced JVB 121 mode...');
  2117. Statistics.analytics.addPermanentProperties({ forceJvb121: true });
  2118. } else if (reasonCondition === 'connectivity-error'
  2119. && reasonText === 'ICE FAILED') {
  2120. // It can happen that the other peer detects ICE failed and
  2121. // terminates the session, before we get the event on our side.
  2122. // But we are able to parse the reason and mark it here.
  2123. Statistics.analytics.addPermanentProperties({ p2pFailed: true });
  2124. } else if (reasonCondition === 'success' && reasonText === 'restart') {
  2125. // When we are restarting media sessions we don't want to switch the tracks
  2126. // to the JVB just yet.
  2127. stopOptions.requestRestart = true;
  2128. }
  2129. this._stopP2PSession(stopOptions);
  2130. } else {
  2131. logger.error(
  2132. 'Received onCallEnded for invalid session',
  2133. jingleSession.sid,
  2134. jingleSession.remoteJid,
  2135. reasonCondition,
  2136. reasonText);
  2137. }
  2138. };
  2139. /**
  2140. * Handles the suspend detected event. Leaves the room and fires suspended.
  2141. * @param {JingleSessionPC} jingleSession
  2142. */
  2143. JitsiConference.prototype.onSuspendDetected = function(jingleSession) {
  2144. if (!jingleSession.isP2P) {
  2145. this.leave();
  2146. this.eventEmitter.emit(JitsiConferenceEvents.SUSPEND_DETECTED);
  2147. }
  2148. };
  2149. JitsiConference.prototype.updateDTMFSupport = function() {
  2150. let somebodySupportsDTMF = false;
  2151. const participants = this.getParticipants();
  2152. // check if at least 1 participant supports DTMF
  2153. for (let i = 0; i < participants.length; i += 1) {
  2154. if (participants[i].supportsDTMF()) {
  2155. somebodySupportsDTMF = true;
  2156. break;
  2157. }
  2158. }
  2159. if (somebodySupportsDTMF !== this.somebodySupportsDTMF) {
  2160. this.somebodySupportsDTMF = somebodySupportsDTMF;
  2161. this.eventEmitter.emit(
  2162. JitsiConferenceEvents.DTMF_SUPPORT_CHANGED,
  2163. somebodySupportsDTMF);
  2164. }
  2165. };
  2166. /**
  2167. * Allows to check if there is at least one user in the conference
  2168. * that supports DTMF.
  2169. * @returns {boolean} true if somebody supports DTMF, false otherwise
  2170. */
  2171. JitsiConference.prototype.isDTMFSupported = function() {
  2172. return this.somebodySupportsDTMF;
  2173. };
  2174. /**
  2175. * Returns the local user's ID
  2176. * @return {string} local user's ID
  2177. */
  2178. JitsiConference.prototype.myUserId = function() {
  2179. return (
  2180. this.room && this.room.myroomjid
  2181. ? Strophe.getResourceFromJid(this.room.myroomjid)
  2182. : null);
  2183. };
  2184. JitsiConference.prototype.sendTones = function(tones, duration, pause) {
  2185. const peerConnection = this.getActivePeerConnection();
  2186. if (peerConnection) {
  2187. peerConnection.sendTones(tones, duration, pause);
  2188. } else {
  2189. logger.warn('cannot sendTones: no peer connection');
  2190. }
  2191. };
  2192. /**
  2193. * Starts recording the current conference.
  2194. *
  2195. * @param {Object} options - Configuration for the recording. See
  2196. * {@link Chatroom#startRecording} for more info.
  2197. * @returns {Promise} See {@link Chatroom#startRecording} for more info.
  2198. */
  2199. JitsiConference.prototype.startRecording = function(options) {
  2200. if (this.room) {
  2201. return this.recordingManager.startRecording(options);
  2202. }
  2203. return Promise.reject(new Error('The conference is not created yet!'));
  2204. };
  2205. /**
  2206. * Stop a recording session.
  2207. *
  2208. * @param {string} sessionID - The ID of the recording session that
  2209. * should be stopped.
  2210. * @returns {Promise} See {@link Chatroom#stopRecording} for more info.
  2211. */
  2212. JitsiConference.prototype.stopRecording = function(sessionID) {
  2213. if (this.room) {
  2214. return this.recordingManager.stopRecording(sessionID);
  2215. }
  2216. return Promise.reject(new Error('The conference is not created yet!'));
  2217. };
  2218. /**
  2219. * Returns true if the SIP calls are supported and false otherwise
  2220. */
  2221. JitsiConference.prototype.isSIPCallingSupported = function() {
  2222. if (this.room) {
  2223. return this.room.isSIPCallingSupported();
  2224. }
  2225. return false;
  2226. };
  2227. /**
  2228. * Dials a number.
  2229. * @param number the number
  2230. */
  2231. JitsiConference.prototype.dial = function(number) {
  2232. if (this.room) {
  2233. return this.room.dial(number);
  2234. }
  2235. return new Promise((resolve, reject) => {
  2236. reject(new Error('The conference is not created yet!'));
  2237. });
  2238. };
  2239. /**
  2240. * Hangup an existing call
  2241. */
  2242. JitsiConference.prototype.hangup = function() {
  2243. if (this.room) {
  2244. return this.room.hangup();
  2245. }
  2246. return new Promise((resolve, reject) => {
  2247. reject(new Error('The conference is not created yet!'));
  2248. });
  2249. };
  2250. /**
  2251. * Starts the transcription service.
  2252. */
  2253. JitsiConference.prototype.startTranscriber = function() {
  2254. return this.dial('jitsi_meet_transcribe');
  2255. };
  2256. /**
  2257. * Stops the transcription service.
  2258. */
  2259. JitsiConference.prototype.stopTranscriber = JitsiConference.prototype.hangup;
  2260. /**
  2261. * Returns the phone number for joining the conference.
  2262. */
  2263. JitsiConference.prototype.getPhoneNumber = function() {
  2264. if (this.room) {
  2265. return this.room.getPhoneNumber();
  2266. }
  2267. return null;
  2268. };
  2269. /**
  2270. * Returns the pin for joining the conference with phone.
  2271. */
  2272. JitsiConference.prototype.getPhonePin = function() {
  2273. if (this.room) {
  2274. return this.room.getPhonePin();
  2275. }
  2276. return null;
  2277. };
  2278. /**
  2279. * Returns the meeting unique ID if any.
  2280. *
  2281. * @returns {string|undefined}
  2282. */
  2283. JitsiConference.prototype.getMeetingUniqueId = function() {
  2284. if (this.room) {
  2285. return this.room.getMeetingId();
  2286. }
  2287. };
  2288. /**
  2289. * Will return P2P or JVB <tt>TraceablePeerConnection</tt> depending on
  2290. * which connection is currently active.
  2291. *
  2292. * @return {TraceablePeerConnection|null} null if there isn't any active
  2293. * <tt>TraceablePeerConnection</tt> currently available.
  2294. * @public (FIXME how to make package local ?)
  2295. */
  2296. JitsiConference.prototype.getActivePeerConnection = function() {
  2297. const session = this.isP2PActive() ? this.p2pJingleSession : this.jvbJingleSession;
  2298. return session ? session.peerconnection : null;
  2299. };
  2300. /**
  2301. * Returns the connection state for the current room. Its ice connection state
  2302. * for its session.
  2303. * NOTE that "completed" ICE state which can appear on the P2P connection will
  2304. * be converted to "connected".
  2305. * @return {string|null} ICE state name or <tt>null</tt> if there is no active
  2306. * peer connection at this time.
  2307. */
  2308. JitsiConference.prototype.getConnectionState = function() {
  2309. const peerConnection = this.getActivePeerConnection();
  2310. return peerConnection ? peerConnection.getConnectionState() : null;
  2311. };
  2312. /**
  2313. * Make all new participants mute their audio/video on join.
  2314. * @param policy {Object} object with 2 boolean properties for video and audio:
  2315. * @param {boolean} audio if audio should be muted.
  2316. * @param {boolean} video if video should be muted.
  2317. */
  2318. JitsiConference.prototype.setStartMutedPolicy = function(policy) {
  2319. if (!this.isModerator()) {
  2320. logger.warn(`Failed to set start muted policy, ${this.room ? '' : 'not in a room, '}${
  2321. this.isModerator() ? '' : 'participant is not a moderator'}`);
  2322. return;
  2323. }
  2324. this.startMutedPolicy = policy;
  2325. this.room.addOrReplaceInPresence('startmuted', {
  2326. attributes: {
  2327. audio: policy.audio,
  2328. video: policy.video,
  2329. xmlns: 'http://jitsi.org/jitmeet/start-muted'
  2330. }
  2331. }) && this.room.sendPresence();
  2332. };
  2333. /**
  2334. * Returns current start muted policy
  2335. * @returns {Object} with 2 properties - audio and video.
  2336. */
  2337. JitsiConference.prototype.getStartMutedPolicy = function() {
  2338. return this.startMutedPolicy;
  2339. };
  2340. /**
  2341. * Check if audio is muted on join.
  2342. */
  2343. JitsiConference.prototype.isStartAudioMuted = function() {
  2344. return this.startAudioMuted;
  2345. };
  2346. /**
  2347. * Check if video is muted on join.
  2348. */
  2349. JitsiConference.prototype.isStartVideoMuted = function() {
  2350. return this.startVideoMuted;
  2351. };
  2352. /**
  2353. * Returns measured connectionTimes.
  2354. */
  2355. JitsiConference.prototype.getConnectionTimes = function() {
  2356. return this.room.connectionTimes;
  2357. };
  2358. /**
  2359. * Sets a property for the local participant.
  2360. */
  2361. JitsiConference.prototype.setLocalParticipantProperty = function(name, value) {
  2362. this.sendCommand(`jitsi_participant_${name}`, { value });
  2363. };
  2364. /**
  2365. * Removes a property for the local participant and sends the updated presence.
  2366. */
  2367. JitsiConference.prototype.removeLocalParticipantProperty = function(name) {
  2368. this.removeCommand(`jitsi_participant_${name}`);
  2369. this.room.sendPresence();
  2370. };
  2371. /**
  2372. * Gets a local participant property.
  2373. *
  2374. * @return value of the local participant property if the tagName exists in the
  2375. * list of properties, otherwise returns undefined.
  2376. */
  2377. JitsiConference.prototype.getLocalParticipantProperty = function(name) {
  2378. const property = this.room.presMap.nodes.find(prop =>
  2379. prop.tagName === `jitsi_participant_${name}`
  2380. );
  2381. return property ? property.value : undefined;
  2382. };
  2383. /**
  2384. * Sends the given feedback through CallStats if enabled.
  2385. *
  2386. * @param overallFeedback an integer between 1 and 5 indicating the
  2387. * user feedback
  2388. * @param detailedFeedback detailed feedback from the user. Not yet used
  2389. * @returns {Promise} Resolves if feedback is submitted successfully.
  2390. */
  2391. JitsiConference.prototype.sendFeedback = function(overallFeedback, detailedFeedback) {
  2392. return this.statistics.sendFeedback(overallFeedback, detailedFeedback);
  2393. };
  2394. /**
  2395. * Returns true if the callstats integration is enabled, otherwise returns
  2396. * false.
  2397. *
  2398. * @returns true if the callstats integration is enabled, otherwise returns
  2399. * false.
  2400. */
  2401. JitsiConference.prototype.isCallstatsEnabled = function() {
  2402. return this.statistics.isCallstatsEnabled();
  2403. };
  2404. /**
  2405. * Finds the SSRC of a given track
  2406. *
  2407. * @param track
  2408. * @returns {number|undefined} the SSRC of the specificed track, otherwise undefined.
  2409. */
  2410. JitsiConference.prototype.getSsrcByTrack = function(track) {
  2411. return track.isLocal() ? this.getActivePeerConnection()?.getLocalSSRC(track) : track.getSSRC();
  2412. };
  2413. /**
  2414. * Handles track attached to container (Calls associateStreamWithVideoTag method
  2415. * from statistics module)
  2416. * @param {JitsiLocalTrack|JitsiRemoteTrack} track the track
  2417. * @param container the container
  2418. */
  2419. JitsiConference.prototype._onTrackAttach = function(track, container) {
  2420. const isLocal = track.isLocal();
  2421. let ssrc = null;
  2422. const isP2P = track.isP2P;
  2423. const remoteUserId = isP2P ? track.getParticipantId() : 'jitsi';
  2424. const peerConnection
  2425. = isP2P
  2426. ? this.p2pJingleSession && this.p2pJingleSession.peerconnection
  2427. : this.jvbJingleSession && this.jvbJingleSession.peerconnection;
  2428. if (isLocal) {
  2429. // Local tracks have SSRC stored on per peer connection basis.
  2430. if (peerConnection) {
  2431. ssrc = peerConnection.getLocalSSRC(track);
  2432. }
  2433. } else {
  2434. ssrc = track.getSSRC();
  2435. }
  2436. if (!container.id || !ssrc || !peerConnection) {
  2437. return;
  2438. }
  2439. this.statistics.associateStreamWithVideoTag(
  2440. peerConnection,
  2441. ssrc,
  2442. isLocal,
  2443. remoteUserId,
  2444. track.getUsageLabel(),
  2445. container.id);
  2446. };
  2447. /**
  2448. * Logs an "application log" message.
  2449. * @param message {string} The message to log. Note that while this can be a
  2450. * generic string, the convention used by lib-jitsi-meet and jitsi-meet is to
  2451. * log valid JSON strings, with an "id" field used for distinguishing between
  2452. * message types. E.g.: {id: "recorder_status", status: "off"}
  2453. */
  2454. JitsiConference.prototype.sendApplicationLog = function(message) {
  2455. Statistics.sendLog(message);
  2456. };
  2457. /**
  2458. * Checks if the user identified by given <tt>mucJid</tt> is the conference focus.
  2459. * @param mucJid the full MUC address of the user to be checked.
  2460. * @returns {boolean|null} <tt>true</tt> if MUC user is the conference focus,
  2461. * <tt>false</tt> when is not. <tt>null</tt> if we're not in the MUC anymore and
  2462. * are unable to figure out the status or if given <tt>mucJid</tt> is invalid.
  2463. */
  2464. JitsiConference.prototype.isFocus = function(mucJid) {
  2465. return this.room ? this.room.isFocus(mucJid) : null;
  2466. };
  2467. /**
  2468. * Fires CONFERENCE_FAILED event with INCOMPATIBLE_SERVER_VERSIONS parameter
  2469. */
  2470. JitsiConference.prototype._fireIncompatibleVersionsEvent = function() {
  2471. this.eventEmitter.emit(JitsiConferenceEvents.CONFERENCE_FAILED,
  2472. JitsiConferenceErrors.INCOMPATIBLE_SERVER_VERSIONS);
  2473. };
  2474. /**
  2475. * Sends a message via the data channel.
  2476. * @param to {string} the id of the endpoint that should receive the message.
  2477. * If "" the message will be sent to all participants.
  2478. * @param payload {object} the payload of the message.
  2479. * @throws NetworkError or InvalidStateError or Error if the operation fails.
  2480. * @deprecated Use 'sendMessage' instead. TODO: this should be private.
  2481. */
  2482. JitsiConference.prototype.sendEndpointMessage = function(to, payload) {
  2483. this.rtc.sendChannelMessage(to, payload);
  2484. };
  2485. /**
  2486. * Sends local stats via the bridge channel which then forwards to other endpoints selectively.
  2487. * @param {Object} payload The payload of the message.
  2488. * @throws NetworkError/InvalidStateError/Error if the operation fails or if there is no data channel created.
  2489. */
  2490. JitsiConference.prototype.sendEndpointStatsMessage = function(payload) {
  2491. this.rtc.sendEndpointStatsMessage(payload);
  2492. };
  2493. /**
  2494. * Sends a broadcast message via the data channel.
  2495. * @param payload {object} the payload of the message.
  2496. * @throws NetworkError or InvalidStateError or Error if the operation fails.
  2497. * @deprecated Use 'sendMessage' instead. TODO: this should be private.
  2498. */
  2499. JitsiConference.prototype.broadcastEndpointMessage = function(payload) {
  2500. this.sendEndpointMessage('', payload);
  2501. };
  2502. /**
  2503. * Sends a message to a given endpoint (if 'to' is a non-empty string), or
  2504. * broadcasts it to all endpoints in the conference.
  2505. * @param {string} to The ID of the endpoint/participant which is to receive
  2506. * the message, or '' to broadcast the message to all endpoints in the
  2507. * conference.
  2508. * @param {string|object} message the message to send. If this is of type
  2509. * 'string' it will be sent as a chat message. If it is of type 'object', it
  2510. * will be encapsulated in a format recognized by jitsi-meet and converted to
  2511. * JSON before being sent.
  2512. * @param {boolean} sendThroughVideobridge Whether to send the message through
  2513. * jitsi-videobridge (via the COLIBRI data channel or web socket), or through
  2514. * the XMPP MUC. Currently only objects can be sent through jitsi-videobridge.
  2515. */
  2516. JitsiConference.prototype.sendMessage = function(message, to = '', sendThroughVideobridge = false) {
  2517. const messageType = typeof message;
  2518. // Through videobridge we support only objects. Through XMPP we support
  2519. // objects (encapsulated in a specific JSON format) and strings (i.e.
  2520. // regular chat messages).
  2521. if (messageType !== 'object'
  2522. && (sendThroughVideobridge || messageType !== 'string')) {
  2523. logger.error(`Can not send a message of type ${messageType}`);
  2524. return;
  2525. }
  2526. if (sendThroughVideobridge) {
  2527. this.sendEndpointMessage(to, message);
  2528. } else {
  2529. let messageToSend = message;
  2530. // Name of packet extension of message stanza to send the required
  2531. // message in.
  2532. let elementName = 'body';
  2533. if (messageType === 'object') {
  2534. elementName = 'json-message';
  2535. // Mark as valid JSON message if not already
  2536. if (!messageToSend.hasOwnProperty(JITSI_MEET_MUC_TYPE)) {
  2537. messageToSend[JITSI_MEET_MUC_TYPE] = '';
  2538. }
  2539. try {
  2540. messageToSend = JSON.stringify(messageToSend);
  2541. } catch (e) {
  2542. logger.error('Can not send a message, stringify failed: ', e);
  2543. return;
  2544. }
  2545. }
  2546. if (to) {
  2547. this.sendPrivateTextMessage(to, messageToSend, elementName);
  2548. } else {
  2549. // Broadcast
  2550. this.sendTextMessage(messageToSend, elementName);
  2551. }
  2552. }
  2553. };
  2554. JitsiConference.prototype.isConnectionInterrupted = function() {
  2555. return this.isP2PActive()
  2556. ? this.isP2PConnectionInterrupted : this.isJvbConnectionInterrupted;
  2557. };
  2558. /**
  2559. * Handles {@link XMPPEvents.CONNECTION_RESTARTED} event. This happens when the bridge goes down
  2560. * and Jicofo moves conferences away to a different bridge.
  2561. * @param {JingleSessionPC} session
  2562. * @private
  2563. */
  2564. JitsiConference.prototype._onConferenceRestarted = function(session) {
  2565. if (!session.isP2P && this.options.config.enableForcedReload) {
  2566. this.eventEmitter.emit(JitsiConferenceEvents.CONFERENCE_FAILED, JitsiConferenceErrors.CONFERENCE_RESTARTED);
  2567. }
  2568. };
  2569. /**
  2570. * Handles {@link XMPPEvents.CONNECTION_INTERRUPTED}
  2571. * @param {JingleSessionPC} session
  2572. * @private
  2573. */
  2574. JitsiConference.prototype._onIceConnectionInterrupted = function(session) {
  2575. if (session.isP2P) {
  2576. this.isP2PConnectionInterrupted = true;
  2577. } else {
  2578. this.isJvbConnectionInterrupted = true;
  2579. }
  2580. if (session.isP2P === this.isP2PActive()) {
  2581. this.eventEmitter.emit(JitsiConferenceEvents.CONNECTION_INTERRUPTED);
  2582. }
  2583. };
  2584. /**
  2585. * Handles {@link XMPPEvents.CONNECTION_ICE_FAILED}
  2586. * @param {JingleSessionPC} session
  2587. * @private
  2588. */
  2589. JitsiConference.prototype._onIceConnectionFailed = function(session) {
  2590. // We do nothing for the JVB connection, because it's up to the Jicofo to
  2591. // eventually come up with the new offer (at least for the time being).
  2592. if (session.isP2P) {
  2593. // Add p2pFailed property to analytics to distinguish, between "good"
  2594. // and "bad" connection
  2595. Statistics.analytics.addPermanentProperties({ p2pFailed: true });
  2596. if (this.p2pJingleSession) {
  2597. Statistics.sendAnalyticsAndLog(
  2598. createP2PEvent(
  2599. ACTION_P2P_FAILED,
  2600. {
  2601. initiator: this.p2pJingleSession.isInitiator
  2602. }));
  2603. }
  2604. this._stopP2PSession({
  2605. reason: 'connectivity-error',
  2606. reasonDescription: 'ICE FAILED'
  2607. });
  2608. } else if (session && this.jvbJingleSession === session) {
  2609. this._delayedIceFailed = new IceFailedHandling(this);
  2610. this._delayedIceFailed.start(session);
  2611. }
  2612. };
  2613. /**
  2614. * Handles {@link XMPPEvents.CONNECTION_RESTORED}
  2615. * @param {JingleSessionPC} session
  2616. * @private
  2617. */
  2618. JitsiConference.prototype._onIceConnectionRestored = function(session) {
  2619. if (session.isP2P) {
  2620. this.isP2PConnectionInterrupted = false;
  2621. } else {
  2622. this.isJvbConnectionInterrupted = false;
  2623. this._delayedIceFailed && this._delayedIceFailed.cancel();
  2624. }
  2625. if (session.isP2P === this.isP2PActive()) {
  2626. this.eventEmitter.emit(JitsiConferenceEvents.CONNECTION_RESTORED);
  2627. }
  2628. };
  2629. /**
  2630. * Accept incoming P2P Jingle call.
  2631. * @param {JingleSessionPC} jingleSession the session instance
  2632. * @param {jQuery} jingleOffer a jQuery selector pointing to 'jingle' IQ element
  2633. * @private
  2634. */
  2635. JitsiConference.prototype._acceptP2PIncomingCall = function(jingleSession, jingleOffer) {
  2636. this.isP2PConnectionInterrupted = false;
  2637. // Accept the offer
  2638. this.p2pJingleSession = jingleSession;
  2639. this._sendConferenceJoinAnalyticsEvent();
  2640. this.p2pJingleSession.initialize(
  2641. this.room,
  2642. this.rtc,
  2643. this._signalingLayer,
  2644. {
  2645. ...this.options.config,
  2646. enableInsertableStreams: this.isE2EEEnabled()
  2647. });
  2648. logger.info('Starting CallStats for P2P connection...');
  2649. let remoteID = Strophe.getResourceFromJid(this.p2pJingleSession.remoteJid);
  2650. const participant = this.participants[remoteID];
  2651. if (participant) {
  2652. remoteID = participant.getStatsID() || remoteID;
  2653. }
  2654. this.statistics.startCallStats(
  2655. this.p2pJingleSession.peerconnection,
  2656. remoteID);
  2657. const localTracks = this.getLocalTracks();
  2658. this.p2pJingleSession.acceptOffer(
  2659. jingleOffer,
  2660. () => {
  2661. logger.debug('Got RESULT for P2P "session-accept"');
  2662. this.eventEmitter.emit(
  2663. JitsiConferenceEvents._MEDIA_SESSION_STARTED,
  2664. jingleSession);
  2665. },
  2666. error => {
  2667. logger.error(
  2668. 'Failed to accept incoming P2P Jingle session', error);
  2669. },
  2670. localTracks);
  2671. };
  2672. /**
  2673. * Adds remote tracks to the conference associated with the JVB session.
  2674. * @private
  2675. */
  2676. JitsiConference.prototype._addRemoteJVBTracks = function() {
  2677. this._addRemoteTracks('JVB', this.jvbJingleSession.peerconnection.getRemoteTracks());
  2678. };
  2679. /**
  2680. * Adds remote tracks to the conference associated with the P2P session.
  2681. * @private
  2682. */
  2683. JitsiConference.prototype._addRemoteP2PTracks = function() {
  2684. this._addRemoteTracks('P2P', this.p2pJingleSession.peerconnection.getRemoteTracks());
  2685. };
  2686. /**
  2687. * Generates fake "remote track added" events for given Jingle session.
  2688. * @param {string} logName the session's nickname which will appear in log
  2689. * messages.
  2690. * @param {Array<JitsiRemoteTrack>} remoteTracks the tracks that will be added
  2691. * @private
  2692. */
  2693. JitsiConference.prototype._addRemoteTracks = function(logName, remoteTracks) {
  2694. for (const track of remoteTracks) {
  2695. logger.info(`Adding remote ${logName} track: ${track}`);
  2696. this.onRemoteTrackAdded(track);
  2697. }
  2698. };
  2699. /**
  2700. * Called when {@link XMPPEvents.CONNECTION_ESTABLISHED} event is
  2701. * triggered for a {@link JingleSessionPC}. Switches the conference to use
  2702. * the P2P connection if the event comes from the P2P session.
  2703. * @param {JingleSessionPC} jingleSession the session instance.
  2704. * @private
  2705. */
  2706. JitsiConference.prototype._onIceConnectionEstablished = function(jingleSession) {
  2707. if (this.p2pJingleSession !== null) {
  2708. // store the establishment time of the p2p session as a field of the
  2709. // JitsiConference because the p2pJingleSession might get disposed (thus
  2710. // the value is lost).
  2711. this.p2pEstablishmentDuration
  2712. = this.p2pJingleSession.establishmentDuration;
  2713. }
  2714. if (this.jvbJingleSession !== null) {
  2715. this.jvbEstablishmentDuration
  2716. = this.jvbJingleSession.establishmentDuration;
  2717. }
  2718. let done = false;
  2719. const forceJVB121Ratio = this.options.config.forceJVB121Ratio;
  2720. // We don't care about the JVB case, there's nothing to be done
  2721. if (!jingleSession.isP2P) {
  2722. done = true;
  2723. } else if (this.p2pJingleSession !== jingleSession) {
  2724. logger.error('CONNECTION_ESTABLISHED - wrong P2P session instance ?!');
  2725. done = true;
  2726. } else if (!jingleSession.isInitiator
  2727. && typeof forceJVB121Ratio === 'number'
  2728. && Math.random() < forceJVB121Ratio) {
  2729. logger.info(`Forcing JVB 121 mode (ratio=${forceJVB121Ratio})...`);
  2730. Statistics.analytics.addPermanentProperties({ forceJvb121: true });
  2731. this._stopP2PSession({
  2732. reason: 'decline',
  2733. reasonDescription: 'force JVB121'
  2734. });
  2735. done = true;
  2736. }
  2737. if (!isNaN(this.p2pEstablishmentDuration)
  2738. && !isNaN(this.jvbEstablishmentDuration)) {
  2739. const establishmentDurationDiff
  2740. = this.p2pEstablishmentDuration - this.jvbEstablishmentDuration;
  2741. Statistics.sendAnalytics(
  2742. ICE_ESTABLISHMENT_DURATION_DIFF,
  2743. { value: establishmentDurationDiff });
  2744. }
  2745. if (jingleSession.isP2P === this.isP2PActive()) {
  2746. this.eventEmitter.emit(JitsiConferenceEvents.CONNECTION_ESTABLISHED);
  2747. }
  2748. if (done) {
  2749. return;
  2750. }
  2751. // Update P2P status and emit events
  2752. this._setP2PStatus(true);
  2753. // Remove remote tracks
  2754. if (this.jvbJingleSession) {
  2755. this._removeRemoteJVBTracks();
  2756. } else {
  2757. logger.info('Not removing remote JVB tracks - no session yet');
  2758. }
  2759. this._addRemoteP2PTracks();
  2760. // Stop media transfer over the JVB connection
  2761. if (this.jvbJingleSession) {
  2762. this._suspendMediaTransferForJvbConnection();
  2763. }
  2764. logger.info('Starting remote stats with p2p connection');
  2765. this.statistics.startRemoteStats(this.p2pJingleSession.peerconnection);
  2766. Statistics.sendAnalyticsAndLog(
  2767. createP2PEvent(
  2768. ACTION_P2P_ESTABLISHED,
  2769. {
  2770. initiator: this.p2pJingleSession.isInitiator
  2771. }));
  2772. };
  2773. /**
  2774. * Called when the chat room reads a new list of properties from jicofo's
  2775. * presence. The properties may have changed, but they don't have to.
  2776. *
  2777. * @param {Object} properties - The properties keyed by the property name
  2778. * ('key').
  2779. * @private
  2780. */
  2781. JitsiConference.prototype._updateProperties = function(properties = {}) {
  2782. const changed = !isEqual(properties, this.properties);
  2783. this.properties = properties;
  2784. if (changed) {
  2785. this.eventEmitter.emit(JitsiConferenceEvents.PROPERTIES_CHANGED, this.properties);
  2786. const audioLimitReached = this.properties['audio-limit-reached'] === 'true';
  2787. const videoLimitReached = this.properties['video-limit-reached'] === 'true';
  2788. if (this._audioSenderLimitReached !== audioLimitReached) {
  2789. this._audioSenderLimitReached = audioLimitReached;
  2790. this.eventEmitter.emit(JitsiConferenceEvents.AUDIO_UNMUTE_PERMISSIONS_CHANGED, audioLimitReached);
  2791. logger.info(`Audio unmute permissions set by Jicofo to ${audioLimitReached}`);
  2792. }
  2793. if (this._videoSenderLimitReached !== videoLimitReached) {
  2794. this._videoSenderLimitReached = videoLimitReached;
  2795. this.eventEmitter.emit(JitsiConferenceEvents.VIDEO_UNMUTE_PERMISSIONS_CHANGED, videoLimitReached);
  2796. logger.info(`Video unmute permissions set by Jicofo to ${videoLimitReached}`);
  2797. }
  2798. // Some of the properties need to be added to analytics events.
  2799. const analyticsKeys = [
  2800. // The number of jitsi-videobridge instances currently used for the
  2801. // conference.
  2802. 'bridge-count',
  2803. // The conference creation time (set by jicofo).
  2804. 'created-ms'
  2805. ];
  2806. analyticsKeys.forEach(key => {
  2807. if (properties[key] !== undefined) {
  2808. Statistics.analytics.addPermanentProperties({
  2809. [key.replace('-', '_')]: properties[key]
  2810. });
  2811. }
  2812. });
  2813. }
  2814. };
  2815. /**
  2816. * Gets a conference property with a given key.
  2817. *
  2818. * @param {string} key - The key.
  2819. * @returns {*} The value
  2820. */
  2821. JitsiConference.prototype.getProperty = function(key) {
  2822. return this.properties[key];
  2823. };
  2824. /**
  2825. * Clears the deferred start P2P task if it has been scheduled.
  2826. * @private
  2827. */
  2828. JitsiConference.prototype._maybeClearDeferredStartP2P = function() {
  2829. if (this.deferredStartP2PTask) {
  2830. logger.info('Cleared deferred start P2P task');
  2831. clearTimeout(this.deferredStartP2PTask);
  2832. this.deferredStartP2PTask = null;
  2833. }
  2834. };
  2835. /**
  2836. * Removes from the conference remote tracks associated with the JVB
  2837. * connection.
  2838. * @private
  2839. */
  2840. JitsiConference.prototype._removeRemoteJVBTracks = function() {
  2841. this._removeRemoteTracks(
  2842. 'JVB', this.jvbJingleSession.peerconnection.getRemoteTracks());
  2843. };
  2844. /**
  2845. * Removes from the conference remote tracks associated with the P2P
  2846. * connection.
  2847. * @private
  2848. */
  2849. JitsiConference.prototype._removeRemoteP2PTracks = function() {
  2850. this._removeRemoteTracks(
  2851. 'P2P', this.p2pJingleSession.peerconnection.getRemoteTracks());
  2852. };
  2853. /**
  2854. * Generates fake "remote track removed" events for given Jingle session.
  2855. * @param {string} sessionNickname the session's nickname which will appear in
  2856. * log messages.
  2857. * @param {Array<JitsiRemoteTrack>} remoteTracks the tracks that will be removed
  2858. * @private
  2859. */
  2860. JitsiConference.prototype._removeRemoteTracks = function(sessionNickname, remoteTracks) {
  2861. for (const track of remoteTracks) {
  2862. logger.info(`Removing remote ${sessionNickname} track: ${track}`);
  2863. this.onRemoteTrackRemoved(track);
  2864. }
  2865. };
  2866. /**
  2867. * Resumes media transfer over the JVB connection.
  2868. * @private
  2869. */
  2870. JitsiConference.prototype._resumeMediaTransferForJvbConnection = function() {
  2871. logger.info('Resuming media transfer over the JVB connection...');
  2872. this.jvbJingleSession.setMediaTransferActive(true, true).then(
  2873. () => {
  2874. logger.info('Resumed media transfer over the JVB connection!');
  2875. },
  2876. error => {
  2877. logger.error(
  2878. 'Failed to resume media transfer over the JVB connection:',
  2879. error);
  2880. });
  2881. };
  2882. /**
  2883. * Sets new P2P status and updates some events/states hijacked from
  2884. * the <tt>JitsiConference</tt>.
  2885. * @param {boolean} newStatus the new P2P status value, <tt>true</tt> means that
  2886. * P2P is now in use, <tt>false</tt> means that the JVB connection is now in use
  2887. * @private
  2888. */
  2889. JitsiConference.prototype._setP2PStatus = function(newStatus) {
  2890. if (this.p2p === newStatus) {
  2891. logger.debug(`Called _setP2PStatus with the same status: ${newStatus}`);
  2892. return;
  2893. }
  2894. this.p2p = newStatus;
  2895. if (newStatus) {
  2896. logger.info('Peer to peer connection established!');
  2897. // When we end up in a valid P2P session need to reset the properties
  2898. // in case they have persisted, after session with another peer.
  2899. Statistics.analytics.addPermanentProperties({
  2900. p2pFailed: false,
  2901. forceJvb121: false
  2902. });
  2903. // Sync up video transfer active in case p2pJingleSession not existed
  2904. // when the lastN value was being adjusted.
  2905. const isVideoActive = this.getLastN() !== 0;
  2906. this.p2pJingleSession
  2907. .setMediaTransferActive(true, isVideoActive)
  2908. .catch(error => {
  2909. logger.error(
  2910. 'Failed to sync up P2P video transfer status'
  2911. + `(${isVideoActive})`, error);
  2912. });
  2913. } else {
  2914. logger.info('Peer to peer connection closed!');
  2915. }
  2916. // Put the JVB connection on hold/resume
  2917. if (this.jvbJingleSession) {
  2918. this.statistics.sendConnectionResumeOrHoldEvent(
  2919. this.jvbJingleSession.peerconnection, !newStatus);
  2920. }
  2921. // Clear dtmfManager, so that it can be recreated with new connection
  2922. this.dtmfManager = null;
  2923. // Update P2P status
  2924. this.eventEmitter.emit(
  2925. JitsiConferenceEvents.P2P_STATUS,
  2926. this,
  2927. this.p2p);
  2928. this.eventEmitter.emit(JitsiConferenceEvents._MEDIA_SESSION_ACTIVE_CHANGED, this.getActiveMediaSession());
  2929. // Refresh connection interrupted/restored
  2930. this.eventEmitter.emit(
  2931. this.isConnectionInterrupted()
  2932. ? JitsiConferenceEvents.CONNECTION_INTERRUPTED
  2933. : JitsiConferenceEvents.CONNECTION_RESTORED);
  2934. };
  2935. /**
  2936. * Starts new P2P session.
  2937. * @param {string} remoteJid the JID of the remote participant
  2938. * @private
  2939. */
  2940. JitsiConference.prototype._startP2PSession = function(remoteJid) {
  2941. this._maybeClearDeferredStartP2P();
  2942. if (this.p2pJingleSession) {
  2943. logger.error('P2P session already started!');
  2944. return;
  2945. }
  2946. this.isP2PConnectionInterrupted = false;
  2947. this.p2pJingleSession
  2948. = this.xmpp.connection.jingle.newP2PJingleSession(
  2949. this.room.myroomjid,
  2950. remoteJid);
  2951. logger.info(
  2952. 'Created new P2P JingleSession', this.room.myroomjid, remoteJid);
  2953. this._sendConferenceJoinAnalyticsEvent();
  2954. this.p2pJingleSession.initialize(
  2955. this.room,
  2956. this.rtc,
  2957. this._signalingLayer,
  2958. {
  2959. ...this.options.config,
  2960. enableInsertableStreams: this.isE2EEEnabled()
  2961. });
  2962. logger.info('Starting CallStats for P2P connection...');
  2963. let remoteID = Strophe.getResourceFromJid(this.p2pJingleSession.remoteJid);
  2964. const participant = this.participants[remoteID];
  2965. if (participant) {
  2966. remoteID = participant.getStatsID() || remoteID;
  2967. }
  2968. this.statistics.startCallStats(
  2969. this.p2pJingleSession.peerconnection,
  2970. remoteID);
  2971. const localTracks = this.getLocalTracks();
  2972. this.p2pJingleSession.invite(localTracks);
  2973. };
  2974. /**
  2975. * Suspends media transfer over the JVB connection.
  2976. * @private
  2977. */
  2978. JitsiConference.prototype._suspendMediaTransferForJvbConnection = function() {
  2979. logger.info('Suspending media transfer over the JVB connection...');
  2980. this.jvbJingleSession.setMediaTransferActive(false, false).then(
  2981. () => {
  2982. logger.info('Suspended media transfer over the JVB connection !');
  2983. },
  2984. error => {
  2985. logger.error(
  2986. 'Failed to suspend media transfer over the JVB connection:',
  2987. error);
  2988. });
  2989. };
  2990. /**
  2991. * Method when called will decide whether it's the time to start or stop
  2992. * the P2P session.
  2993. * @param {boolean} userLeftEvent if <tt>true</tt> it means that the call
  2994. * originates from the user left event.
  2995. * @private
  2996. */
  2997. JitsiConference.prototype._maybeStartOrStopP2P = function(userLeftEvent) {
  2998. if (!this.isP2PEnabled()
  2999. || this.isP2PTestModeEnabled()
  3000. || browser.isFirefox()
  3001. || browser.isWebKitBased()
  3002. || this.isE2EEEnabled()) {
  3003. logger.info('Auto P2P disabled');
  3004. return;
  3005. }
  3006. const peers = this.getParticipants();
  3007. const peerCount = peers.length;
  3008. // FIXME 1 peer and it must *support* P2P switching
  3009. const shouldBeInP2P = this._shouldBeInP2PMode();
  3010. // Clear deferred "start P2P" task
  3011. if (!shouldBeInP2P && this.deferredStartP2PTask) {
  3012. this._maybeClearDeferredStartP2P();
  3013. }
  3014. // Start peer to peer session
  3015. if (!this.p2pJingleSession && shouldBeInP2P) {
  3016. const peer = peerCount && peers[0];
  3017. const myId = this.myUserId();
  3018. const peersId = peer.getId();
  3019. if (myId > peersId) {
  3020. logger.debug(
  3021. 'I\'m the bigger peersId - '
  3022. + 'the other peer should start P2P', myId, peersId);
  3023. return;
  3024. } else if (myId === peersId) {
  3025. logger.error('The same IDs ? ', myId, peersId);
  3026. return;
  3027. }
  3028. const jid = peer.getJid();
  3029. if (userLeftEvent) {
  3030. if (this.deferredStartP2PTask) {
  3031. logger.error('Deferred start P2P task\'s been set already!');
  3032. return;
  3033. }
  3034. logger.info(
  3035. `Will start P2P with: ${jid} after ${
  3036. this.backToP2PDelay} seconds...`);
  3037. this.deferredStartP2PTask = setTimeout(
  3038. this._startP2PSession.bind(this, jid),
  3039. this.backToP2PDelay * 1000);
  3040. } else {
  3041. logger.info(`Will start P2P with: ${jid}`);
  3042. this._startP2PSession(jid);
  3043. }
  3044. } else if (this.p2pJingleSession && !shouldBeInP2P) {
  3045. logger.info(`Will stop P2P with: ${this.p2pJingleSession.remoteJid}`);
  3046. // Log that there will be a switch back to the JVB connection
  3047. if (this.p2pJingleSession.isInitiator && peerCount > 1) {
  3048. Statistics.sendAnalyticsAndLog(
  3049. createP2PEvent(ACTION_P2P_SWITCH_TO_JVB));
  3050. }
  3051. this._stopP2PSession();
  3052. }
  3053. };
  3054. /**
  3055. * Tells whether or not this conference should be currently in the P2P mode.
  3056. *
  3057. * @private
  3058. * @returns {boolean}
  3059. */
  3060. JitsiConference.prototype._shouldBeInP2PMode = function() {
  3061. const peers = this.getParticipants();
  3062. const peerCount = peers.length;
  3063. const hasBotPeer = peers.find(p => p.getBotType() === 'poltergeist' || p.hasFeature(FEATURE_JIGASI)) !== undefined;
  3064. const shouldBeInP2P = peerCount === 1 && !hasBotPeer;
  3065. logger.debug(`P2P? peerCount: ${peerCount}, hasBotPeer: ${hasBotPeer} => ${shouldBeInP2P}`);
  3066. return shouldBeInP2P;
  3067. };
  3068. /**
  3069. * Stops the current P2P session.
  3070. * @param {Object} options - Options for stopping P2P.
  3071. * @param {string} options.reason - One of the Jingle "reason" element
  3072. * names as defined by https://xmpp.org/extensions/xep-0166.html#def-reason
  3073. * @param {string} options.reasonDescription - Text
  3074. * description that will be included in the session terminate message
  3075. * @param {boolean} requestRestart - Whether this is due to a session restart, in which case
  3076. * media will not be resumed on the JVB.
  3077. * @private
  3078. */
  3079. JitsiConference.prototype._stopP2PSession = function(options = {}) {
  3080. const {
  3081. reason = 'success',
  3082. reasonDescription = 'Turning off P2P session',
  3083. requestRestart = false
  3084. } = options;
  3085. if (!this.p2pJingleSession) {
  3086. logger.error('No P2P session to be stopped!');
  3087. return;
  3088. }
  3089. const wasP2PEstablished = this.isP2PActive();
  3090. // Swap remote tracks, but only if the P2P has been fully established
  3091. if (wasP2PEstablished) {
  3092. if (this.jvbJingleSession && !requestRestart) {
  3093. this._resumeMediaTransferForJvbConnection();
  3094. }
  3095. // Remove remote P2P tracks
  3096. this._removeRemoteP2PTracks();
  3097. }
  3098. // Stop P2P stats
  3099. logger.info('Stopping remote stats for P2P connection');
  3100. this.statistics.stopRemoteStats(this.p2pJingleSession.peerconnection);
  3101. logger.info('Stopping CallStats for P2P connection');
  3102. this.statistics.stopCallStats(this.p2pJingleSession.peerconnection);
  3103. this.p2pJingleSession.terminate(
  3104. () => {
  3105. logger.info('P2P session terminate RESULT');
  3106. },
  3107. error => {
  3108. // Because both initiator and responder are simultaneously
  3109. // terminating their JingleSessions in case of the 'to JVB switch'
  3110. // when 3rd participant joins, both will dispose their sessions and
  3111. // reply with 'item-not-found' (see strophe.jingle.js). We don't
  3112. // want to log this as an error since it's expected behaviour.
  3113. //
  3114. // We want them both to terminate, because in case of initiator's
  3115. // crash the responder would stay in P2P mode until ICE fails which
  3116. // could take up to 20 seconds.
  3117. //
  3118. // NOTE: whilst this is an error callback, 'success' as a reason is
  3119. // considered as graceful session terminate
  3120. // where both initiator and responder terminate their sessions
  3121. // simultaneously.
  3122. if (reason !== 'success') {
  3123. logger.error('An error occurred while trying to terminate P2P Jingle session', error);
  3124. }
  3125. }, {
  3126. reason,
  3127. reasonDescription,
  3128. sendSessionTerminate: this.room
  3129. && this.getParticipantById(
  3130. Strophe.getResourceFromJid(this.p2pJingleSession.remoteJid))
  3131. });
  3132. this.p2pJingleSession = null;
  3133. // Update P2P status and other affected events/states
  3134. this._setP2PStatus(false);
  3135. if (wasP2PEstablished) {
  3136. // Add back remote JVB tracks
  3137. if (this.jvbJingleSession && !requestRestart) {
  3138. this._addRemoteJVBTracks();
  3139. } else {
  3140. logger.info('Not adding remote JVB tracks - no session yet');
  3141. }
  3142. }
  3143. };
  3144. /**
  3145. * Updates room presence if needed and send the packet in case of a modification.
  3146. * @param {JingleSessionPC} jingleSession the session firing the event, contains the peer connection which
  3147. * tracks we will check.
  3148. * @param {Object|null} ctx a context object we can distinguish multiple calls of the same pass of updating tracks.
  3149. */
  3150. JitsiConference.prototype._updateRoomPresence = function(jingleSession, ctx) {
  3151. if (!jingleSession) {
  3152. return;
  3153. }
  3154. // skips sending presence twice for the same pass of updating ssrcs
  3155. if (ctx) {
  3156. if (ctx.skip) {
  3157. return;
  3158. }
  3159. ctx.skip = true;
  3160. }
  3161. let presenceChanged = false;
  3162. let muteStatusChanged, videoTypeChanged;
  3163. const localTracks = jingleSession.peerconnection.getLocalTracks();
  3164. const localAudioTracks = localTracks.filter(track => track.getType() === MediaType.AUDIO);
  3165. const localVideoTracks = localTracks.filter(track => track.getType() === MediaType.VIDEO);
  3166. // Set presence for all the available local tracks.
  3167. for (const track of localTracks) {
  3168. muteStatusChanged = this._setTrackMuteStatus(track.getType(), track, track.isMuted());
  3169. if (track.getType() === MediaType.VIDEO) {
  3170. videoTypeChanged = this._setNewVideoType(track);
  3171. }
  3172. presenceChanged = presenceChanged || muteStatusChanged || videoTypeChanged;
  3173. }
  3174. // Set the presence in the legacy format if there are no local tracks and multi stream support is not enabled.
  3175. if (!FeatureFlags.isMultiStreamSupportEnabled()) {
  3176. let audioMuteStatusChanged, videoMuteStatusChanged;
  3177. if (!localAudioTracks?.length) {
  3178. audioMuteStatusChanged = this._setTrackMuteStatus(MediaType.AUDIO, undefined, true);
  3179. }
  3180. if (!localVideoTracks?.length) {
  3181. videoMuteStatusChanged = this._setTrackMuteStatus(MediaType.VIDEO, undefined, true);
  3182. videoTypeChanged = this._setNewVideoType();
  3183. }
  3184. presenceChanged = presenceChanged || audioMuteStatusChanged || videoMuteStatusChanged || videoTypeChanged;
  3185. }
  3186. presenceChanged && this.room.sendPresence();
  3187. };
  3188. /**
  3189. * Checks whether or not the conference is currently in the peer to peer mode.
  3190. * Being in peer to peer mode means that the direct connection has been
  3191. * established and the P2P connection is being used for media transmission.
  3192. * @return {boolean} <tt>true</tt> if in P2P mode or <tt>false</tt> otherwise.
  3193. */
  3194. JitsiConference.prototype.isP2PActive = function() {
  3195. return this.p2p;
  3196. };
  3197. /**
  3198. * Returns the current ICE state of the P2P connection.
  3199. * NOTE: method is used by the jitsi-meet-torture tests.
  3200. * @return {string|null} an ICE state or <tt>null</tt> if there's currently
  3201. * no P2P connection.
  3202. */
  3203. JitsiConference.prototype.getP2PConnectionState = function() {
  3204. if (this.isP2PActive()) {
  3205. return this.p2pJingleSession.peerconnection.getConnectionState();
  3206. }
  3207. return null;
  3208. };
  3209. /**
  3210. * Configures the peerconnection so that a given framre rate can be achieved for desktop share.
  3211. *
  3212. * @param {number} maxFps The capture framerate to be used for desktop tracks.
  3213. * @returns {boolean} true if the operation is successful, false otherwise.
  3214. */
  3215. JitsiConference.prototype.setDesktopSharingFrameRate = function(maxFps) {
  3216. if (typeof maxFps !== 'number' || isNaN(maxFps)) {
  3217. logger.error(`Invalid value ${maxFps} specified for desktop capture frame rate`);
  3218. return false;
  3219. }
  3220. this._desktopSharingFrameRate = maxFps;
  3221. // Enable or disable simulcast for plan-b screensharing based on the capture fps.
  3222. this.jvbJingleSession && this.jvbJingleSession.peerconnection.setDesktopSharingFrameRate(maxFps);
  3223. // Set the capture rate for desktop sharing.
  3224. this.rtc.setDesktopSharingFrameRate(maxFps);
  3225. return true;
  3226. };
  3227. /**
  3228. * Manually starts new P2P session (should be used only in the tests).
  3229. */
  3230. JitsiConference.prototype.startP2PSession = function() {
  3231. const peers = this.getParticipants();
  3232. // Start peer to peer session
  3233. if (peers.length === 1) {
  3234. const peerJid = peers[0].getJid();
  3235. this._startP2PSession(peerJid);
  3236. } else {
  3237. throw new Error(
  3238. 'There must be exactly 1 participant to start the P2P session !');
  3239. }
  3240. };
  3241. /**
  3242. * Manually stops the current P2P session (should be used only in the tests).
  3243. */
  3244. JitsiConference.prototype.stopP2PSession = function(options) {
  3245. this._stopP2PSession(options);
  3246. };
  3247. /**
  3248. * Get a summary of how long current participants have been the dominant speaker
  3249. * @returns {object}
  3250. */
  3251. JitsiConference.prototype.getSpeakerStats = function() {
  3252. return this.speakerStatsCollector.getStats();
  3253. };
  3254. /**
  3255. * Sends a face landmarks object to the xmpp server.
  3256. * @param {Object} payload
  3257. */
  3258. JitsiConference.prototype.sendFaceLandmarks = function(payload) {
  3259. if (payload.faceExpression) {
  3260. this.xmpp.sendFaceExpressionEvent(this.room.roomjid, payload);
  3261. }
  3262. };
  3263. /**
  3264. * Sets the constraints for the video that is requested from the bridge.
  3265. *
  3266. * @param {Object} videoConstraints The constraints which are specified in the
  3267. * following format. The message updates the fields that are present and leaves the
  3268. * rest unchanged on the bridge. Therefore, any field that is not applicable anymore
  3269. * should be cleared by passing an empty object or list (whatever is applicable).
  3270. * {
  3271. * 'lastN': 20,
  3272. * 'selectedEndpoints': ['A', 'B', 'C'],
  3273. * 'onStageEndpoints': ['A'],
  3274. * 'defaultConstraints': { 'maxHeight': 180 },
  3275. * 'constraints': {
  3276. * 'A': { 'maxHeight': 720 }
  3277. * }
  3278. * }
  3279. */
  3280. JitsiConference.prototype.setReceiverConstraints = function(videoConstraints) {
  3281. this.receiveVideoController.setReceiverConstraints(videoConstraints);
  3282. };
  3283. /**
  3284. * Sets the maximum video size the local participant should receive from remote
  3285. * participants.
  3286. *
  3287. * @param {number} maxFrameHeight - the maximum frame height, in pixels,
  3288. * this receiver is willing to receive.
  3289. * @returns {void}
  3290. */
  3291. JitsiConference.prototype.setReceiverVideoConstraint = function(maxFrameHeight) {
  3292. this.receiveVideoController.setPreferredReceiveMaxFrameHeight(maxFrameHeight);
  3293. };
  3294. /**
  3295. * Sets the maximum video size the local participant should send to remote
  3296. * participants.
  3297. * @param {number} maxFrameHeight - The user preferred max frame height.
  3298. * @returns {Promise} promise that will be resolved when the operation is
  3299. * successful and rejected otherwise.
  3300. */
  3301. JitsiConference.prototype.setSenderVideoConstraint = function(maxFrameHeight) {
  3302. return this.sendVideoController.setPreferredSendMaxFrameHeight(maxFrameHeight);
  3303. };
  3304. /**
  3305. * Creates a video SIP GW session and returns it if service is enabled. Before
  3306. * creating a session one need to check whether video SIP GW service is
  3307. * available in the system {@link JitsiConference.isVideoSIPGWAvailable}. Even
  3308. * if there are available nodes to serve this request, after creating the
  3309. * session those nodes can be taken and the request about using the
  3310. * created session can fail.
  3311. *
  3312. * @param {string} sipAddress - The sip address to be used.
  3313. * @param {string} displayName - The display name to be used for this session.
  3314. * @returns {JitsiVideoSIPGWSession|Error} Returns null if conference is not
  3315. * initialised and there is no room.
  3316. */
  3317. JitsiConference.prototype.createVideoSIPGWSession = function(sipAddress, displayName) {
  3318. if (!this.room) {
  3319. return new Error(VideoSIPGWConstants.ERROR_NO_CONNECTION);
  3320. }
  3321. return this.videoSIPGWHandler
  3322. .createVideoSIPGWSession(sipAddress, displayName);
  3323. };
  3324. /**
  3325. * Sends a conference.join analytics event.
  3326. *
  3327. * @returns {void}
  3328. */
  3329. JitsiConference.prototype._sendConferenceJoinAnalyticsEvent = function() {
  3330. const meetingId = this.getMeetingUniqueId();
  3331. if (this._conferenceJoinAnalyticsEventSent || !meetingId || this.getActivePeerConnection() === null) {
  3332. return;
  3333. }
  3334. Statistics.sendAnalytics(createConferenceEvent('joined', {
  3335. meetingId,
  3336. participantId: `${meetingId}.${this._statsCurrentId}`
  3337. }));
  3338. this._conferenceJoinAnalyticsEventSent = Date.now();
  3339. };
  3340. /**
  3341. * Sends conference.left analytics event.
  3342. * @private
  3343. */
  3344. JitsiConference.prototype._sendConferenceLeftAnalyticsEvent = function() {
  3345. const meetingId = this.getMeetingUniqueId();
  3346. if (!meetingId || !this._conferenceJoinAnalyticsEventSent) {
  3347. return;
  3348. }
  3349. Statistics.sendAnalytics(createConferenceEvent('left', {
  3350. meetingId,
  3351. participantId: `${meetingId}.${this._statsCurrentId}`,
  3352. stats: {
  3353. duration: Math.floor((Date.now() - this._conferenceJoinAnalyticsEventSent) / 1000),
  3354. perf: this.getPerformanceStats()
  3355. }
  3356. }));
  3357. };
  3358. /**
  3359. * Restarts all active media sessions.
  3360. *
  3361. * @returns {void}
  3362. */
  3363. JitsiConference.prototype._restartMediaSessions = function() {
  3364. if (this.p2pJingleSession) {
  3365. this._stopP2PSession({
  3366. reasonDescription: 'restart',
  3367. requestRestart: true
  3368. });
  3369. }
  3370. if (this.jvbJingleSession) {
  3371. this.jvbJingleSession.terminate(
  3372. null /* success callback => we don't care */,
  3373. error => {
  3374. logger.warn('An error occurred while trying to terminate the JVB session', error);
  3375. }, {
  3376. reason: 'success',
  3377. reasonDescription: 'restart required',
  3378. requestRestart: true,
  3379. sendSessionTerminate: true
  3380. });
  3381. }
  3382. this._maybeStartOrStopP2P(false);
  3383. };
  3384. /**
  3385. * Returns whether End-To-End encryption is enabled.
  3386. *
  3387. * @returns {boolean}
  3388. */
  3389. JitsiConference.prototype.isE2EEEnabled = function() {
  3390. return Boolean(this._e2eEncryption && this._e2eEncryption.isEnabled());
  3391. };
  3392. /**
  3393. * Returns whether End-To-End encryption is supported. Note that not all participants
  3394. * in the conference may support it.
  3395. *
  3396. * @returns {boolean}
  3397. */
  3398. JitsiConference.prototype.isE2EESupported = function() {
  3399. return E2EEncryption.isSupported(this.options.config);
  3400. };
  3401. /**
  3402. * Enables / disables End-to-End encryption.
  3403. *
  3404. * @param {boolean} enabled whether to enable E2EE or not.
  3405. * @returns {void}
  3406. */
  3407. JitsiConference.prototype.toggleE2EE = function(enabled) {
  3408. if (!this.isE2EESupported()) {
  3409. logger.warn('Cannot enable / disable E2EE: platform is not supported.');
  3410. return;
  3411. }
  3412. this._e2eEncryption.setEnabled(enabled);
  3413. };
  3414. /**
  3415. * Sets the key and index for End-to-End encryption.
  3416. *
  3417. * @param {CryptoKey} [keyInfo.encryptionKey] - encryption key.
  3418. * @param {Number} [keyInfo.index] - the index of the encryption key.
  3419. * @returns {void}
  3420. */
  3421. JitsiConference.prototype.setMediaEncryptionKey = function(keyInfo) {
  3422. this._e2eEncryption.setEncryptionKey(keyInfo);
  3423. };
  3424. /**
  3425. * Returns <tt>true</tt> if lobby support is enabled in the backend.
  3426. *
  3427. * @returns {boolean} whether lobby is supported in the backend.
  3428. */
  3429. JitsiConference.prototype.isLobbySupported = function() {
  3430. return Boolean(this.room && this.room.getLobby().isSupported());
  3431. };
  3432. /**
  3433. * Returns <tt>true</tt> if the room has members only enabled.
  3434. *
  3435. * @returns {boolean} whether conference room is members only.
  3436. */
  3437. JitsiConference.prototype.isMembersOnly = function() {
  3438. return Boolean(this.room && this.room.membersOnlyEnabled);
  3439. };
  3440. /**
  3441. * Enables lobby by moderators
  3442. *
  3443. * @returns {Promise} resolves when lobby room is joined or rejects with the error.
  3444. */
  3445. JitsiConference.prototype.enableLobby = function() {
  3446. if (this.room && this.isModerator()) {
  3447. return this.room.getLobby().enable();
  3448. }
  3449. return Promise.reject(
  3450. new Error('The conference not started or user is not moderator'));
  3451. };
  3452. /**
  3453. * Disabled lobby by moderators
  3454. *
  3455. * @returns {void}
  3456. */
  3457. JitsiConference.prototype.disableLobby = function() {
  3458. if (this.room && this.isModerator()) {
  3459. this.room.getLobby().disable();
  3460. } else {
  3461. logger.warn(`Failed to disable lobby, ${this.room ? '' : 'not in a room, '}${
  3462. this.isModerator() ? '' : 'participant is not a moderator'}`);
  3463. }
  3464. };
  3465. /**
  3466. * Joins the lobby room with display name and optional email or with a shared password to skip waiting.
  3467. *
  3468. * @param {string} displayName Display name should be set to show it to moderators.
  3469. * @param {string} email Optional email is used to present avatar to the moderator.
  3470. * @returns {Promise<never>}
  3471. */
  3472. JitsiConference.prototype.joinLobby = function(displayName, email) {
  3473. if (this.room) {
  3474. return this.room.getLobby().join(displayName, email);
  3475. }
  3476. return Promise.reject(new Error('The conference not started'));
  3477. };
  3478. /**
  3479. * Gets the local id for a participant in a lobby room.
  3480. * Returns undefined when current participant is not in the lobby room.
  3481. * This is used for lobby room private chat messages.
  3482. *
  3483. * @returns {string}
  3484. */
  3485. JitsiConference.prototype.myLobbyUserId = function() {
  3486. if (this.room) {
  3487. return this.room.getLobby().getLocalId();
  3488. }
  3489. };
  3490. /**
  3491. * Sends a message to a lobby room.
  3492. * When id is specified it sends a private message.
  3493. * Otherwise it sends the message to all moderators.
  3494. * @param {message} Object The message to send
  3495. * @param {string} id The participant id.
  3496. *
  3497. * @returns {void}
  3498. */
  3499. JitsiConference.prototype.sendLobbyMessage = function(message, id) {
  3500. if (this.room) {
  3501. if (id) {
  3502. return this.room.getLobby().sendPrivateMessage(id, message);
  3503. }
  3504. return this.room.getLobby().sendMessage(message);
  3505. }
  3506. };
  3507. /**
  3508. * Adds a message listener to the lobby room
  3509. * @param {Function} listener The listener function,
  3510. * called when a new message is received in the lobby room.
  3511. *
  3512. * @returns {Function} Handler returned to be able to remove it later.
  3513. */
  3514. JitsiConference.prototype.addLobbyMessageListener = function(listener) {
  3515. if (this.room) {
  3516. return this.room.getLobby().addMessageListener(listener);
  3517. }
  3518. };
  3519. /**
  3520. * Removes a message handler from the lobby room
  3521. * @param {Function} handler The handler function to remove.
  3522. *
  3523. * @returns {void}
  3524. */
  3525. JitsiConference.prototype.removeLobbyMessageHandler = function(handler) {
  3526. if (this.room) {
  3527. return this.room.getLobby().removeMessageHandler(handler);
  3528. }
  3529. };
  3530. /**
  3531. * Denies an occupant in the lobby room access to the conference.
  3532. * @param {string} id The participant id.
  3533. */
  3534. JitsiConference.prototype.lobbyDenyAccess = function(id) {
  3535. if (this.room) {
  3536. this.room.getLobby().denyAccess(id);
  3537. }
  3538. };
  3539. /**
  3540. * Approves the request to join the conference to a participant waiting in the lobby.
  3541. *
  3542. * @param {string} id The participant id.
  3543. */
  3544. JitsiConference.prototype.lobbyApproveAccess = function(id) {
  3545. if (this.room) {
  3546. this.room.getLobby().approveAccess(id);
  3547. }
  3548. };
  3549. /**
  3550. * Returns <tt>true</tt> if AV Moderation support is enabled in the backend.
  3551. *
  3552. * @returns {boolean} whether AV Moderation is supported in the backend.
  3553. */
  3554. JitsiConference.prototype.isAVModerationSupported = function() {
  3555. return Boolean(this.room && this.room.getAVModeration().isSupported());
  3556. };
  3557. /**
  3558. * Enables AV Moderation.
  3559. * @param {MediaType} mediaType "audio" or "video"
  3560. */
  3561. JitsiConference.prototype.enableAVModeration = function(mediaType) {
  3562. if (this.room && this.isModerator()
  3563. && (mediaType === MediaType.AUDIO || mediaType === MediaType.VIDEO)) {
  3564. this.room.getAVModeration().enable(true, mediaType);
  3565. } else {
  3566. logger.warn(`Failed to enable AV moderation, ${this.room ? '' : 'not in a room, '}${
  3567. this.isModerator() ? '' : 'participant is not a moderator, '}${
  3568. this.room && this.isModerator() ? 'wrong media type passed' : ''}`);
  3569. }
  3570. };
  3571. /**
  3572. * Disables AV Moderation.
  3573. * @param {MediaType} mediaType "audio" or "video"
  3574. */
  3575. JitsiConference.prototype.disableAVModeration = function(mediaType) {
  3576. if (this.room && this.isModerator()
  3577. && (mediaType === MediaType.AUDIO || mediaType === MediaType.VIDEO)) {
  3578. this.room.getAVModeration().enable(false, mediaType);
  3579. } else {
  3580. logger.warn(`Failed to disable AV moderation, ${this.room ? '' : 'not in a room, '}${
  3581. this.isModerator() ? '' : 'participant is not a moderator, '}${
  3582. this.room && this.isModerator() ? 'wrong media type passed' : ''}`);
  3583. }
  3584. };
  3585. /**
  3586. * Approve participant access to certain media, allows unmuting audio or video.
  3587. *
  3588. * @param {MediaType} mediaType "audio" or "video"
  3589. * @param id the id of the participant.
  3590. */
  3591. JitsiConference.prototype.avModerationApprove = function(mediaType, id) {
  3592. if (this.room && this.isModerator()
  3593. && (mediaType === MediaType.AUDIO || mediaType === MediaType.VIDEO)) {
  3594. const participant = this.getParticipantById(id);
  3595. if (!participant) {
  3596. return;
  3597. }
  3598. this.room.getAVModeration().approve(mediaType, participant.getJid());
  3599. } else {
  3600. logger.warn(`AV moderation approve skipped , ${this.room ? '' : 'not in a room, '}${
  3601. this.isModerator() ? '' : 'participant is not a moderator, '}${
  3602. this.room && this.isModerator() ? 'wrong media type passed' : ''}`);
  3603. }
  3604. };
  3605. /**
  3606. * Reject participant access to certain media, blocks unmuting audio or video.
  3607. *
  3608. * @param {MediaType} mediaType "audio" or "video"
  3609. * @param id the id of the participant.
  3610. */
  3611. JitsiConference.prototype.avModerationReject = function(mediaType, id) {
  3612. if (this.room && this.isModerator()
  3613. && (mediaType === MediaType.AUDIO || mediaType === MediaType.VIDEO)) {
  3614. const participant = this.getParticipantById(id);
  3615. if (!participant) {
  3616. return;
  3617. }
  3618. this.room.getAVModeration().reject(mediaType, participant.getJid());
  3619. } else {
  3620. logger.warn(`AV moderation reject skipped , ${this.room ? '' : 'not in a room, '}${
  3621. this.isModerator() ? '' : 'participant is not a moderator, '}${
  3622. this.room && this.isModerator() ? 'wrong media type passed' : ''}`);
  3623. }
  3624. };
  3625. /**
  3626. * Returns the breakout rooms manager object.
  3627. *
  3628. * @returns {Object} the breakout rooms manager.
  3629. */
  3630. JitsiConference.prototype.getBreakoutRooms = function() {
  3631. return this.room?.getBreakoutRooms();
  3632. };