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 112KB

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