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

JitsiConference.js 112KB

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