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

JitsiConference.js 113KB

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