您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符

JitsiConference.js 85KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668
  1. /* global __filename, $, Strophe, Promise */
  2. import AvgRTPStatsReporter from './modules/statistics/AvgRTPStatsReporter';
  3. import ComponentsVersions from './modules/version/ComponentsVersions';
  4. import ConnectionQuality from './modules/connectivity/ConnectionQuality';
  5. import { getLogger } from 'jitsi-meet-logger';
  6. import GlobalOnErrorHandler from './modules/util/GlobalOnErrorHandler';
  7. import EventEmitter from 'events';
  8. import * as JitsiConferenceErrors from './JitsiConferenceErrors';
  9. import JitsiConferenceEventManager from './JitsiConferenceEventManager';
  10. import * as JitsiConferenceEvents from './JitsiConferenceEvents';
  11. import JitsiDTMFManager from './modules/DTMF/JitsiDTMFManager';
  12. import JitsiParticipant from './JitsiParticipant';
  13. import JitsiTrackError from './JitsiTrackError';
  14. import * as JitsiTrackErrors from './JitsiTrackErrors';
  15. import * as JitsiTrackEvents from './JitsiTrackEvents';
  16. import Jvb121EventGenerator from './modules/event/Jvb121EventGenerator';
  17. import * as MediaType from './service/RTC/MediaType';
  18. import ParticipantConnectionStatusHandler
  19. from './modules/connectivity/ParticipantConnectionStatus';
  20. import P2PDominantSpeakerDetection from './modules/P2PDominantSpeakerDetection';
  21. import RTC from './modules/RTC/RTC';
  22. import RTCBrowserType from './modules/RTC/RTCBrowserType';
  23. import * as RTCEvents from './service/RTC/RTCEvents';
  24. import Statistics from './modules/statistics/statistics';
  25. import TalkMutedDetection from './modules/TalkMutedDetection';
  26. import Transcriber from './modules/transcription/transcriber';
  27. import VideoType from './service/RTC/VideoType';
  28. import VideoSIPGW from './modules/videosipgw/VideoSIPGW';
  29. import * as XMPPEvents from './service/xmpp/XMPPEvents';
  30. import SpeakerStatsCollector from './modules/statistics/SpeakerStatsCollector';
  31. const logger = getLogger(__filename);
  32. /**
  33. * Creates a JitsiConference object with the given name and properties.
  34. * Note: this constructor is not a part of the public API (objects should be
  35. * created using JitsiConnection.createConference).
  36. * @param options.config properties / settings related to the conference that
  37. * will be created.
  38. * @param options.name the name of the conference
  39. * @param options.connection the JitsiConnection object for this
  40. * JitsiConference.
  41. * @param {number} [options.config.avgRtpStatsN=15] how many samples are to be
  42. * collected by {@link AvgRTPStatsReporter}, before arithmetic mean is
  43. * calculated and submitted to the analytics module.
  44. * @param {boolean} [options.config.p2p.enabled] when set to <tt>true</tt>
  45. * the peer to peer mode will be enabled. It means that when there are only 2
  46. * participants in the conference an attempt to make direct connection will be
  47. * made. If the connection succeeds the conference will stop sending data
  48. * through the JVB connection and will use the direct one instead.
  49. * @param {number} [options.config.p2p.backToP2PDelay=5] a delay given in
  50. * seconds, before the conference switches back to P2P, after the 3rd
  51. * participant has left the room.
  52. * @param {number} [options.config.channelLastN=-1] The requested amount of
  53. * videos are going to be delivered after the value is in effect. Set to -1 for
  54. * unlimited or all available videos.
  55. * @param {number} [options.config.forceJVB121Ratio]
  56. * "Math.random() < forceJVB121Ratio" will determine whether a 2 people
  57. * conference should be moved to the JVB instead of P2P. The decision is made on
  58. * the responder side, after ICE succeeds on the P2P connection.
  59. * @param {*} [options.config.openBridgeChannel] Which kind of communication to
  60. * open with the videobridge. Values can be "datachannel", "websocket", true
  61. * (treat it as "datachannel"), undefined (treat it as "datachannel") and false
  62. * (don't open any channel).
  63. * @constructor
  64. *
  65. * FIXME Make all methods which are called from lib-internal classes
  66. * to non-public (use _). To name a few:
  67. * {@link JitsiConference.onLocalRoleChanged}
  68. * {@link JitsiConference.onUserRoleChanged}
  69. * {@link JitsiConference.onMemberLeft}
  70. * and so on...
  71. */
  72. export default function JitsiConference(options) {
  73. if (!options.name || options.name.toLowerCase() !== options.name) {
  74. const errmsg
  75. = 'Invalid conference name (no conference name passed or it '
  76. + 'contains invalid characters like capital letters)!';
  77. logger.error(errmsg);
  78. throw new Error(errmsg);
  79. }
  80. this.eventEmitter = new EventEmitter();
  81. this.options = options;
  82. this.eventManager = new JitsiConferenceEventManager(this);
  83. this.participants = {};
  84. this._init(options);
  85. this.componentsVersions = new ComponentsVersions(this);
  86. /**
  87. * Jingle session instance for the JVB connection.
  88. * @type {JingleSessionPC}
  89. */
  90. this.jvbJingleSession = null;
  91. this.lastDominantSpeaker = null;
  92. this.dtmfManager = null;
  93. this.somebodySupportsDTMF = false;
  94. this.authEnabled = false;
  95. this.startAudioMuted = false;
  96. this.startVideoMuted = false;
  97. this.startMutedPolicy = {
  98. audio: false,
  99. video: false
  100. };
  101. this.availableDevices = {
  102. audio: undefined,
  103. video: undefined
  104. };
  105. this.isMutedByFocus = false;
  106. // Flag indicates if the 'onCallEnded' method was ever called on this
  107. // instance. Used to log extra analytics event for debugging purpose.
  108. // We need to know if the potential issue happened before or after
  109. // the restart.
  110. this.wasStopped = false;
  111. /**
  112. * The object which monitors local and remote connection statistics (e.g.
  113. * sending bitrate) and calculates a number which represents the connection
  114. * quality.
  115. */
  116. this.connectionQuality
  117. = new ConnectionQuality(this, this.eventEmitter, options);
  118. /**
  119. * Reports average RTP statistics to the analytics module.
  120. * @type {AvgRTPStatsReporter}
  121. */
  122. this.avgRtpStatsReporter
  123. = new AvgRTPStatsReporter(this, options.config.avgRtpStatsN || 15);
  124. /**
  125. * Indicates whether the connection is interrupted or not.
  126. */
  127. this.isJvbConnectionInterrupted = false;
  128. /**
  129. * The object which tracks active speaker times
  130. */
  131. this.speakerStatsCollector = new SpeakerStatsCollector(this);
  132. /* P2P related fields below: */
  133. /**
  134. * Stores reference to deferred start P2P task. It's created when 3rd
  135. * participant leaves the room in order to avoid ping pong effect (it
  136. * could be just a page reload).
  137. * @type {number|null}
  138. */
  139. this.deferredStartP2PTask = null;
  140. const delay
  141. = parseInt(options.config.p2p && options.config.p2p.backToP2PDelay, 10);
  142. /**
  143. * A delay given in seconds, before the conference switches back to P2P
  144. * after the 3rd participant has left.
  145. * @type {number}
  146. */
  147. this.backToP2PDelay = isNaN(delay) ? 5 : delay;
  148. logger.info(`backToP2PDelay: ${this.backToP2PDelay}`);
  149. /**
  150. * If set to <tt>true</tt> it means the P2P ICE is no longer connected.
  151. * When <tt>false</tt> it means that P2P ICE (media) connection is up
  152. * and running.
  153. * @type {boolean}
  154. */
  155. this.isP2PConnectionInterrupted = false;
  156. /**
  157. * Flag set to <tt>true</tt> when P2P session has been established
  158. * (ICE has been connected) and this conference is currently in the peer to
  159. * peer mode (P2P connection is the active one).
  160. * @type {boolean}
  161. */
  162. this.p2p = false;
  163. /**
  164. * A JingleSession for the direct peer to peer connection.
  165. * @type {JingleSessionPC}
  166. */
  167. this.p2pJingleSession = null;
  168. }
  169. // FIXME convert JitsiConference to ES6 - ASAP !
  170. JitsiConference.prototype.constructor = JitsiConference;
  171. /**
  172. * Initializes the conference object properties
  173. * @param options {object}
  174. * @param options.connection {JitsiConnection} overrides this.connection
  175. */
  176. JitsiConference.prototype._init = function(options = {}) {
  177. // Override connection and xmpp properties (Useful if the connection
  178. // reloaded)
  179. if (options.connection) {
  180. this.connection = options.connection;
  181. this.xmpp = this.connection.xmpp;
  182. // Setup XMPP events only if we have new connection object.
  183. this.eventManager.setupXMPPListeners();
  184. }
  185. const { config } = this.options;
  186. this.room = this.xmpp.createRoom(this.options.name, config);
  187. // Connection interrupted/restored listeners
  188. this._onIceConnectionInterrupted
  189. = this._onIceConnectionInterrupted.bind(this);
  190. this.room.addListener(
  191. XMPPEvents.CONNECTION_INTERRUPTED, this._onIceConnectionInterrupted);
  192. this._onIceConnectionRestored = this._onIceConnectionRestored.bind(this);
  193. this.room.addListener(
  194. XMPPEvents.CONNECTION_RESTORED, this._onIceConnectionRestored);
  195. this._onIceConnectionEstablished
  196. = this._onIceConnectionEstablished.bind(this);
  197. this.room.addListener(
  198. XMPPEvents.CONNECTION_ESTABLISHED, this._onIceConnectionEstablished);
  199. this.room.updateDeviceAvailability(RTC.getDeviceAvailability());
  200. if (!this.rtc) {
  201. this.rtc = new RTC(this, options);
  202. this.eventManager.setupRTCListeners();
  203. }
  204. this.participantConnectionStatus
  205. = new ParticipantConnectionStatusHandler(
  206. this.rtc,
  207. this,
  208. { // Both these options are not public API, leaving it here only
  209. // as an entry point through config for tuning up purposes.
  210. // Default values should be adjusted as soon as optimal values
  211. // are discovered.
  212. rtcMuteTimeout: config._peerConnStatusRtcMuteTimeout,
  213. outOfLastNTimeout: config._peerConnStatusOutOfLastNTimeout
  214. });
  215. this.participantConnectionStatus.init();
  216. if (!this.statistics) {
  217. // XXX The property location on the global variable window is not
  218. // defined in all execution environments (e.g. react-native). While
  219. // jitsi-meet may polyfill it when executing on react-native, it is
  220. // better for the cross-platform support to not require window.location
  221. // especially when there is a worthy alternative (as demonstrated
  222. // bellow).
  223. const windowLocation = window.location;
  224. this.statistics = new Statistics(this.xmpp, {
  225. callStatsAliasName: this.myUserId(),
  226. callStatsConfIDNamespace:
  227. config.callStatsConfIDNamespace
  228. || (windowLocation && windowLocation.hostname)
  229. || (config.hosts && config.hosts.domain),
  230. callStatsCustomScriptUrl: config.callStatsCustomScriptUrl,
  231. callStatsID: config.callStatsID,
  232. callStatsSecret: config.callStatsSecret,
  233. roomName: this.options.name
  234. });
  235. }
  236. this.eventManager.setupChatRoomListeners();
  237. // Always add listeners because on reload we are executing leave and the
  238. // listeners are removed from statistics module.
  239. this.eventManager.setupStatisticsListeners();
  240. if (config.enableTalkWhileMuted) {
  241. // eslint-disable-next-line no-new
  242. new TalkMutedDetection(
  243. this,
  244. () =>
  245. this.eventEmitter.emit(JitsiConferenceEvents.TALK_WHILE_MUTED));
  246. }
  247. if ('channelLastN' in config) {
  248. this.setLastN(config.channelLastN);
  249. }
  250. /**
  251. * Emits {@link JitsiConferenceEvents.JVB121_STATUS}.
  252. * @type {Jvb121EventGenerator}
  253. */
  254. this.jvb121Status = new Jvb121EventGenerator(this);
  255. // creates dominant speaker detection that works only in p2p mode
  256. this.p2pDominantSpeakerDetection = new P2PDominantSpeakerDetection(this);
  257. };
  258. /**
  259. * Joins the conference.
  260. * @param password {string} the password
  261. */
  262. JitsiConference.prototype.join = function(password) {
  263. if (this.room) {
  264. this.room.join(password);
  265. }
  266. };
  267. /**
  268. * Check if joined to the conference.
  269. */
  270. JitsiConference.prototype.isJoined = function() {
  271. return this.room && this.room.joined;
  272. };
  273. /**
  274. * Tells whether or not the P2P mode is enabled in the configuration.
  275. * @return {boolean}
  276. */
  277. JitsiConference.prototype.isP2PEnabled = function() {
  278. return Boolean(this.options.config.p2p && this.options.config.p2p.enabled)
  279. // FIXME: remove once we have a default config template. -saghul
  280. || typeof this.options.config.p2p === 'undefined';
  281. };
  282. /**
  283. * When in P2P test mode, the conference will not automatically switch to P2P
  284. * when there 2 participants.
  285. * @return {boolean}
  286. */
  287. JitsiConference.prototype.isP2PTestModeEnabled = function() {
  288. return Boolean(this.options.config.testing
  289. && this.options.config.testing.p2pTestMode);
  290. };
  291. /**
  292. * Leaves the conference.
  293. * @returns {Promise}
  294. */
  295. JitsiConference.prototype.leave = function() {
  296. if (this.participantConnectionStatus) {
  297. this.participantConnectionStatus.dispose();
  298. this.participantConnectionStatus = null;
  299. }
  300. if (this.avgRtpStatsReporter) {
  301. this.avgRtpStatsReporter.dispose();
  302. this.avgRtpStatsReporter = null;
  303. }
  304. this.getLocalTracks().forEach(track => this.onLocalTrackRemoved(track));
  305. this.rtc.closeBridgeChannel();
  306. if (this.statistics) {
  307. this.statistics.dispose();
  308. }
  309. // Close both JVb and P2P JingleSessions
  310. if (this.jvbJingleSession) {
  311. this.jvbJingleSession.close();
  312. this.jvbJingleSession = null;
  313. }
  314. if (this.p2pJingleSession) {
  315. this.p2pJingleSession.close();
  316. this.p2pJingleSession = null;
  317. }
  318. // leave the conference
  319. if (this.room) {
  320. const room = this.room;
  321. // Unregister connection state listeners
  322. room.removeListener(
  323. XMPPEvents.CONNECTION_INTERRUPTED,
  324. this._onIceConnectionInterrupted);
  325. room.removeListener(
  326. XMPPEvents.CONNECTION_RESTORED,
  327. this._onIceConnectionRestored);
  328. room.removeListener(
  329. XMPPEvents.CONNECTION_ESTABLISHED,
  330. this._onIceConnectionEstablished);
  331. this.room = null;
  332. return room.leave().catch(() => {
  333. // remove all participants because currently the conference won't
  334. // be usable anyway. This is done on success automatically by the
  335. // ChatRoom instance.
  336. this.getParticipants().forEach(
  337. participant => this.onMemberLeft(participant.getJid()));
  338. });
  339. }
  340. // If this.room == null we are calling second time leave().
  341. return Promise.reject(
  342. new Error('The conference is has been already left'));
  343. };
  344. /**
  345. * Returns name of this conference.
  346. */
  347. JitsiConference.prototype.getName = function() {
  348. return this.options.name;
  349. };
  350. /**
  351. * Check if authentication is enabled for this conference.
  352. */
  353. JitsiConference.prototype.isAuthEnabled = function() {
  354. return this.authEnabled;
  355. };
  356. /**
  357. * Check if user is logged in.
  358. */
  359. JitsiConference.prototype.isLoggedIn = function() {
  360. return Boolean(this.authIdentity);
  361. };
  362. /**
  363. * Get authorized login.
  364. */
  365. JitsiConference.prototype.getAuthLogin = function() {
  366. return this.authIdentity;
  367. };
  368. /**
  369. * Check if external authentication is enabled for this conference.
  370. */
  371. JitsiConference.prototype.isExternalAuthEnabled = function() {
  372. return this.room && this.room.moderator.isExternalAuthEnabled();
  373. };
  374. /**
  375. * Get url for external authentication.
  376. * @param {boolean} [urlForPopup] if true then return url for login popup,
  377. * else url of login page.
  378. * @returns {Promise}
  379. */
  380. JitsiConference.prototype.getExternalAuthUrl = function(urlForPopup) {
  381. return new Promise((resolve, reject) => {
  382. if (!this.isExternalAuthEnabled()) {
  383. reject();
  384. return;
  385. }
  386. if (urlForPopup) {
  387. this.room.moderator.getPopupLoginUrl(resolve, reject);
  388. } else {
  389. this.room.moderator.getLoginUrl(resolve, reject);
  390. }
  391. });
  392. };
  393. /**
  394. * Returns the local tracks of the given media type, or all local tracks if no
  395. * specific type is given.
  396. * @param {MediaType} [mediaType] Optional media type (audio or video).
  397. */
  398. JitsiConference.prototype.getLocalTracks = function(mediaType) {
  399. let tracks = [];
  400. if (this.rtc) {
  401. tracks = this.rtc.getLocalTracks(mediaType);
  402. }
  403. return tracks;
  404. };
  405. /**
  406. * Obtains local audio track.
  407. * @return {JitsiLocalTrack|null}
  408. */
  409. JitsiConference.prototype.getLocalAudioTrack = function() {
  410. return this.rtc ? this.rtc.getLocalAudioTrack() : null;
  411. };
  412. /**
  413. * Obtains local video track.
  414. * @return {JitsiLocalTrack|null}
  415. */
  416. JitsiConference.prototype.getLocalVideoTrack = function() {
  417. return this.rtc ? this.rtc.getLocalVideoTrack() : null;
  418. };
  419. /**
  420. * Attaches a handler for events(For example - "participant joined".) in the
  421. * conference. All possible event are defined in JitsiConferenceEvents.
  422. * @param eventId the event ID.
  423. * @param handler handler for the event.
  424. *
  425. * Note: consider adding eventing functionality by extending an EventEmitter
  426. * impl, instead of rolling ourselves
  427. */
  428. JitsiConference.prototype.on = function(eventId, handler) {
  429. if (this.eventEmitter) {
  430. this.eventEmitter.on(eventId, handler);
  431. }
  432. };
  433. /**
  434. * Removes event listener
  435. * @param eventId the event ID.
  436. * @param [handler] optional, the specific handler to unbind
  437. *
  438. * Note: consider adding eventing functionality by extending an EventEmitter
  439. * impl, instead of rolling ourselves
  440. */
  441. JitsiConference.prototype.off = function(eventId, handler) {
  442. if (this.eventEmitter) {
  443. this.eventEmitter.removeListener(eventId, handler);
  444. }
  445. };
  446. // Common aliases for event emitter
  447. JitsiConference.prototype.addEventListener = JitsiConference.prototype.on;
  448. JitsiConference.prototype.removeEventListener = JitsiConference.prototype.off;
  449. /**
  450. * Receives notifications from other participants about commands / custom events
  451. * (sent by sendCommand or sendCommandOnce methods).
  452. * @param command {String} the name of the command
  453. * @param handler {Function} handler for the command
  454. */
  455. JitsiConference.prototype.addCommandListener = function(command, handler) {
  456. if (this.room) {
  457. this.room.addPresenceListener(command, handler);
  458. }
  459. };
  460. /**
  461. * Removes command listener
  462. * @param command {String} the name of the command
  463. */
  464. JitsiConference.prototype.removeCommandListener = function(command) {
  465. if (this.room) {
  466. this.room.removePresenceListener(command);
  467. }
  468. };
  469. /**
  470. * Sends text message to the other participants in the conference
  471. * @param message the text message.
  472. */
  473. JitsiConference.prototype.sendTextMessage = function(message) {
  474. if (this.room) {
  475. this.room.sendMessage(message);
  476. }
  477. };
  478. /**
  479. * Send presence command.
  480. * @param name {String} the name of the command.
  481. * @param values {Object} with keys and values that will be sent.
  482. **/
  483. JitsiConference.prototype.sendCommand = function(name, values) {
  484. if (this.room) {
  485. this.room.addToPresence(name, values);
  486. this.room.sendPresence();
  487. }
  488. };
  489. /**
  490. * Send presence command one time.
  491. * @param name {String} the name of the command.
  492. * @param values {Object} with keys and values that will be sent.
  493. **/
  494. JitsiConference.prototype.sendCommandOnce = function(name, values) {
  495. this.sendCommand(name, values);
  496. this.removeCommand(name);
  497. };
  498. /**
  499. * Removes presence command.
  500. * @param name {String} the name of the command.
  501. **/
  502. JitsiConference.prototype.removeCommand = function(name) {
  503. if (this.room) {
  504. this.room.removeFromPresence(name);
  505. }
  506. };
  507. /**
  508. * Sets the display name for this conference.
  509. * @param name the display name to set
  510. */
  511. JitsiConference.prototype.setDisplayName = function(name) {
  512. if (this.room) {
  513. // remove previously set nickname
  514. this.room.removeFromPresence('nick');
  515. this.room.addToPresence('nick', {
  516. attributes: { xmlns: 'http://jabber.org/protocol/nick' },
  517. value: name
  518. });
  519. this.room.sendPresence();
  520. }
  521. };
  522. /**
  523. * Set new subject for this conference. (available only for moderator)
  524. * @param {string} subject new subject
  525. */
  526. JitsiConference.prototype.setSubject = function(subject) {
  527. if (this.room && this.isModerator()) {
  528. this.room.setSubject(subject);
  529. }
  530. };
  531. /**
  532. * Get a transcriber object for all current participants in this conference
  533. * @return {Transcriber} the transcriber object
  534. */
  535. JitsiConference.prototype.getTranscriber = function() {
  536. if (this.transcriber === undefined) {
  537. this.transcriber = new Transcriber();
  538. // add all existing local audio tracks to the transcriber
  539. const localAudioTracks = this.getLocalTracks(MediaType.AUDIO);
  540. for (const localAudio of localAudioTracks) {
  541. this.transcriber.addTrack(localAudio);
  542. }
  543. // and all remote audio tracks
  544. const remoteAudioTracks = this.rtc.getRemoteTracks(MediaType.AUDIO);
  545. for (const remoteTrack of remoteAudioTracks) {
  546. this.transcriber.addTrack(remoteTrack);
  547. }
  548. }
  549. return this.transcriber;
  550. };
  551. /**
  552. * Adds JitsiLocalTrack object to the conference.
  553. * @param track the JitsiLocalTrack object.
  554. * @returns {Promise<JitsiLocalTrack>}
  555. * @throws {Error} if the specified track is a video track and there is already
  556. * another video track in the conference.
  557. */
  558. JitsiConference.prototype.addTrack = function(track) {
  559. if (track.isVideoTrack()) {
  560. // Ensure there's exactly 1 local video track in the conference.
  561. const localVideoTrack = this.rtc.getLocalVideoTrack();
  562. if (localVideoTrack) {
  563. // Don't be excessively harsh and severe if the API client happens
  564. // to attempt to add the same local video track twice.
  565. if (track === localVideoTrack) {
  566. return Promise.resolve(track);
  567. }
  568. return Promise.reject(new Error(
  569. 'cannot add second video track to the conference'));
  570. }
  571. }
  572. return this.replaceTrack(null, track);
  573. };
  574. /**
  575. * Fires TRACK_AUDIO_LEVEL_CHANGED change conference event (for local tracks).
  576. * @param {number} audioLevel the audio level
  577. * @param {TraceablePeerConnection} [tpc]
  578. */
  579. JitsiConference.prototype._fireAudioLevelChangeEvent
  580. = function(audioLevel, tpc) {
  581. const activeTpc = this.getActivePeerConnection();
  582. // There will be no TraceablePeerConnection if audio levels do not come from
  583. // a peerconnection. LocalStatsCollector.js measures audio levels using Web
  584. // Audio Analyser API and emits local audio levels events through
  585. // JitsiTrack.setAudioLevel, but does not provide TPC instance which is
  586. // optional.
  587. if (!tpc || activeTpc === tpc) {
  588. this.eventEmitter.emit(
  589. JitsiConferenceEvents.TRACK_AUDIO_LEVEL_CHANGED,
  590. this.myUserId(), audioLevel);
  591. }
  592. };
  593. /**
  594. * Fires TRACK_MUTE_CHANGED change conference event.
  595. * @param track the JitsiTrack object related to the event.
  596. */
  597. JitsiConference.prototype._fireMuteChangeEvent = function(track) {
  598. // check if track was muted by focus and now is unmuted by user
  599. if (this.isMutedByFocus && track.isAudioTrack() && !track.isMuted()) {
  600. this.isMutedByFocus = false;
  601. // unmute local user on server
  602. this.room.muteParticipant(this.room.myroomjid, false);
  603. }
  604. this.eventEmitter.emit(JitsiConferenceEvents.TRACK_MUTE_CHANGED, track);
  605. };
  606. /**
  607. * Clear JitsiLocalTrack properties and listeners.
  608. * @param track the JitsiLocalTrack object.
  609. */
  610. JitsiConference.prototype.onLocalTrackRemoved = function(track) {
  611. track._setConference(null);
  612. this.rtc.removeLocalTrack(track);
  613. track.removeEventListener(JitsiTrackEvents.TRACK_MUTE_CHANGED,
  614. track.muteHandler);
  615. track.removeEventListener(JitsiTrackEvents.TRACK_AUDIO_LEVEL_CHANGED,
  616. track.audioLevelHandler);
  617. // send event for stopping screen sharing
  618. // FIXME: we assume we have only one screen sharing track
  619. // if we change this we need to fix this check
  620. if (track.isVideoTrack() && track.videoType === VideoType.DESKTOP) {
  621. this.statistics.sendScreenSharingEvent(false);
  622. }
  623. this.eventEmitter.emit(JitsiConferenceEvents.TRACK_REMOVED, track);
  624. };
  625. /**
  626. * Removes JitsiLocalTrack from the conference and performs
  627. * a new offer/answer cycle.
  628. * @param {JitsiLocalTrack} track
  629. * @returns {Promise}
  630. */
  631. JitsiConference.prototype.removeTrack = function(track) {
  632. return this.replaceTrack(track, null);
  633. };
  634. /**
  635. * Replaces oldTrack with newTrack and performs a single offer/answer
  636. * cycle after both operations are done. Either oldTrack or newTrack
  637. * can be null; replacing a valid 'oldTrack' with a null 'newTrack'
  638. * effectively just removes 'oldTrack'
  639. * @param {JitsiLocalTrack} oldTrack the current stream in use to be replaced
  640. * @param {JitsiLocalTrack} newTrack the new stream to use
  641. * @returns {Promise} resolves when the replacement is finished
  642. */
  643. JitsiConference.prototype.replaceTrack = function(oldTrack, newTrack) {
  644. // First do the removal of the oldTrack at the JitsiConference level
  645. if (oldTrack) {
  646. if (oldTrack.disposed) {
  647. return Promise.reject(
  648. new JitsiTrackError(JitsiTrackErrors.TRACK_IS_DISPOSED));
  649. }
  650. }
  651. if (newTrack) {
  652. if (newTrack.disposed) {
  653. return Promise.reject(
  654. new JitsiTrackError(JitsiTrackErrors.TRACK_IS_DISPOSED));
  655. }
  656. }
  657. // Now replace the stream at the lower levels
  658. return this._doReplaceTrack(oldTrack, newTrack)
  659. .then(() => {
  660. if (oldTrack) {
  661. this.onLocalTrackRemoved(oldTrack);
  662. }
  663. if (newTrack) {
  664. // Now handle the addition of the newTrack at the
  665. // JitsiConference level
  666. this._setupNewTrack(newTrack);
  667. }
  668. return Promise.resolve();
  669. }, error => Promise.reject(new Error(error)));
  670. };
  671. /**
  672. * Replaces the tracks at the lower level by going through the Jingle session
  673. * and WebRTC peer connection. The method will resolve immediately if there is
  674. * currently no JingleSession started.
  675. * @param {JitsiLocalTrack|null} oldTrack the track to be removed during
  676. * the process or <tt>null</t> if the method should act as "add track"
  677. * @param {JitsiLocalTrack|null} newTrack the new track to be added or
  678. * <tt>null</tt> if the method should act as "remove track"
  679. * @return {Promise} resolved when the process is done or rejected with a string
  680. * which describes the error.
  681. * @private
  682. */
  683. JitsiConference.prototype._doReplaceTrack = function(oldTrack, newTrack) {
  684. const replaceTrackPromises = [];
  685. if (this.jvbJingleSession) {
  686. replaceTrackPromises.push(
  687. this.jvbJingleSession.replaceTrack(oldTrack, newTrack));
  688. } else {
  689. logger.info('_doReplaceTrack - no JVB JingleSession');
  690. }
  691. if (this.p2pJingleSession) {
  692. replaceTrackPromises.push(
  693. this.p2pJingleSession.replaceTrack(oldTrack, newTrack));
  694. } else {
  695. logger.info('_doReplaceTrack - no P2P JingleSession');
  696. }
  697. return Promise.all(replaceTrackPromises);
  698. };
  699. /**
  700. * Operations related to creating a new track
  701. * @param {JitsiLocalTrack} newTrack the new track being created
  702. */
  703. JitsiConference.prototype._setupNewTrack = function(newTrack) {
  704. if (newTrack.isAudioTrack() || (newTrack.isVideoTrack()
  705. && newTrack.videoType !== VideoType.DESKTOP)) {
  706. // Report active device to statistics
  707. const devices = RTC.getCurrentlyAvailableMediaDevices();
  708. const device
  709. = devices.find(
  710. d =>
  711. d.kind === `${newTrack.getTrack().kind}input`
  712. && d.label === newTrack.getTrack().label);
  713. if (device) {
  714. Statistics.sendActiveDeviceListEvent(
  715. RTC.getEventDataForActiveDevice(device));
  716. }
  717. }
  718. if (newTrack.isVideoTrack()) {
  719. this.removeCommand('videoType');
  720. this.sendCommand('videoType', {
  721. value: newTrack.videoType,
  722. attributes: {
  723. xmlns: 'http://jitsi.org/jitmeet/video'
  724. }
  725. });
  726. }
  727. this.rtc.addLocalTrack(newTrack);
  728. // ensure that we're sharing proper "is muted" state
  729. if (newTrack.isAudioTrack()) {
  730. this.room.setAudioMute(newTrack.isMuted());
  731. } else {
  732. this.room.setVideoMute(newTrack.isMuted());
  733. }
  734. newTrack.muteHandler = this._fireMuteChangeEvent.bind(this, newTrack);
  735. newTrack.audioLevelHandler = this._fireAudioLevelChangeEvent.bind(this);
  736. newTrack.addEventListener(JitsiTrackEvents.TRACK_MUTE_CHANGED,
  737. newTrack.muteHandler);
  738. newTrack.addEventListener(JitsiTrackEvents.TRACK_AUDIO_LEVEL_CHANGED,
  739. newTrack.audioLevelHandler);
  740. newTrack._setConference(this);
  741. // send event for starting screen sharing
  742. // FIXME: we assume we have only one screen sharing track
  743. // if we change this we need to fix this check
  744. if (newTrack.isVideoTrack() && newTrack.videoType === VideoType.DESKTOP) {
  745. this.statistics.sendScreenSharingEvent(true);
  746. }
  747. this.eventEmitter.emit(JitsiConferenceEvents.TRACK_ADDED, newTrack);
  748. };
  749. /**
  750. * Method called by the {@link JitsiLocalTrack} (a video one) in order to add
  751. * back the underlying WebRTC MediaStream to the PeerConnection (which has
  752. * removed on video mute).
  753. * @param {JitsiLocalTrack} track the local track that will be added as part of
  754. * the unmute operation.
  755. * @return {Promise} resolved when the process is done or rejected with a string
  756. * which describes the error.
  757. */
  758. JitsiConference.prototype._addLocalTrackAsUnmute = function(track) {
  759. const addAsUnmutePromises = [];
  760. if (this.jvbJingleSession) {
  761. addAsUnmutePromises.push(this.jvbJingleSession.addTrackAsUnmute(track));
  762. } else {
  763. logger.info(
  764. 'Add local MediaStream as unmute -'
  765. + ' no JVB Jingle session started yet');
  766. }
  767. if (this.p2pJingleSession) {
  768. addAsUnmutePromises.push(this.p2pJingleSession.addTrackAsUnmute(track));
  769. } else {
  770. logger.info(
  771. 'Add local MediaStream as unmute -'
  772. + ' no P2P Jingle session started yet');
  773. }
  774. return Promise.all(addAsUnmutePromises);
  775. };
  776. /**
  777. * Method called by the {@link JitsiLocalTrack} (a video one) in order to remove
  778. * the underlying WebRTC MediaStream from the PeerConnection. The purpose of
  779. * that is to stop sending any data and turn off the HW camera device.
  780. * @param {JitsiLocalTrack} track the local track that will be removed.
  781. * @return {Promise}
  782. */
  783. JitsiConference.prototype._removeLocalTrackAsMute = function(track) {
  784. const removeAsMutePromises = [];
  785. if (this.jvbJingleSession) {
  786. removeAsMutePromises.push(
  787. this.jvbJingleSession.removeTrackAsMute(track));
  788. } else {
  789. logger.info(
  790. 'Remove local MediaStream - no JVB JingleSession started yet');
  791. }
  792. if (this.p2pJingleSession) {
  793. removeAsMutePromises.push(
  794. this.p2pJingleSession.removeTrackAsMute(track));
  795. } else {
  796. logger.info(
  797. 'Remove local MediaStream - no P2P JingleSession started yet');
  798. }
  799. return Promise.all(removeAsMutePromises);
  800. };
  801. /**
  802. * Get role of the local user.
  803. * @returns {string} user role: 'moderator' or 'none'
  804. */
  805. JitsiConference.prototype.getRole = function() {
  806. return this.room.role;
  807. };
  808. /**
  809. * Check if local user is moderator.
  810. * @returns {boolean|null} true if local user is moderator, false otherwise. If
  811. * we're no longer in the conference room then <tt>null</tt> is returned.
  812. */
  813. JitsiConference.prototype.isModerator = function() {
  814. return this.room ? this.room.isModerator() : null;
  815. };
  816. /**
  817. * Set password for the room.
  818. * @param {string} password new password for the room.
  819. * @returns {Promise}
  820. */
  821. JitsiConference.prototype.lock = function(password) {
  822. if (!this.isModerator()) {
  823. return Promise.reject();
  824. }
  825. return new Promise((resolve, reject) => {
  826. this.room.lockRoom(
  827. password || '',
  828. () => resolve(),
  829. err => reject(err),
  830. () => reject(JitsiConferenceErrors.PASSWORD_NOT_SUPPORTED));
  831. });
  832. };
  833. /**
  834. * Remove password from the room.
  835. * @returns {Promise}
  836. */
  837. JitsiConference.prototype.unlock = function() {
  838. return this.lock();
  839. };
  840. /**
  841. * Elects the participant with the given id to be the selected participant in
  842. * order to receive higher video quality (if simulcast is enabled).
  843. * Or cache it if channel is not created and send it once channel is available.
  844. * @param participantId the identifier of the participant
  845. * @throws NetworkError or InvalidStateError or Error if the operation fails.
  846. */
  847. JitsiConference.prototype.selectParticipant = function(participantId) {
  848. this.rtc.selectEndpoint(participantId);
  849. };
  850. /**
  851. * Elects the participant with the given id to be the pinned participant in
  852. * order to always receive video for this participant (even when last n is
  853. * enabled).
  854. * @param participantId the identifier of the participant
  855. * @throws NetworkError or InvalidStateError or Error if the operation fails.
  856. */
  857. JitsiConference.prototype.pinParticipant = function(participantId) {
  858. this.rtc.pinEndpoint(participantId);
  859. };
  860. /**
  861. * Obtains the current value for "lastN". See {@link setLastN} for more info.
  862. * @returns {number}
  863. */
  864. JitsiConference.prototype.getLastN = function() {
  865. return this.rtc.getLastN();
  866. };
  867. /**
  868. * Selects a new value for "lastN". The requested amount of videos are going
  869. * to be delivered after the value is in effect. Set to -1 for unlimited or
  870. * all available videos.
  871. * @param lastN the new number of videos the user would like to receive.
  872. * @throws Error or RangeError if the given value is not a number or is smaller
  873. * than -1.
  874. */
  875. JitsiConference.prototype.setLastN = function(lastN) {
  876. if (!Number.isInteger(lastN) && !Number.parseInt(lastN, 10)) {
  877. throw new Error(`Invalid value for lastN: ${lastN}`);
  878. }
  879. const n = Number(lastN);
  880. if (n < -1) {
  881. throw new RangeError('lastN cannot be smaller than -1');
  882. }
  883. this.rtc.setLastN(n);
  884. // If the P2P session is not fully established yet, we wait until it gets
  885. // established.
  886. if (this.p2pJingleSession) {
  887. const isVideoActive = n !== 0;
  888. this.p2pJingleSession
  889. .setMediaTransferActive(true, isVideoActive)
  890. .catch(error => {
  891. logger.error(
  892. `Failed to adjust video transfer status (${isVideoActive})`,
  893. error);
  894. });
  895. }
  896. };
  897. /**
  898. * Checks if the participant given by participantId is currently included in
  899. * the last N.
  900. * @param {string} participantId the identifier of the participant we would
  901. * like to check.
  902. * @return {boolean} true if the participant with id is in the last N set or
  903. * if there's no last N set, false otherwise.
  904. * @deprecated this method should never be used to figure out the UI, but
  905. * {@link ParticipantConnectionStatus} should be used instead.
  906. */
  907. JitsiConference.prototype.isInLastN = function(participantId) {
  908. return this.rtc.isInLastN(participantId);
  909. };
  910. /**
  911. * @return Array<JitsiParticipant> an array of all participants in this
  912. * conference.
  913. */
  914. JitsiConference.prototype.getParticipants = function() {
  915. return Object.keys(this.participants).map(function(key) {
  916. return this.participants[key];
  917. }, this);
  918. };
  919. /**
  920. * Returns the number of participants in the conference, including the local
  921. * participant.
  922. * @param countHidden {boolean} Whether or not to include hidden participants
  923. * in the count. Default: false.
  924. **/
  925. JitsiConference.prototype.getParticipantCount
  926. = function(countHidden = false) {
  927. let participants = this.getParticipants();
  928. if (!countHidden) {
  929. participants = participants.filter(p => !p.isHidden());
  930. }
  931. // Add one for the local participant.
  932. return participants.length + 1;
  933. };
  934. /**
  935. * @returns {JitsiParticipant} the participant in this conference with the
  936. * specified id (or undefined if there isn't one).
  937. * @param id the id of the participant.
  938. */
  939. JitsiConference.prototype.getParticipantById = function(id) {
  940. return this.participants[id];
  941. };
  942. /**
  943. * Kick participant from this conference.
  944. * @param {string} id id of the participant to kick
  945. */
  946. JitsiConference.prototype.kickParticipant = function(id) {
  947. const participant = this.getParticipantById(id);
  948. if (!participant) {
  949. return;
  950. }
  951. this.room.kick(participant.getJid());
  952. };
  953. /**
  954. * Mutes a participant.
  955. * @param {string} id The id of the participant to mute.
  956. */
  957. JitsiConference.prototype.muteParticipant = function(id) {
  958. const participant = this.getParticipantById(id);
  959. if (!participant) {
  960. return;
  961. }
  962. this.room.muteParticipant(participant.getJid(), true);
  963. };
  964. /* eslint-disable max-params */
  965. /**
  966. * Notifies this JitsiConference that a new member has joined its chat room.
  967. *
  968. * FIXME This should NOT be exposed!
  969. *
  970. * @param jid the jid of the participant in the MUC
  971. * @param nick the display name of the participant
  972. * @param role the role of the participant in the MUC
  973. * @param isHidden indicates if this is a hidden participant (system
  974. * participant for example a recorder).
  975. */
  976. JitsiConference.prototype.onMemberJoined = function(jid, nick, role, isHidden) {
  977. const id = Strophe.getResourceFromJid(jid);
  978. if (id === 'focus' || this.myUserId() === id) {
  979. return;
  980. }
  981. const participant = new JitsiParticipant(jid, this, nick, isHidden);
  982. participant._role = role;
  983. this.participants[id] = participant;
  984. this.eventEmitter.emit(
  985. JitsiConferenceEvents.USER_JOINED,
  986. id,
  987. participant);
  988. this.xmpp.caps.getFeatures(jid)
  989. .then(features => {
  990. participant._supportsDTMF = features.has('urn:xmpp:jingle:dtmf:0');
  991. this.updateDTMFSupport();
  992. },
  993. error => logger.error(`Failed to discover features of ${jid}`, error));
  994. this._maybeStartOrStopP2P();
  995. };
  996. /* eslint-enable max-params */
  997. JitsiConference.prototype.onMemberLeft = function(jid) {
  998. const id = Strophe.getResourceFromJid(jid);
  999. if (id === 'focus' || this.myUserId() === id) {
  1000. return;
  1001. }
  1002. const participant = this.participants[id];
  1003. delete this.participants[id];
  1004. const removedTracks = this.rtc.removeRemoteTracks(id);
  1005. removedTracks.forEach(
  1006. track =>
  1007. this.eventEmitter.emit(JitsiConferenceEvents.TRACK_REMOVED, track));
  1008. // there can be no participant in case the member that left is focus
  1009. if (participant) {
  1010. this.eventEmitter.emit(
  1011. JitsiConferenceEvents.USER_LEFT, id, participant);
  1012. }
  1013. this._maybeStartOrStopP2P(true /* triggered by user left event */);
  1014. };
  1015. /**
  1016. * Method called on local MUC role change.
  1017. * @param {string} role the name of new user's role as defined by XMPP MUC.
  1018. */
  1019. JitsiConference.prototype.onLocalRoleChanged = function(role) {
  1020. // Emit role changed for local JID
  1021. this.eventEmitter.emit(
  1022. JitsiConferenceEvents.USER_ROLE_CHANGED, this.myUserId(), role);
  1023. // Maybe start P2P
  1024. this._maybeStartOrStopP2P();
  1025. };
  1026. JitsiConference.prototype.onUserRoleChanged = function(jid, role) {
  1027. const id = Strophe.getResourceFromJid(jid);
  1028. const participant = this.getParticipantById(id);
  1029. if (!participant) {
  1030. return;
  1031. }
  1032. participant._role = role;
  1033. this.eventEmitter.emit(JitsiConferenceEvents.USER_ROLE_CHANGED, id, role);
  1034. };
  1035. JitsiConference.prototype.onDisplayNameChanged = function(jid, displayName) {
  1036. const id = Strophe.getResourceFromJid(jid);
  1037. const participant = this.getParticipantById(id);
  1038. if (!participant) {
  1039. return;
  1040. }
  1041. if (participant._displayName === displayName) {
  1042. return;
  1043. }
  1044. participant._displayName = displayName;
  1045. this.eventEmitter.emit(
  1046. JitsiConferenceEvents.DISPLAY_NAME_CHANGED,
  1047. id,
  1048. displayName);
  1049. };
  1050. /**
  1051. * Notifies this JitsiConference that a JitsiRemoteTrack was added into
  1052. * the conference.
  1053. *
  1054. * @param {JitsiRemoteTrack} track the JitsiRemoteTrack which was added to this
  1055. * JitsiConference
  1056. */
  1057. JitsiConference.prototype.onRemoteTrackAdded = function(track) {
  1058. if (track.isP2P && !this.isP2PActive()) {
  1059. logger.info(
  1060. 'Trying to add remote P2P track, when not in P2P - IGNORED');
  1061. return;
  1062. } else if (!track.isP2P && this.isP2PActive()) {
  1063. logger.info(
  1064. 'Trying to add remote JVB track, when in P2P - IGNORED');
  1065. return;
  1066. }
  1067. const id = track.getParticipantId();
  1068. const participant = this.getParticipantById(id);
  1069. if (!participant) {
  1070. logger.error(`No participant found for id: ${id}`);
  1071. return;
  1072. }
  1073. // Add track to JitsiParticipant.
  1074. participant._tracks.push(track);
  1075. if (this.transcriber) {
  1076. this.transcriber.addTrack(track);
  1077. }
  1078. const emitter = this.eventEmitter;
  1079. track.addEventListener(
  1080. JitsiTrackEvents.TRACK_MUTE_CHANGED,
  1081. () => emitter.emit(JitsiConferenceEvents.TRACK_MUTE_CHANGED, track));
  1082. track.addEventListener(
  1083. JitsiTrackEvents.TRACK_AUDIO_LEVEL_CHANGED,
  1084. (audioLevel, tpc) => {
  1085. const activeTPC = this.getActivePeerConnection();
  1086. if (activeTPC === tpc) {
  1087. emitter.emit(
  1088. JitsiConferenceEvents.TRACK_AUDIO_LEVEL_CHANGED,
  1089. id,
  1090. audioLevel);
  1091. }
  1092. }
  1093. );
  1094. emitter.emit(JitsiConferenceEvents.TRACK_ADDED, track);
  1095. };
  1096. /**
  1097. * Callback called by the Jingle plugin when 'session-answer' is received.
  1098. * @param {JingleSessionPC} session the Jingle session for which an answer was
  1099. * received.
  1100. * @param {jQuery} answer a jQuery selector pointing to 'jingle' IQ element
  1101. */
  1102. // eslint-disable-next-line no-unused-vars
  1103. JitsiConference.prototype.onCallAccepted = function(session, answer) {
  1104. if (this.p2pJingleSession === session) {
  1105. logger.info('P2P setAnswer');
  1106. this.p2pJingleSession.setAnswer(answer);
  1107. }
  1108. };
  1109. /**
  1110. * Callback called by the Jingle plugin when 'transport-info' is received.
  1111. * @param {JingleSessionPC} session the Jingle session for which the IQ was
  1112. * received
  1113. * @param {jQuery} transportInfo a jQuery selector pointing to 'jingle' IQ
  1114. * element
  1115. */
  1116. // eslint-disable-next-line no-unused-vars
  1117. JitsiConference.prototype.onTransportInfo = function(session, transportInfo) {
  1118. if (this.p2pJingleSession === session) {
  1119. logger.info('P2P addIceCandidates');
  1120. this.p2pJingleSession.addIceCandidates(transportInfo);
  1121. }
  1122. };
  1123. /**
  1124. * Notifies this JitsiConference that a JitsiRemoteTrack was removed from
  1125. * the conference.
  1126. *
  1127. * @param {JitsiRemoteTrack} removedTrack
  1128. */
  1129. JitsiConference.prototype.onRemoteTrackRemoved = function(removedTrack) {
  1130. this.getParticipants().forEach(participant => {
  1131. const tracks = participant.getTracks();
  1132. for (let i = 0; i < tracks.length; i++) {
  1133. if (tracks[i] === removedTrack) {
  1134. // Since the tracks have been compared and are
  1135. // considered equal the result of splice can be ignored.
  1136. participant._tracks.splice(i, 1);
  1137. this.eventEmitter.emit(
  1138. JitsiConferenceEvents.TRACK_REMOVED, removedTrack);
  1139. if (this.transcriber) {
  1140. this.transcriber.removeTrack(removedTrack);
  1141. }
  1142. break;
  1143. }
  1144. }
  1145. }, this);
  1146. };
  1147. /**
  1148. * Handles incoming call event.
  1149. */
  1150. JitsiConference.prototype.onIncomingCall
  1151. = function(jingleSession, jingleOffer, now) {
  1152. // Handle incoming P2P call
  1153. if (jingleSession.isP2P) {
  1154. const role = this.room.getMemberRole(jingleSession.peerjid);
  1155. if (role !== 'moderator') {
  1156. // Reject incoming P2P call
  1157. this._rejectIncomingCallNonModerator(jingleSession);
  1158. } else if (!RTCBrowserType.isP2PSupported()) {
  1159. // Reject incoming P2P call (already in progress)
  1160. this._rejectIncomingCall(
  1161. jingleSession, {
  1162. reasonTag: 'unsupported-applications',
  1163. reasonMsg: 'P2P not supported',
  1164. errorMsg: 'This client does not support P2P connections'
  1165. });
  1166. } else if (!this.isP2PEnabled() && !this.isP2PTestModeEnabled()) {
  1167. this._rejectIncomingCall(
  1168. jingleSession, {
  1169. reasonTag: 'decline',
  1170. reasonMsg: 'P2P disabled',
  1171. errorMsg: 'P2P mode disabled in the configuration'
  1172. });
  1173. } else if (this.p2pJingleSession) {
  1174. // Reject incoming P2P call (already in progress)
  1175. this._rejectIncomingCall(
  1176. jingleSession, {
  1177. reasonTag: 'busy',
  1178. reasonMsg: 'P2P already in progress',
  1179. errorMsg: 'Duplicated P2P "session-initiate"'
  1180. });
  1181. } else {
  1182. // Accept incoming P2P call
  1183. this._acceptP2PIncomingCall(jingleSession, jingleOffer);
  1184. }
  1185. return;
  1186. } else if (!this.room.isFocus(jingleSession.peerjid)) {
  1187. this._rejectIncomingCall(jingleSession);
  1188. return;
  1189. }
  1190. // Accept incoming call
  1191. this.jvbJingleSession = jingleSession;
  1192. this.room.connectionTimes['session.initiate'] = now;
  1193. // Log "session.restart"
  1194. if (this.wasStopped) {
  1195. Statistics.sendEventToAll('session.restart');
  1196. }
  1197. // add info whether call is cross-region
  1198. let crossRegion = null;
  1199. if (this.options.config && this.options.config.deploymentInfo
  1200. && typeof this.options.config.deploymentInfo.crossRegion
  1201. !== 'undefined') {
  1202. crossRegion = this.options.config.deploymentInfo.crossRegion;
  1203. }
  1204. Statistics.analytics.sendEvent(
  1205. 'session.initiate', {
  1206. value: now - this.room.connectionTimes['muc.joined'],
  1207. label: crossRegion
  1208. });
  1209. try {
  1210. jingleSession.initialize(false /* initiator */, this.room, this.rtc);
  1211. } catch (error) {
  1212. GlobalOnErrorHandler.callErrorHandler(error);
  1213. }
  1214. // Open a channel with the videobridge.
  1215. this._setBridgeChannel(jingleOffer, jingleSession.peerconnection);
  1216. // Add local tracks to the session
  1217. try {
  1218. jingleSession.acceptOffer(
  1219. jingleOffer,
  1220. () => {
  1221. // If for any reason invite for the JVB session arrived after
  1222. // the P2P has been established already the media transfer needs
  1223. // to be turned off here.
  1224. if (this.isP2PActive() && this.jvbJingleSession) {
  1225. this._suspendMediaTransferForJvbConnection();
  1226. }
  1227. },
  1228. error => {
  1229. GlobalOnErrorHandler.callErrorHandler(error);
  1230. logger.error(
  1231. 'Failed to accept incoming Jingle session', error);
  1232. },
  1233. this.getLocalTracks()
  1234. );
  1235. // Start callstats as soon as peerconnection is initialized,
  1236. // do not wait for XMPPEvents.PEERCONNECTION_READY, as it may never
  1237. // happen in case if user doesn't have or denied permission to
  1238. // both camera and microphone.
  1239. logger.info('Starting CallStats for JVB connection...');
  1240. this.statistics.startCallStats(
  1241. this.jvbJingleSession.peerconnection,
  1242. 'jitsi' /* Remote user ID for JVB is 'jitsi' */);
  1243. this.statistics.startRemoteStats(this.jvbJingleSession.peerconnection);
  1244. } catch (e) {
  1245. GlobalOnErrorHandler.callErrorHandler(e);
  1246. logger.error(e);
  1247. }
  1248. };
  1249. /**
  1250. * Sets the BridgeChannel.
  1251. *
  1252. * @param {jQuery} offerIq a jQuery selector pointing to the jingle element of
  1253. * the offer IQ which may carry the WebSocket URL for the 'websocket'
  1254. * BridgeChannel mode.
  1255. * @param {TraceablePeerConnection} pc the peer connection which will be used
  1256. * to listen for new WebRTC Data Channels (in the 'datachannel' mode).
  1257. */
  1258. JitsiConference.prototype._setBridgeChannel = function(offerIq, pc) {
  1259. let wsUrl = null;
  1260. const webSocket
  1261. = $(offerIq)
  1262. .find('>content>transport>web-socket')
  1263. .first();
  1264. if (webSocket.length === 1) {
  1265. wsUrl = webSocket[0].getAttribute('url');
  1266. }
  1267. let bridgeChannelType;
  1268. switch (this.options.config.openBridgeChannel) {
  1269. case 'datachannel':
  1270. case true:
  1271. case undefined:
  1272. bridgeChannelType = 'datachannel';
  1273. break;
  1274. case 'websocket':
  1275. bridgeChannelType = 'websocket';
  1276. break;
  1277. }
  1278. if (bridgeChannelType === 'datachannel'
  1279. && !RTCBrowserType.supportsDataChannels()) {
  1280. bridgeChannelType = 'websocket';
  1281. }
  1282. if (bridgeChannelType === 'datachannel') {
  1283. this.rtc.initializeBridgeChannel(pc, null);
  1284. } else if (bridgeChannelType === 'websocket' && wsUrl) {
  1285. this.rtc.initializeBridgeChannel(null, wsUrl);
  1286. }
  1287. };
  1288. /**
  1289. * Rejects incoming Jingle call with 'security-error'. Method should be used to
  1290. * reject calls initiated by unauthorised entities.
  1291. * @param {JingleSessionPC} jingleSession the session instance to be rejected.
  1292. * @private
  1293. */
  1294. JitsiConference.prototype._rejectIncomingCallNonModerator
  1295. = function(jingleSession) {
  1296. this._rejectIncomingCall(
  1297. jingleSession,
  1298. {
  1299. reasonTag: 'security-error',
  1300. reasonMsg: 'Only focus can start new sessions',
  1301. errorMsg: 'Rejecting session-initiate from non-focus and'
  1302. + `non-moderator user: ${jingleSession.peerjid}`
  1303. });
  1304. };
  1305. /**
  1306. * Rejects incoming Jingle call.
  1307. * @param {JingleSessionPC} jingleSession the session instance to be rejected.
  1308. * @param {object} [options]
  1309. * @param {string} options.reasonTag the name of the reason element as defined
  1310. * by Jingle
  1311. * @param {string} options.reasonMsg the reason description which will
  1312. * be included in Jingle 'session-terminate' message.
  1313. * @param {string} options.errorMsg an error message to be logged on global
  1314. * error handler
  1315. * @private
  1316. */
  1317. JitsiConference.prototype._rejectIncomingCall
  1318. = function(jingleSession, options) {
  1319. if (options && options.errorMsg) {
  1320. GlobalOnErrorHandler.callErrorHandler(new Error(options.errorMsg));
  1321. }
  1322. // Terminate the jingle session with a reason
  1323. jingleSession.terminate(
  1324. null /* success callback => we don't care */,
  1325. error => {
  1326. logger.warn(
  1327. 'An error occurred while trying to terminate'
  1328. + ' invalid Jingle session', error);
  1329. }, {
  1330. reason: options && options.reasonTag,
  1331. reasonDescription: options && options.reasonMsg,
  1332. sendSessionTerminate: true
  1333. });
  1334. };
  1335. /**
  1336. * Handles the call ended event.
  1337. * @param {JingleSessionPC} jingleSession the jingle session which has been
  1338. * terminated.
  1339. * @param {String} reasonCondition the Jingle reason condition.
  1340. * @param {String|null} reasonText human readable reason text which may provide
  1341. * more details about why the call has been terminated.
  1342. */
  1343. JitsiConference.prototype.onCallEnded
  1344. = function(jingleSession, reasonCondition, reasonText) {
  1345. logger.info(
  1346. `Call ended: ${reasonCondition} - ${reasonText
  1347. } P2P ?${jingleSession.isP2P}`);
  1348. if (jingleSession === this.jvbJingleSession) {
  1349. this.wasStopped = true;
  1350. // Send session.terminate event
  1351. Statistics.sendEventToAll('session.terminate');
  1352. // Stop the stats
  1353. if (this.statistics) {
  1354. this.statistics.stopRemoteStats(
  1355. this.jvbJingleSession.peerconnection);
  1356. logger.info('Stopping JVB CallStats');
  1357. this.statistics.stopCallStats(
  1358. this.jvbJingleSession.peerconnection);
  1359. }
  1360. // Current JVB JingleSession is no longer valid, so set it to null
  1361. this.jvbJingleSession = null;
  1362. // Let the RTC service do any cleanups
  1363. this.rtc.onCallEnded();
  1364. } else if (jingleSession === this.p2pJingleSession) {
  1365. // It's the responder who decides to enforce JVB mode, so that both
  1366. // initiator and responder are aware if it was intentional.
  1367. if (reasonCondition === 'decline' && reasonText === 'force JVB121') {
  1368. logger.info('In forced JVB 121 mode...');
  1369. Statistics.analytics.addPermanentProperties({ forceJvb121: true });
  1370. } else if (reasonCondition === 'connectivity-error'
  1371. && reasonText === 'ICE FAILED') {
  1372. // It can happen that the other peer detects ICE failed and
  1373. // terminates the session, before we get the event on our side.
  1374. // But we are able to parse the reason and mark it here.
  1375. Statistics.analytics.addPermanentProperties({ p2pFailed: true });
  1376. }
  1377. this._stopP2PSession();
  1378. } else {
  1379. logger.error(
  1380. 'Received onCallEnded for invalid session',
  1381. jingleSession.sid,
  1382. jingleSession.peerjid,
  1383. reasonCondition,
  1384. reasonText);
  1385. }
  1386. };
  1387. /**
  1388. * Handles the suspend detected event. Leaves the room and fires suspended.
  1389. * @param {JingleSessionPC} jingleSession
  1390. */
  1391. JitsiConference.prototype.onSuspendDetected = function(jingleSession) {
  1392. if (!jingleSession.isP2P) {
  1393. this.leave();
  1394. this.eventEmitter.emit(JitsiConferenceEvents.SUSPEND_DETECTED);
  1395. }
  1396. };
  1397. JitsiConference.prototype.updateDTMFSupport = function() {
  1398. let somebodySupportsDTMF = false;
  1399. const participants = this.getParticipants();
  1400. // check if at least 1 participant supports DTMF
  1401. for (let i = 0; i < participants.length; i += 1) {
  1402. if (participants[i].supportsDTMF()) {
  1403. somebodySupportsDTMF = true;
  1404. break;
  1405. }
  1406. }
  1407. if (somebodySupportsDTMF !== this.somebodySupportsDTMF) {
  1408. this.somebodySupportsDTMF = somebodySupportsDTMF;
  1409. this.eventEmitter.emit(
  1410. JitsiConferenceEvents.DTMF_SUPPORT_CHANGED,
  1411. somebodySupportsDTMF);
  1412. }
  1413. };
  1414. /**
  1415. * Allows to check if there is at least one user in the conference
  1416. * that supports DTMF.
  1417. * @returns {boolean} true if somebody supports DTMF, false otherwise
  1418. */
  1419. JitsiConference.prototype.isDTMFSupported = function() {
  1420. return this.somebodySupportsDTMF;
  1421. };
  1422. /**
  1423. * Returns the local user's ID
  1424. * @return {string} local user's ID
  1425. */
  1426. JitsiConference.prototype.myUserId = function() {
  1427. return (
  1428. this.room
  1429. && this.room.myroomjid
  1430. ? Strophe.getResourceFromJid(this.room.myroomjid)
  1431. : null);
  1432. };
  1433. JitsiConference.prototype.sendTones = function(tones, duration, pause) {
  1434. if (!this.dtmfManager) {
  1435. const peerConnection = this.getActivePeerConnection();
  1436. if (!peerConnection) {
  1437. logger.warn('cannot sendTones: no peer connection');
  1438. return;
  1439. }
  1440. const localAudio = this.getLocalAudioTrack();
  1441. if (!localAudio) {
  1442. logger.warn('cannot sendTones: no local audio stream');
  1443. return;
  1444. }
  1445. this.dtmfManager = new JitsiDTMFManager(localAudio, peerConnection);
  1446. }
  1447. this.dtmfManager.sendTones(tones, duration, pause);
  1448. };
  1449. /**
  1450. * Returns true if recording is supported and false if not.
  1451. */
  1452. JitsiConference.prototype.isRecordingSupported = function() {
  1453. if (this.room) {
  1454. return this.room.isRecordingSupported();
  1455. }
  1456. return false;
  1457. };
  1458. /**
  1459. * Returns null if the recording is not supported, "on" if the recording started
  1460. * and "off" if the recording is not started.
  1461. */
  1462. JitsiConference.prototype.getRecordingState = function() {
  1463. return this.room ? this.room.getRecordingState() : undefined;
  1464. };
  1465. /**
  1466. * Returns the url of the recorded video.
  1467. */
  1468. JitsiConference.prototype.getRecordingURL = function() {
  1469. return this.room ? this.room.getRecordingURL() : null;
  1470. };
  1471. /**
  1472. * Starts/stops the recording
  1473. */
  1474. JitsiConference.prototype.toggleRecording = function(options) {
  1475. if (this.room) {
  1476. return this.room.toggleRecording(options, (status, error) => {
  1477. this.eventEmitter.emit(
  1478. JitsiConferenceEvents.RECORDER_STATE_CHANGED, status, error);
  1479. });
  1480. }
  1481. this.eventEmitter.emit(
  1482. JitsiConferenceEvents.RECORDER_STATE_CHANGED, 'error',
  1483. new Error('The conference is not created yet!'));
  1484. };
  1485. /**
  1486. * Returns true if the SIP calls are supported and false otherwise
  1487. */
  1488. JitsiConference.prototype.isSIPCallingSupported = function() {
  1489. if (this.room) {
  1490. return this.room.isSIPCallingSupported();
  1491. }
  1492. return false;
  1493. };
  1494. /**
  1495. * Dials a number.
  1496. * @param number the number
  1497. */
  1498. JitsiConference.prototype.dial = function(number) {
  1499. if (this.room) {
  1500. return this.room.dial(number);
  1501. }
  1502. return new Promise((resolve, reject) => {
  1503. reject(new Error('The conference is not created yet!'));
  1504. });
  1505. };
  1506. /**
  1507. * Hangup an existing call
  1508. */
  1509. JitsiConference.prototype.hangup = function() {
  1510. if (this.room) {
  1511. return this.room.hangup();
  1512. }
  1513. return new Promise((resolve, reject) => {
  1514. reject(new Error('The conference is not created yet!'));
  1515. });
  1516. };
  1517. /**
  1518. * Starts the transcription service.
  1519. */
  1520. JitsiConference.prototype.startTranscriber = function() {
  1521. return this.dial('jitsi_meet_transcribe');
  1522. };
  1523. /**
  1524. * Stops the transcription service.
  1525. */
  1526. JitsiConference.prototype.stopTranscriber = JitsiConference.prototype.hangup;
  1527. /**
  1528. * Returns the phone number for joining the conference.
  1529. */
  1530. JitsiConference.prototype.getPhoneNumber = function() {
  1531. if (this.room) {
  1532. return this.room.getPhoneNumber();
  1533. }
  1534. return null;
  1535. };
  1536. /**
  1537. * Returns the pin for joining the conference with phone.
  1538. */
  1539. JitsiConference.prototype.getPhonePin = function() {
  1540. if (this.room) {
  1541. return this.room.getPhonePin();
  1542. }
  1543. return null;
  1544. };
  1545. /**
  1546. * Will return P2P or JVB <tt>TraceablePeerConnection</tt> depending on
  1547. * which connection is currently active.
  1548. *
  1549. * @return {TraceablePeerConnection|null} null if there isn't any active
  1550. * <tt>TraceablePeerConnection</tt> currently available.
  1551. * @public (FIXME how to make package local ?)
  1552. */
  1553. JitsiConference.prototype.getActivePeerConnection = function() {
  1554. if (this.isP2PActive()) {
  1555. return this.p2pJingleSession.peerconnection;
  1556. }
  1557. return this.jvbJingleSession ? this.jvbJingleSession.peerconnection : null;
  1558. };
  1559. /**
  1560. * Returns the connection state for the current room. Its ice connection state
  1561. * for its session.
  1562. * NOTE that "completed" ICE state which can appear on the P2P connection will
  1563. * be converted to "connected".
  1564. * @return {string|null} ICE state name or <tt>null</tt> if there is no active
  1565. * peer connection at this time.
  1566. */
  1567. JitsiConference.prototype.getConnectionState = function() {
  1568. const peerConnection = this.getActivePeerConnection();
  1569. return peerConnection ? peerConnection.getConnectionState() : null;
  1570. };
  1571. /**
  1572. * Make all new participants mute their audio/video on join.
  1573. * @param policy {Object} object with 2 boolean properties for video and audio:
  1574. * @param {boolean} audio if audio should be muted.
  1575. * @param {boolean} video if video should be muted.
  1576. */
  1577. JitsiConference.prototype.setStartMutedPolicy = function(policy) {
  1578. if (!this.isModerator()) {
  1579. return;
  1580. }
  1581. this.startMutedPolicy = policy;
  1582. this.room.removeFromPresence('startmuted');
  1583. this.room.addToPresence('startmuted', {
  1584. attributes: {
  1585. audio: policy.audio,
  1586. video: policy.video,
  1587. xmlns: 'http://jitsi.org/jitmeet/start-muted'
  1588. }
  1589. });
  1590. this.room.sendPresence();
  1591. };
  1592. /**
  1593. * Returns current start muted policy
  1594. * @returns {Object} with 2 properties - audio and video.
  1595. */
  1596. JitsiConference.prototype.getStartMutedPolicy = function() {
  1597. return this.startMutedPolicy;
  1598. };
  1599. /**
  1600. * Check if audio is muted on join.
  1601. */
  1602. JitsiConference.prototype.isStartAudioMuted = function() {
  1603. return this.startAudioMuted;
  1604. };
  1605. /**
  1606. * Check if video is muted on join.
  1607. */
  1608. JitsiConference.prototype.isStartVideoMuted = function() {
  1609. return this.startVideoMuted;
  1610. };
  1611. /**
  1612. * Get object with internal logs.
  1613. */
  1614. JitsiConference.prototype.getLogs = function() {
  1615. const data = this.xmpp.getJingleLog();
  1616. const metadata = {};
  1617. metadata.time = new Date();
  1618. metadata.url = window.location.href;
  1619. metadata.ua = navigator.userAgent;
  1620. const log = this.xmpp.getXmppLog();
  1621. if (log) {
  1622. metadata.xmpp = log;
  1623. }
  1624. data.metadata = metadata;
  1625. return data;
  1626. };
  1627. /**
  1628. * Returns measured connectionTimes.
  1629. */
  1630. JitsiConference.prototype.getConnectionTimes = function() {
  1631. return this.room.connectionTimes;
  1632. };
  1633. /**
  1634. * Sets a property for the local participant.
  1635. */
  1636. JitsiConference.prototype.setLocalParticipantProperty = function(name, value) {
  1637. this.sendCommand(`jitsi_participant_${name}`, { value });
  1638. };
  1639. /**
  1640. * Sends the given feedback through CallStats if enabled.
  1641. *
  1642. * @param overallFeedback an integer between 1 and 5 indicating the
  1643. * user feedback
  1644. * @param detailedFeedback detailed feedback from the user. Not yet used
  1645. */
  1646. JitsiConference.prototype.sendFeedback
  1647. = function(overallFeedback, detailedFeedback) {
  1648. this.statistics.sendFeedback(overallFeedback, detailedFeedback);
  1649. };
  1650. /**
  1651. * Returns true if the callstats integration is enabled, otherwise returns
  1652. * false.
  1653. *
  1654. * @returns true if the callstats integration is enabled, otherwise returns
  1655. * false.
  1656. */
  1657. JitsiConference.prototype.isCallstatsEnabled = function() {
  1658. return this.statistics.isCallstatsEnabled();
  1659. };
  1660. /**
  1661. * Handles track attached to container (Calls associateStreamWithVideoTag method
  1662. * from statistics module)
  1663. * @param {JitsiLocalTrack|JitsiRemoteTrack} track the track
  1664. * @param container the container
  1665. */
  1666. JitsiConference.prototype._onTrackAttach = function(track, container) {
  1667. const isLocal = track.isLocal();
  1668. let ssrc = null;
  1669. const isP2P = track.isP2P;
  1670. const remoteUserId = isP2P ? track.getParticipantId() : 'jitsi';
  1671. const peerConnection
  1672. = isP2P
  1673. ? this.p2pJingleSession && this.p2pJingleSession.peerconnection
  1674. : this.jvbJingleSession && this.jvbJingleSession.peerconnection;
  1675. if (isLocal) {
  1676. // Local tracks have SSRC stored on per peer connection basis
  1677. if (peerConnection) {
  1678. ssrc = peerConnection.getLocalSSRC(track);
  1679. }
  1680. } else {
  1681. ssrc = track.getSSRC();
  1682. }
  1683. if (!container.id || !ssrc || !peerConnection) {
  1684. return;
  1685. }
  1686. this.statistics.associateStreamWithVideoTag(
  1687. peerConnection,
  1688. ssrc,
  1689. isLocal,
  1690. remoteUserId,
  1691. track.getUsageLabel(),
  1692. container.id);
  1693. };
  1694. /**
  1695. * Logs an "application log" message.
  1696. * @param message {string} The message to log. Note that while this can be a
  1697. * generic string, the convention used by lib-jitsi-meet and jitsi-meet is to
  1698. * log valid JSON strings, with an "id" field used for distinguishing between
  1699. * message types. E.g.: {id: "recorder_status", status: "off"}
  1700. */
  1701. JitsiConference.prototype.sendApplicationLog = function(message) {
  1702. Statistics.sendLog(message);
  1703. };
  1704. /**
  1705. * Checks if the user identified by given <tt>mucJid</tt> is the conference
  1706. * focus.
  1707. * @param mucJid the full MUC address of the user to be checked.
  1708. * @returns {boolean|null} <tt>true</tt> if MUC user is the conference focus,
  1709. * <tt>false</tt> when is not. <tt>null</tt> if we're not in the MUC anymore and
  1710. * are unable to figure out the status or if given <tt>mucJid</tt> is invalid.
  1711. */
  1712. JitsiConference.prototype._isFocus = function(mucJid) {
  1713. return this.room ? this.room.isFocus(mucJid) : null;
  1714. };
  1715. /**
  1716. * Fires CONFERENCE_FAILED event with INCOMPATIBLE_SERVER_VERSIONS parameter
  1717. */
  1718. JitsiConference.prototype._fireIncompatibleVersionsEvent = function() {
  1719. this.eventEmitter.emit(JitsiConferenceEvents.CONFERENCE_FAILED,
  1720. JitsiConferenceErrors.INCOMPATIBLE_SERVER_VERSIONS);
  1721. };
  1722. /**
  1723. * Sends a message via the data channel.
  1724. * @param to {string} the id of the endpoint that should receive the message.
  1725. * If "" the message will be sent to all participants.
  1726. * @param payload {object} the payload of the message.
  1727. * @throws NetworkError or InvalidStateError or Error if the operation fails.
  1728. */
  1729. JitsiConference.prototype.sendEndpointMessage = function(to, payload) {
  1730. this.rtc.sendChannelMessage(to, payload);
  1731. };
  1732. /**
  1733. * Sends a broadcast message via the data channel.
  1734. * @param payload {object} the payload of the message.
  1735. * @throws NetworkError or InvalidStateError or Error if the operation fails.
  1736. */
  1737. JitsiConference.prototype.broadcastEndpointMessage = function(payload) {
  1738. this.sendEndpointMessage('', payload);
  1739. };
  1740. JitsiConference.prototype.isConnectionInterrupted = function() {
  1741. return this.isP2PActive()
  1742. ? this.isP2PConnectionInterrupted : this.isJvbConnectionInterrupted;
  1743. };
  1744. /**
  1745. * Handles {@link XMPPEvents.CONNECTION_INTERRUPTED}
  1746. * @param {JingleSessionPC} session
  1747. * @private
  1748. */
  1749. JitsiConference.prototype._onIceConnectionInterrupted = function(session) {
  1750. if (session.isP2P) {
  1751. this.isP2PConnectionInterrupted = true;
  1752. } else {
  1753. this.isJvbConnectionInterrupted = true;
  1754. }
  1755. if (session.isP2P === this.isP2PActive()) {
  1756. this.eventEmitter.emit(JitsiConferenceEvents.CONNECTION_INTERRUPTED);
  1757. }
  1758. };
  1759. /**
  1760. * Handles {@link XMPPEvents.CONNECTION_ICE_FAILED}
  1761. * @param {JingleSessionPC} session
  1762. * @private
  1763. */
  1764. JitsiConference.prototype._onIceConnectionFailed = function(session) {
  1765. // We do nothing for the JVB connection, because it's up to the Jicofo to
  1766. // eventually come up with the new offer (at least for the time being).
  1767. if (session.isP2P) {
  1768. // Add p2pFailed property to analytics to distinguish, between "good"
  1769. // and "bad" connection
  1770. Statistics.analytics.addPermanentProperties({ p2pFailed: true });
  1771. // Log analytics event, but only for the initiator to not count it twice
  1772. if (this.p2pJingleSession && this.p2pJingleSession.isInitiator) {
  1773. Statistics.sendEventToAll('p2p.failed');
  1774. }
  1775. this._stopP2PSession('connectivity-error', 'ICE FAILED');
  1776. }
  1777. };
  1778. /**
  1779. * Handles {@link XMPPEvents.CONNECTION_RESTORED}
  1780. * @param {JingleSessionPC} session
  1781. * @private
  1782. */
  1783. JitsiConference.prototype._onIceConnectionRestored = function(session) {
  1784. if (session.isP2P) {
  1785. this.isP2PConnectionInterrupted = false;
  1786. } else {
  1787. this.isJvbConnectionInterrupted = false;
  1788. }
  1789. if (session.isP2P === this.isP2PActive()) {
  1790. this.eventEmitter.emit(JitsiConferenceEvents.CONNECTION_RESTORED);
  1791. }
  1792. };
  1793. /**
  1794. * Accept incoming P2P Jingle call.
  1795. * @param {JingleSessionPC} jingleSession the session instance
  1796. * @param {jQuery} jingleOffer a jQuery selector pointing to 'jingle' IQ element
  1797. * @private
  1798. */
  1799. JitsiConference.prototype._acceptP2PIncomingCall
  1800. = function(jingleSession, jingleOffer) {
  1801. this.isP2PConnectionInterrupted = false;
  1802. // Accept the offer
  1803. this.p2pJingleSession = jingleSession;
  1804. this.p2pJingleSession.initialize(
  1805. false /* initiator */, this.room, this.rtc);
  1806. logger.info('Starting CallStats for P2P connection...');
  1807. this.statistics.startCallStats(
  1808. this.p2pJingleSession.peerconnection,
  1809. Strophe.getResourceFromJid(this.p2pJingleSession.peerjid));
  1810. const localTracks = this.getLocalTracks();
  1811. this.p2pJingleSession.acceptOffer(
  1812. jingleOffer,
  1813. () => {
  1814. logger.debug('Got RESULT for P2P "session-accept"');
  1815. },
  1816. error => {
  1817. logger.error(
  1818. 'Failed to accept incoming P2P Jingle session', error);
  1819. },
  1820. localTracks);
  1821. };
  1822. /**
  1823. * Adds remote tracks to the conference associated with the JVB session.
  1824. * @private
  1825. */
  1826. JitsiConference.prototype._addRemoteJVBTracks = function() {
  1827. this._addRemoteTracks(
  1828. 'JVB', this.jvbJingleSession.peerconnection.getRemoteTracks());
  1829. };
  1830. /**
  1831. * Adds remote tracks to the conference associated with the P2P session.
  1832. * @private
  1833. */
  1834. JitsiConference.prototype._addRemoteP2PTracks = function() {
  1835. this._addRemoteTracks(
  1836. 'P2P', this.p2pJingleSession.peerconnection.getRemoteTracks());
  1837. };
  1838. /**
  1839. * Generates fake "remote track added" events for given Jingle session.
  1840. * @param {string} logName the session's nickname which will appear in log
  1841. * messages.
  1842. * @param {Array<JitsiRemoteTrack>} remoteTracks the tracks that will be added
  1843. * @private
  1844. */
  1845. JitsiConference.prototype._addRemoteTracks = function(logName, remoteTracks) {
  1846. for (const track of remoteTracks) {
  1847. logger.info(`Adding remote ${logName} track: ${track}`);
  1848. this.rtc.eventEmitter.emit(RTCEvents.REMOTE_TRACK_ADDED, track);
  1849. }
  1850. };
  1851. /**
  1852. * Called when {@link XMPPEvents.CONNECTION_ESTABLISHED} event is
  1853. * triggered for a {@link JingleSessionPC}. Switches the conference to use
  1854. * the P2P connection if the event comes from the P2P session.
  1855. * @param {JingleSessionPC} jingleSession the session instance.
  1856. * @private
  1857. */
  1858. JitsiConference.prototype._onIceConnectionEstablished
  1859. = function(jingleSession) {
  1860. if (this.p2pJingleSession !== null) {
  1861. // store the establishment time of the p2p session as a field of the
  1862. // JitsiConference because the p2pJingleSession might get disposed (thus
  1863. // the value is lost).
  1864. this.p2pEstablishmentDuration
  1865. = this.p2pJingleSession.establishmentDuration;
  1866. }
  1867. if (this.jvbJingleSession !== null) {
  1868. this.jvbEstablishmentDuration
  1869. = this.jvbJingleSession.establishmentDuration;
  1870. }
  1871. let done = false;
  1872. const forceJVB121Ratio = this.options.config.forceJVB121Ratio;
  1873. // We don't care about the JVB case, there's nothing to be done
  1874. if (!jingleSession.isP2P) {
  1875. done = true;
  1876. } else if (this.p2pJingleSession !== jingleSession) {
  1877. logger.error('CONNECTION_ESTABLISHED - wrong P2P session instance ?!');
  1878. done = true;
  1879. } else if (!jingleSession.isInitiator
  1880. && typeof forceJVB121Ratio === 'number'
  1881. && Math.random() < forceJVB121Ratio) {
  1882. logger.info(`Forcing JVB 121 mode (ratio=${forceJVB121Ratio})...`);
  1883. Statistics.analytics.addPermanentProperties({ forceJvb121: true });
  1884. this._stopP2PSession('decline', 'force JVB121');
  1885. done = true;
  1886. }
  1887. if (!isNaN(this.p2pEstablishmentDuration)
  1888. && !isNaN(this.jvbEstablishmentDuration)) {
  1889. const establishmentDurationDiff
  1890. = this.p2pEstablishmentDuration - this.jvbEstablishmentDuration;
  1891. Statistics.analytics.sendEvent(
  1892. 'ice.establishmentDurationDiff', {
  1893. 'value': establishmentDurationDiff
  1894. });
  1895. }
  1896. if (done) {
  1897. return;
  1898. }
  1899. // Update P2P status and emit events
  1900. this._setP2PStatus(true);
  1901. // Remove remote tracks
  1902. if (this.jvbJingleSession) {
  1903. this._removeRemoteJVBTracks();
  1904. } else {
  1905. logger.info('Not removing remote JVB tracks - no session yet');
  1906. }
  1907. // Add remote tracks
  1908. this._addRemoteP2PTracks();
  1909. // Stop media transfer over the JVB connection
  1910. if (this.jvbJingleSession) {
  1911. this._suspendMediaTransferForJvbConnection();
  1912. }
  1913. // Start remote stats
  1914. logger.info('Starting remote stats with p2p connection');
  1915. this.statistics.startRemoteStats(this.p2pJingleSession.peerconnection);
  1916. // Log the P2P established event
  1917. if (this.p2pJingleSession.isInitiator) {
  1918. Statistics.sendEventToAll('p2p.established');
  1919. }
  1920. };
  1921. /**
  1922. * Clears the deferred start P2P task if it has been scheduled.
  1923. * @private
  1924. */
  1925. JitsiConference.prototype._maybeClearDeferredStartP2P = function() {
  1926. if (this.deferredStartP2PTask) {
  1927. logger.info('Cleared deferred start P2P task');
  1928. clearTimeout(this.deferredStartP2PTask);
  1929. this.deferredStartP2PTask = null;
  1930. }
  1931. };
  1932. /**
  1933. * Removes from the conference remote tracks associated with the JVB
  1934. * connection.
  1935. * @private
  1936. */
  1937. JitsiConference.prototype._removeRemoteJVBTracks = function() {
  1938. this._removeRemoteTracks(
  1939. 'JVB', this.jvbJingleSession.peerconnection.getRemoteTracks());
  1940. };
  1941. /**
  1942. * Removes from the conference remote tracks associated with the P2P
  1943. * connection.
  1944. * @private
  1945. */
  1946. JitsiConference.prototype._removeRemoteP2PTracks = function() {
  1947. this._removeRemoteTracks(
  1948. 'P2P', this.p2pJingleSession.peerconnection.getRemoteTracks());
  1949. };
  1950. /**
  1951. * Generates fake "remote track removed" events for given Jingle session.
  1952. * @param {string} sessionNickname the session's nickname which will appear in
  1953. * log messages.
  1954. * @param {Array<JitsiRemoteTrack>} remoteTracks the tracks that will be removed
  1955. * @private
  1956. */
  1957. JitsiConference.prototype._removeRemoteTracks
  1958. = function(sessionNickname, remoteTracks) {
  1959. for (const track of remoteTracks) {
  1960. logger.info(`Removing remote ${sessionNickname} track: ${track}`);
  1961. this.rtc.eventEmitter.emit(RTCEvents.REMOTE_TRACK_REMOVED, track);
  1962. }
  1963. };
  1964. /**
  1965. * Resumes media transfer over the JVB connection.
  1966. * @private
  1967. */
  1968. JitsiConference.prototype._resumeMediaTransferForJvbConnection = function() {
  1969. logger.info('Resuming media transfer over the JVB connection...');
  1970. this.jvbJingleSession.setMediaTransferActive(true, true).then(
  1971. () => {
  1972. logger.info('Resumed media transfer over the JVB connection!');
  1973. },
  1974. error => {
  1975. logger.error(
  1976. 'Failed to resume media transfer over the JVB connection:',
  1977. error);
  1978. });
  1979. };
  1980. /**
  1981. * Sets new P2P status and updates some events/states hijacked from
  1982. * the <tt>JitsiConference</tt>.
  1983. * @param {boolean} newStatus the new P2P status value, <tt>true</tt> means that
  1984. * P2P is now in use, <tt>false</tt> means that the JVB connection is now in use
  1985. * @private
  1986. */
  1987. JitsiConference.prototype._setP2PStatus = function(newStatus) {
  1988. if (this.p2p === newStatus) {
  1989. logger.debug(`Called _setP2PStatus with the same status: ${newStatus}`);
  1990. return;
  1991. }
  1992. this.p2p = newStatus;
  1993. if (newStatus) {
  1994. logger.info('Peer to peer connection established!');
  1995. // When we end up in a valid P2P session need to reset the properties
  1996. // in case they have persisted, after session with another peer.
  1997. Statistics.analytics.addPermanentProperties({
  1998. p2pFailed: false,
  1999. forceJvb121: false
  2000. });
  2001. // Sync up video transfer active in case p2pJingleSession not existed
  2002. // when the lastN value was being adjusted.
  2003. const isVideoActive = this.rtc.getLastN() !== 0;
  2004. this.p2pJingleSession
  2005. .setMediaTransferActive(true, isVideoActive)
  2006. .catch(error => {
  2007. logger.error(
  2008. 'Failed to sync up P2P video transfer status'
  2009. + `(${isVideoActive})`, error);
  2010. });
  2011. } else {
  2012. logger.info('Peer to peer connection closed!');
  2013. }
  2014. // Put the JVB connection on hold/resume
  2015. if (this.jvbJingleSession) {
  2016. this.statistics.sendConnectionResumeOrHoldEvent(
  2017. this.jvbJingleSession.peerconnection, !newStatus);
  2018. }
  2019. // Clear dtmfManager, so that it can be recreated with new connection
  2020. this.dtmfManager = null;
  2021. // Update P2P status
  2022. this.eventEmitter.emit(
  2023. JitsiConferenceEvents.P2P_STATUS,
  2024. this,
  2025. this.p2p);
  2026. // Refresh connection interrupted/restored
  2027. this.eventEmitter.emit(
  2028. this.isConnectionInterrupted()
  2029. ? JitsiConferenceEvents.CONNECTION_INTERRUPTED
  2030. : JitsiConferenceEvents.CONNECTION_RESTORED);
  2031. };
  2032. /**
  2033. * Starts new P2P session.
  2034. * @param {string} peerJid the JID of the remote participant
  2035. * @private
  2036. */
  2037. JitsiConference.prototype._startP2PSession = function(peerJid) {
  2038. this._maybeClearDeferredStartP2P();
  2039. if (this.p2pJingleSession) {
  2040. logger.error('P2P session already started!');
  2041. return;
  2042. }
  2043. this.isP2PConnectionInterrupted = false;
  2044. this.p2pJingleSession
  2045. = this.xmpp.connection.jingle.newP2PJingleSession(
  2046. this.room.myroomjid,
  2047. peerJid);
  2048. logger.info('Created new P2P JingleSession', this.room.myroomjid, peerJid);
  2049. this.p2pJingleSession.initialize(true /* initiator */, this.room, this.rtc);
  2050. logger.info('Starting CallStats for P2P connection...');
  2051. this.statistics.startCallStats(
  2052. this.p2pJingleSession.peerconnection,
  2053. Strophe.getResourceFromJid(this.p2pJingleSession.peerjid));
  2054. // NOTE one may consider to start P2P with the local tracks detached,
  2055. // but no data will be sent until ICE succeeds anyway. And we switch
  2056. // immediately once the P2P ICE connects.
  2057. const localTracks = this.getLocalTracks();
  2058. this.p2pJingleSession.invite(localTracks);
  2059. };
  2060. /**
  2061. * Suspends media transfer over the JVB connection.
  2062. * @private
  2063. */
  2064. JitsiConference.prototype._suspendMediaTransferForJvbConnection = function() {
  2065. logger.info('Suspending media transfer over the JVB connection...');
  2066. this.jvbJingleSession.setMediaTransferActive(false, false).then(
  2067. () => {
  2068. logger.info('Suspended media transfer over the JVB connection !');
  2069. },
  2070. error => {
  2071. logger.error(
  2072. 'Failed to suspend media transfer over the JVB connection:',
  2073. error);
  2074. });
  2075. };
  2076. /**
  2077. * Method when called will decide whether it's the time to start or stop
  2078. * the P2P session.
  2079. * @param {boolean} userLeftEvent if <tt>true</tt> it means that the call
  2080. * originates from the user left event.
  2081. * @private
  2082. */
  2083. JitsiConference.prototype._maybeStartOrStopP2P = function(userLeftEvent) {
  2084. if (!RTCBrowserType.isP2PSupported()
  2085. || !this.isP2PEnabled()
  2086. || this.isP2PTestModeEnabled()) {
  2087. logger.info('Auto P2P disabled');
  2088. return;
  2089. }
  2090. const peers = this.getParticipants();
  2091. const peerCount = peers.length;
  2092. const isModerator = this.isModerator();
  2093. // FIXME 1 peer and it must *support* P2P switching
  2094. const shouldBeInP2P = peerCount === 1;
  2095. logger.debug(
  2096. `P2P? isModerator: ${isModerator
  2097. }, peerCount: ${peerCount} => ${shouldBeInP2P}`);
  2098. // Clear deferred "start P2P" task
  2099. if (!shouldBeInP2P && this.deferredStartP2PTask) {
  2100. this._maybeClearDeferredStartP2P();
  2101. }
  2102. // Start peer to peer session
  2103. if (isModerator && !this.p2pJingleSession && shouldBeInP2P) {
  2104. const peer = peerCount && peers[0];
  2105. // Everyone is a moderator ?
  2106. if (isModerator && peer.getRole() === 'moderator') {
  2107. const myId = this.myUserId();
  2108. const peersId = peer.getId();
  2109. if (myId > peersId) {
  2110. logger.debug(
  2111. 'Everyone\'s a moderator - '
  2112. + 'the other peer should start P2P', myId, peersId);
  2113. return;
  2114. } else if (myId === peersId) {
  2115. logger.error('The same IDs ? ', myId, peersId);
  2116. return;
  2117. }
  2118. }
  2119. const jid = peer.getJid();
  2120. if (userLeftEvent) {
  2121. if (this.deferredStartP2PTask) {
  2122. logger.error('Deferred start P2P task\'s been set already!');
  2123. return;
  2124. }
  2125. logger.info(
  2126. `Will start P2P with: ${jid
  2127. } after ${this.backToP2PDelay} seconds...`);
  2128. this.deferredStartP2PTask = setTimeout(
  2129. this._startP2PSession.bind(this, jid),
  2130. this.backToP2PDelay * 1000);
  2131. } else {
  2132. logger.info(`Will start P2P with: ${jid}`);
  2133. this._startP2PSession(jid);
  2134. }
  2135. } else if (this.p2pJingleSession && !shouldBeInP2P) {
  2136. logger.info(`Will stop P2P with: ${this.p2pJingleSession.peerjid}`);
  2137. // Log that there will be a switch back to the JVB connection
  2138. if (this.p2pJingleSession.isInitiator && peerCount > 1) {
  2139. Statistics.sendEventToAll('p2p.switch_to_jvb');
  2140. }
  2141. this._stopP2PSession();
  2142. }
  2143. };
  2144. /**
  2145. * Stops the current P2P session.
  2146. * @param {string} [reason="success"] one of the Jingle "reason" element
  2147. * names as defined by https://xmpp.org/extensions/xep-0166.html#def-reason
  2148. * @param {string} [reasonDescription="Turing off P2P session"] text
  2149. * description that will be included in the session terminate message
  2150. * @private
  2151. */
  2152. JitsiConference.prototype._stopP2PSession
  2153. = function(reason, reasonDescription) {
  2154. if (!this.p2pJingleSession) {
  2155. logger.error('No P2P session to be stopped!');
  2156. return;
  2157. }
  2158. const wasP2PEstablished = this.isP2PActive();
  2159. // Swap remote tracks, but only if the P2P has been fully established
  2160. if (wasP2PEstablished) {
  2161. if (this.jvbJingleSession) {
  2162. this._resumeMediaTransferForJvbConnection();
  2163. }
  2164. // Remove remote P2P tracks
  2165. this._removeRemoteP2PTracks();
  2166. }
  2167. // Stop P2P stats
  2168. logger.info('Stopping remote stats for P2P connection');
  2169. this.statistics.stopRemoteStats(this.p2pJingleSession.peerconnection);
  2170. logger.info('Stopping CallStats for P2P connection');
  2171. this.statistics.stopCallStats(this.p2pJingleSession.peerconnection);
  2172. this.p2pJingleSession.terminate(
  2173. () => {
  2174. logger.info('P2P session terminate RESULT');
  2175. },
  2176. error => {
  2177. // Because both initiator and responder are simultaneously
  2178. // terminating their JingleSessions in case of the 'to JVB switch'
  2179. // when 3rd participant joins, both will dispose their sessions and
  2180. // reply with 'item-not-found' (see strophe.jingle.js). We don't
  2181. // want to log this as an error since it's expected behaviour.
  2182. //
  2183. // We want them both to terminate, because in case of initiator's
  2184. // crash the responder would stay in P2P mode until ICE fails which
  2185. // could take up to 20 seconds.
  2186. //
  2187. // NOTE lack of 'reason' is considered as graceful session terminate
  2188. // where both initiator and responder terminate their sessions
  2189. // simultaneously.
  2190. if (reason) {
  2191. logger.error(
  2192. 'An error occurred while trying to terminate'
  2193. + ' P2P Jingle session', error);
  2194. }
  2195. }, {
  2196. reason: reason ? reason : 'success',
  2197. reasonDescription: reasonDescription
  2198. ? reasonDescription : 'Turing off P2P session',
  2199. sendSessionTerminate: this.room
  2200. && this.getParticipantById(
  2201. Strophe.getResourceFromJid(this.p2pJingleSession.peerjid))
  2202. });
  2203. this.p2pJingleSession = null;
  2204. // Update P2P status and other affected events/states
  2205. this._setP2PStatus(false);
  2206. if (wasP2PEstablished) {
  2207. // Add back remote JVB tracks
  2208. if (this.jvbJingleSession) {
  2209. this._addRemoteJVBTracks();
  2210. } else {
  2211. logger.info('Not adding remote JVB tracks - no session yet');
  2212. }
  2213. }
  2214. };
  2215. /**
  2216. * Checks whether or not the conference is currently in the peer to peer mode.
  2217. * Being in peer to peer mode means that the direct connection has been
  2218. * established and the P2P connection is being used for media transmission.
  2219. * @return {boolean} <tt>true</tt> if in P2P mode or <tt>false</tt> otherwise.
  2220. */
  2221. JitsiConference.prototype.isP2PActive = function() {
  2222. return this.p2p;
  2223. };
  2224. /**
  2225. * Returns the current ICE state of the P2P connection.
  2226. * NOTE: method is used by the jitsi-meet-torture tests.
  2227. * @return {string|null} an ICE state or <tt>null</tt> if there's currently
  2228. * no P2P connection.
  2229. */
  2230. JitsiConference.prototype.getP2PConnectionState = function() {
  2231. if (this.isP2PActive()) {
  2232. return this.p2pJingleSession.peerconnection.getConnectionState();
  2233. }
  2234. return null;
  2235. };
  2236. /**
  2237. * Manually starts new P2P session (should be used only in the tests).
  2238. */
  2239. JitsiConference.prototype.startP2PSession = function() {
  2240. const peers = this.getParticipants();
  2241. // Start peer to peer session
  2242. if (peers.length === 1) {
  2243. const peerJid = peers[0].getJid();
  2244. this._startP2PSession(peerJid);
  2245. } else {
  2246. throw new Error(
  2247. 'There must be exactly 1 participant to start the P2P session !');
  2248. }
  2249. };
  2250. /**
  2251. * Manually stops the current P2P session (should be used only in the tests)
  2252. */
  2253. JitsiConference.prototype.stopP2PSession = function() {
  2254. this._stopP2PSession();
  2255. };
  2256. /**
  2257. * Get a summary of how long current participants have been the dominant speaker
  2258. * @returns {object}
  2259. */
  2260. JitsiConference.prototype.getSpeakerStats = function() {
  2261. return this.speakerStatsCollector.getStats();
  2262. };
  2263. /**
  2264. * Sets the maximum video size the local participant should receive from remote
  2265. * participants.
  2266. *
  2267. * @param {number} maxFrameHeightPixels the maximum frame height, in pixels,
  2268. * this receiver is willing to receive.
  2269. * @returns {void}
  2270. */
  2271. JitsiConference.prototype.setReceiverVideoConstraint
  2272. = function(maxFrameHeight) {
  2273. this.rtc.setReceiverVideoConstraint(maxFrameHeight);
  2274. };
  2275. /**
  2276. * Get video SIP GW handler, if missing will create one.
  2277. *
  2278. * @returns {VideoSIPGW} video SIP GW handler.
  2279. */
  2280. JitsiConference.prototype._getVideoSIPGWHandle = function() {
  2281. if (!this.videoSIPGWHandler) {
  2282. this.videoSIPGWHandler = new VideoSIPGW(this.room);
  2283. logger.info('Created VideoSIPGW');
  2284. }
  2285. return this.videoSIPGWHandler;
  2286. };
  2287. /**
  2288. * Checks whether video SIP GW service is available.
  2289. *
  2290. * @returns {boolean} whether video SIP GW service is available.
  2291. */
  2292. JitsiConference.prototype.isVideoSIPGWAvailable = function() {
  2293. return this._getVideoSIPGWHandle().isVideoSIPGWAvailable();
  2294. };
  2295. /**
  2296. * Creates a video SIP GW session and returns it if service is enabled. Before
  2297. * creating a session one need to check whether video SIP GW service is
  2298. * available in the system {@link JitsiConference.isVideoSIPGWAvailable}. Even
  2299. * if there are available nodes to serve this request, after creating the
  2300. * session those nodes can be taken and the request about using the
  2301. * created session can fail.
  2302. *
  2303. * @param {string} sipAddress - The sip address to be used.
  2304. * @param {string} displayName - The display name to be used for this session.
  2305. * @returns {JitsiVideoSIPGWSession|null} Returns null if conference is not
  2306. * initialised and there is no room.
  2307. */
  2308. JitsiConference.prototype.createVideoSIPGWSession
  2309. = function(sipAddress, displayName) {
  2310. if (!this.room) {
  2311. return null;
  2312. }
  2313. return this._getVideoSIPGWHandle()
  2314. .createVideoSIPGWSession(sipAddress, displayName);
  2315. };