Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

JitsiConference.js 135KB

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