You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

JitsiConference.js 139KB

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