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

JitsiConference.js 138KB

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