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 136KB

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