Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.

JitsiConference.js 116KB

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