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

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