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

JitsiConference.js 139KB

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