Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.

JitsiConference.js 107KB

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