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

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