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

JitsiConference.js 135KB

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