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

JitsiConference.js 130KB

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