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

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