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 138KB

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