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

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