您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符

JitsiConference.js 138KB

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