Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

conference.js 118KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260
  1. /* global APP, JitsiMeetJS, config, interfaceConfig */
  2. import { jitsiLocalStorage } from '@jitsi/js-utils';
  3. import Logger from '@jitsi/logger';
  4. import EventEmitter from 'events';
  5. import { openConnection } from './connection';
  6. import { ENDPOINT_TEXT_MESSAGE_NAME } from './modules/API/constants';
  7. import { AUDIO_ONLY_SCREEN_SHARE_NO_TRACK } from './modules/UI/UIErrors';
  8. import AuthHandler from './modules/UI/authentication/AuthHandler';
  9. import UIUtil from './modules/UI/util/UIUtil';
  10. import VideoLayout from './modules/UI/videolayout/VideoLayout';
  11. import mediaDeviceHelper from './modules/devices/mediaDeviceHelper';
  12. import Recorder from './modules/recorder/Recorder';
  13. import { createTaskQueue } from './modules/util/helpers';
  14. import {
  15. createDeviceChangedEvent,
  16. createStartSilentEvent,
  17. createScreenSharingEvent,
  18. createTrackMutedEvent,
  19. sendAnalytics
  20. } from './react/features/analytics';
  21. import {
  22. maybeRedirectToWelcomePage,
  23. redirectToStaticPage,
  24. reloadWithStoredParams
  25. } from './react/features/app/actions';
  26. import { showModeratedNotification } from './react/features/av-moderation/actions';
  27. import { shouldShowModeratedNotification } from './react/features/av-moderation/functions';
  28. import {
  29. AVATAR_URL_COMMAND,
  30. EMAIL_COMMAND,
  31. _conferenceWillJoin,
  32. authStatusChanged,
  33. commonUserJoinedHandling,
  34. commonUserLeftHandling,
  35. conferenceFailed,
  36. conferenceJoined,
  37. conferenceLeft,
  38. conferenceSubjectChanged,
  39. conferenceTimestampChanged,
  40. conferenceUniqueIdSet,
  41. conferenceWillJoin,
  42. conferenceWillLeave,
  43. dataChannelOpened,
  44. getConferenceOptions,
  45. kickedOut,
  46. lockStateChanged,
  47. onStartMutedPolicyChanged,
  48. p2pStatusChanged,
  49. sendLocalParticipant,
  50. nonParticipantMessageReceived
  51. } from './react/features/base/conference';
  52. import { getReplaceParticipant } from './react/features/base/config/functions';
  53. import {
  54. checkAndNotifyForNewDevice,
  55. getAvailableDevices,
  56. getDefaultDeviceId,
  57. notifyCameraError,
  58. notifyMicError,
  59. setAudioOutputDeviceId,
  60. updateDeviceList
  61. } from './react/features/base/devices';
  62. import {
  63. browser,
  64. isFatalJitsiConnectionError,
  65. JitsiConferenceErrors,
  66. JitsiConferenceEvents,
  67. JitsiConnectionErrors,
  68. JitsiConnectionEvents,
  69. JitsiMediaDevicesEvents,
  70. JitsiParticipantConnectionStatus,
  71. JitsiTrackErrors,
  72. JitsiTrackEvents
  73. } from './react/features/base/lib-jitsi-meet';
  74. import {
  75. getStartWithAudioMuted,
  76. getStartWithVideoMuted,
  77. isVideoMutedByUser,
  78. MEDIA_TYPE,
  79. setAudioAvailable,
  80. setAudioMuted,
  81. setAudioUnmutePermissions,
  82. setVideoAvailable,
  83. setVideoMuted,
  84. setVideoUnmutePermissions
  85. } from './react/features/base/media';
  86. import {
  87. dominantSpeakerChanged,
  88. getLocalParticipant,
  89. getNormalizedDisplayName,
  90. localParticipantAudioLevelChanged,
  91. localParticipantConnectionStatusChanged,
  92. localParticipantRoleChanged,
  93. participantConnectionStatusChanged,
  94. participantKicked,
  95. participantMutedUs,
  96. participantPresenceChanged,
  97. participantRoleChanged,
  98. participantUpdated,
  99. updateRemoteParticipantFeatures
  100. } from './react/features/base/participants';
  101. import {
  102. getUserSelectedCameraDeviceId,
  103. updateSettings
  104. } from './react/features/base/settings';
  105. import {
  106. createLocalPresenterTrack,
  107. createLocalTracksF,
  108. destroyLocalTracks,
  109. getLocalJitsiAudioTrack,
  110. getLocalJitsiVideoTrack,
  111. getLocalTracks,
  112. getLocalVideoTrack,
  113. isLocalCameraTrackMuted,
  114. isLocalTrackMuted,
  115. isUserInteractionRequiredForUnmute,
  116. replaceLocalTrack,
  117. trackAdded,
  118. trackRemoved
  119. } from './react/features/base/tracks';
  120. import { downloadJSON } from './react/features/base/util/downloadJSON';
  121. import { showDesktopPicker } from './react/features/desktop-picker';
  122. import { appendSuffix } from './react/features/display-name';
  123. import {
  124. maybeOpenFeedbackDialog,
  125. submitFeedback
  126. } from './react/features/feedback';
  127. import {
  128. isModerationNotificationDisplayed,
  129. showNotification,
  130. NOTIFICATION_TIMEOUT_TYPE
  131. } from './react/features/notifications';
  132. import { mediaPermissionPromptVisibilityChanged, toggleSlowGUMOverlay } from './react/features/overlay';
  133. import { suspendDetected } from './react/features/power-monitor';
  134. import {
  135. initPrejoin,
  136. isPrejoinPageVisible,
  137. makePrecallTest,
  138. setJoiningInProgress,
  139. setPrejoinPageVisibility
  140. } from './react/features/prejoin';
  141. import { disableReceiver, stopReceiver } from './react/features/remote-control';
  142. import { setScreenAudioShareState, isScreenAudioShared } from './react/features/screen-share/';
  143. import { toggleScreenshotCaptureSummary } from './react/features/screenshot-capture';
  144. import { isScreenshotCaptureEnabled } from './react/features/screenshot-capture/functions';
  145. import { AudioMixerEffect } from './react/features/stream-effects/audio-mixer/AudioMixerEffect';
  146. import { createPresenterEffect } from './react/features/stream-effects/presenter';
  147. import { createRnnoiseProcessor } from './react/features/stream-effects/rnnoise';
  148. import { endpointMessageReceived } from './react/features/subtitles';
  149. import { muteLocal } from './react/features/video-menu/actions.any';
  150. import UIEvents from './service/UI/UIEvents';
  151. const logger = Logger.getLogger(__filename);
  152. const eventEmitter = new EventEmitter();
  153. let room;
  154. let connection;
  155. /**
  156. * The promise is used when the prejoin screen is shown.
  157. * While the user configures the devices the connection can be made.
  158. *
  159. * @type {Promise<Object>}
  160. * @private
  161. */
  162. let _connectionPromise;
  163. /**
  164. * We are storing the resolve function of a Promise that waits for the _connectionPromise to be created. This is needed
  165. * when the prejoin button was pressed before the conference object was initialized and the _connectionPromise has not
  166. * been initialized when we tried to execute prejoinStart. In this case in prejoinStart we create a new Promise, assign
  167. * the resolve function to this variable and wait for the promise to resolve before we continue. The
  168. * _onConnectionPromiseCreated will be called once the _connectionPromise is created.
  169. */
  170. let _onConnectionPromiseCreated;
  171. /**
  172. * This promise is used for chaining mutePresenterVideo calls in order to avoid calling GUM multiple times if it takes
  173. * a while to finish.
  174. *
  175. * @type {Promise<void>}
  176. * @private
  177. */
  178. let _prevMutePresenterVideo = Promise.resolve();
  179. /*
  180. * Logic to open a desktop picker put on the window global for
  181. * lib-jitsi-meet to detect and invoke
  182. */
  183. window.JitsiMeetScreenObtainer = {
  184. openDesktopPicker(options, onSourceChoose) {
  185. APP.store.dispatch(showDesktopPicker(options, onSourceChoose));
  186. }
  187. };
  188. /**
  189. * Known custom conference commands.
  190. */
  191. const commands = {
  192. AVATAR_URL: AVATAR_URL_COMMAND,
  193. CUSTOM_ROLE: 'custom-role',
  194. EMAIL: EMAIL_COMMAND,
  195. ETHERPAD: 'etherpad'
  196. };
  197. /**
  198. * Open Connection. When authentication failed it shows auth dialog.
  199. * @param roomName the room name to use
  200. * @returns Promise<JitsiConnection>
  201. */
  202. function connect(roomName) {
  203. return openConnection({
  204. retry: true,
  205. roomName
  206. })
  207. .catch(err => {
  208. if (err === JitsiConnectionErrors.PASSWORD_REQUIRED) {
  209. APP.UI.notifyTokenAuthFailed();
  210. } else {
  211. APP.UI.notifyConnectionFailed(err);
  212. }
  213. throw err;
  214. });
  215. }
  216. /**
  217. * Share data to other users.
  218. * @param command the command
  219. * @param {string} value new value
  220. */
  221. function sendData(command, value) {
  222. if (!room) {
  223. return;
  224. }
  225. room.removeCommand(command);
  226. room.sendCommand(command, { value });
  227. }
  228. /**
  229. * Mute or unmute local audio stream if it exists.
  230. * @param {boolean} muted - if audio stream should be muted or unmuted.
  231. */
  232. function muteLocalAudio(muted) {
  233. APP.store.dispatch(setAudioMuted(muted));
  234. }
  235. /**
  236. * Mute or unmute local video stream if it exists.
  237. * @param {boolean} muted if video stream should be muted or unmuted.
  238. *
  239. */
  240. function muteLocalVideo(muted) {
  241. APP.store.dispatch(setVideoMuted(muted));
  242. }
  243. /**
  244. * A queue for the async replaceLocalTrack action so that multiple audio
  245. * replacements cannot happen simultaneously. This solves the issue where
  246. * replaceLocalTrack is called multiple times with an oldTrack of null, causing
  247. * multiple local tracks of the same type to be used.
  248. *
  249. * @private
  250. * @type {Object}
  251. */
  252. const _replaceLocalAudioTrackQueue = createTaskQueue();
  253. /**
  254. * A task queue for replacement local video tracks. This separate queue exists
  255. * so video replacement is not blocked by audio replacement tasks in the queue
  256. * {@link _replaceLocalAudioTrackQueue}.
  257. *
  258. * @private
  259. * @type {Object}
  260. */
  261. const _replaceLocalVideoTrackQueue = createTaskQueue();
  262. /**
  263. *
  264. */
  265. class ConferenceConnector {
  266. /**
  267. *
  268. */
  269. constructor(resolve, reject) {
  270. this._resolve = resolve;
  271. this._reject = reject;
  272. this.reconnectTimeout = null;
  273. room.on(JitsiConferenceEvents.CONFERENCE_JOINED,
  274. this._handleConferenceJoined.bind(this));
  275. room.on(JitsiConferenceEvents.CONFERENCE_FAILED,
  276. this._onConferenceFailed.bind(this));
  277. }
  278. /**
  279. *
  280. */
  281. _handleConferenceFailed(err) {
  282. this._unsubscribe();
  283. this._reject(err);
  284. }
  285. /**
  286. *
  287. */
  288. _onConferenceFailed(err, ...params) {
  289. APP.store.dispatch(conferenceFailed(room, err, ...params));
  290. logger.error('CONFERENCE FAILED:', err, ...params);
  291. switch (err) {
  292. case JitsiConferenceErrors.NOT_ALLOWED_ERROR: {
  293. // let's show some auth not allowed page
  294. APP.store.dispatch(redirectToStaticPage('static/authError.html'));
  295. break;
  296. }
  297. // not enough rights to create conference
  298. case JitsiConferenceErrors.AUTHENTICATION_REQUIRED: {
  299. const replaceParticipant = getReplaceParticipant(APP.store.getState());
  300. // Schedule reconnect to check if someone else created the room.
  301. this.reconnectTimeout = setTimeout(() => {
  302. APP.store.dispatch(conferenceWillJoin(room));
  303. room.join(null, replaceParticipant);
  304. }, 5000);
  305. const { password }
  306. = APP.store.getState()['features/base/conference'];
  307. AuthHandler.requireAuth(room, password);
  308. break;
  309. }
  310. case JitsiConferenceErrors.RESERVATION_ERROR: {
  311. const [ code, msg ] = params;
  312. APP.UI.notifyReservationError(code, msg);
  313. break;
  314. }
  315. case JitsiConferenceErrors.GRACEFUL_SHUTDOWN:
  316. APP.UI.notifyGracefulShutdown();
  317. break;
  318. // FIXME FOCUS_DISCONNECTED is a confusing event name.
  319. // What really happens there is that the library is not ready yet,
  320. // because Jicofo is not available, but it is going to give it another
  321. // try.
  322. case JitsiConferenceErrors.FOCUS_DISCONNECTED: {
  323. const [ focus, retrySec ] = params;
  324. APP.store.dispatch(showNotification({
  325. descriptionKey: focus,
  326. titleKey: retrySec
  327. }, NOTIFICATION_TIMEOUT_TYPE.SHORT));
  328. break;
  329. }
  330. case JitsiConferenceErrors.FOCUS_LEFT:
  331. case JitsiConferenceErrors.ICE_FAILED:
  332. case JitsiConferenceErrors.VIDEOBRIDGE_NOT_AVAILABLE:
  333. case JitsiConferenceErrors.OFFER_ANSWER_FAILED:
  334. APP.store.dispatch(conferenceWillLeave(room));
  335. // FIXME the conference should be stopped by the library and not by
  336. // the app. Both the errors above are unrecoverable from the library
  337. // perspective.
  338. room.leave().then(() => connection.disconnect());
  339. break;
  340. case JitsiConferenceErrors.CONFERENCE_MAX_USERS:
  341. APP.UI.notifyMaxUsersLimitReached();
  342. break;
  343. case JitsiConferenceErrors.INCOMPATIBLE_SERVER_VERSIONS:
  344. APP.store.dispatch(reloadWithStoredParams());
  345. break;
  346. default:
  347. this._handleConferenceFailed(err, ...params);
  348. }
  349. }
  350. /**
  351. *
  352. */
  353. _unsubscribe() {
  354. room.off(
  355. JitsiConferenceEvents.CONFERENCE_JOINED,
  356. this._handleConferenceJoined);
  357. room.off(
  358. JitsiConferenceEvents.CONFERENCE_FAILED,
  359. this._onConferenceFailed);
  360. if (this.reconnectTimeout !== null) {
  361. clearTimeout(this.reconnectTimeout);
  362. }
  363. }
  364. /**
  365. *
  366. */
  367. _handleConferenceJoined() {
  368. this._unsubscribe();
  369. this._resolve();
  370. }
  371. /**
  372. *
  373. */
  374. connect() {
  375. const replaceParticipant = getReplaceParticipant(APP.store.getState());
  376. // the local storage overrides here and in connection.js can be used by jibri
  377. room.join(jitsiLocalStorage.getItem('xmpp_conference_password_override'), replaceParticipant);
  378. }
  379. }
  380. /**
  381. * Disconnects the connection.
  382. * @returns resolved Promise. We need this in order to make the Promise.all
  383. * call in hangup() to resolve when all operations are finished.
  384. */
  385. function disconnect() {
  386. const onDisconnected = () => {
  387. APP.API.notifyConferenceLeft(APP.conference.roomName);
  388. return Promise.resolve();
  389. };
  390. if (!connection) {
  391. return onDisconnected();
  392. }
  393. return connection.disconnect().then(onDisconnected, onDisconnected);
  394. }
  395. /**
  396. * Handles CONNECTION_FAILED events from lib-jitsi-meet.
  397. *
  398. * @param {JitsiConnectionError} error - The reported error.
  399. * @returns {void}
  400. * @private
  401. */
  402. function _connectionFailedHandler(error) {
  403. if (isFatalJitsiConnectionError(error)) {
  404. APP.connection.removeEventListener(
  405. JitsiConnectionEvents.CONNECTION_FAILED,
  406. _connectionFailedHandler);
  407. if (room) {
  408. APP.store.dispatch(conferenceWillLeave(room));
  409. room.leave();
  410. }
  411. }
  412. }
  413. export default {
  414. /**
  415. * Flag used to delay modification of the muted status of local media tracks
  416. * until those are created (or not, but at that point it's certain that
  417. * the tracks won't exist).
  418. */
  419. _localTracksInitialized: false,
  420. isSharingScreen: false,
  421. /**
  422. * The local presenter video track (if any).
  423. * @type {JitsiLocalTrack|null}
  424. */
  425. localPresenterVideo: null,
  426. /**
  427. * Returns an object containing a promise which resolves with the created tracks &
  428. * the errors resulting from that process.
  429. *
  430. * @returns {Promise<JitsiLocalTrack[]>, Object}
  431. */
  432. createInitialLocalTracks(options = {}) {
  433. const errors = {};
  434. // Always get a handle on the audio input device so that we have statistics (such as "No audio input" or
  435. // "Are you trying to speak?" ) even if the user joins the conference muted.
  436. const initialDevices = config.disableInitialGUM ? [] : [ MEDIA_TYPE.AUDIO ];
  437. const requestedAudio = !config.disableInitialGUM;
  438. let requestedVideo = false;
  439. if (!config.disableInitialGUM
  440. && !options.startWithVideoMuted
  441. && !options.startAudioOnly
  442. && !options.startScreenSharing) {
  443. initialDevices.push(MEDIA_TYPE.VIDEO);
  444. requestedVideo = true;
  445. }
  446. if (!config.disableInitialGUM) {
  447. JitsiMeetJS.mediaDevices.addEventListener(
  448. JitsiMediaDevicesEvents.PERMISSION_PROMPT_IS_SHOWN,
  449. browserName =>
  450. APP.store.dispatch(
  451. mediaPermissionPromptVisibilityChanged(true, browserName))
  452. );
  453. }
  454. JitsiMeetJS.mediaDevices.addEventListener(
  455. JitsiMediaDevicesEvents.SLOW_GET_USER_MEDIA,
  456. () => APP.store.dispatch(toggleSlowGUMOverlay(true))
  457. );
  458. let tryCreateLocalTracks;
  459. // On Electron there is no permission prompt for granting permissions. That's why we don't need to
  460. // spend much time displaying the overlay screen. If GUM is not resolved within 15 seconds it will
  461. // probably never resolve.
  462. const timeout = browser.isElectron() ? 15000 : 60000;
  463. const audioOptions = {
  464. devices: [ MEDIA_TYPE.AUDIO ],
  465. timeout,
  466. firePermissionPromptIsShownEvent: true,
  467. fireSlowPromiseEvent: true
  468. };
  469. // FIXME is there any simpler way to rewrite this spaghetti below ?
  470. if (options.startScreenSharing) {
  471. // This option has been deprecated since it is no longer supported as per the w3c spec.
  472. // https://w3c.github.io/mediacapture-screen-share/#dom-mediadevices-getdisplaymedia. If the user has not
  473. // interacted with the webpage before the getDisplayMedia call, the promise will be rejected by the
  474. // browser. This has already been implemented in Firefox and Safari and will be implemented in Chrome soon.
  475. // https://bugs.chromium.org/p/chromium/issues/detail?id=1198918
  476. // Please note that Spot uses the same config option to use an external video input device label as
  477. // screenshare and calls getUserMedia instead of getDisplayMedia for capturing the media. Therefore it
  478. // needs to be supported here if _desktopSharingSourceDevice is provided.
  479. const errMessage = new Error('startScreenSharing config option is no longer supported for web browsers');
  480. const desktopPromise = config._desktopSharingSourceDevice
  481. ? this._createDesktopTrack()
  482. : Promise.reject(errMessage);
  483. tryCreateLocalTracks = desktopPromise
  484. .then(([ desktopStream ]) => {
  485. if (!requestedAudio) {
  486. return [ desktopStream ];
  487. }
  488. return createLocalTracksF(audioOptions)
  489. .then(([ audioStream ]) =>
  490. [ desktopStream, audioStream ])
  491. .catch(error => {
  492. errors.audioOnlyError = error;
  493. return [ desktopStream ];
  494. });
  495. })
  496. .catch(error => {
  497. logger.error('Failed to obtain desktop stream', error);
  498. errors.screenSharingError = error;
  499. return requestedAudio ? createLocalTracksF(audioOptions) : [];
  500. })
  501. .catch(error => {
  502. errors.audioOnlyError = error;
  503. return [];
  504. });
  505. } else if (!requestedAudio && !requestedVideo) {
  506. // Resolve with no tracks
  507. tryCreateLocalTracks = Promise.resolve([]);
  508. } else {
  509. tryCreateLocalTracks = createLocalTracksF({
  510. devices: initialDevices,
  511. timeout,
  512. firePermissionPromptIsShownEvent: true,
  513. fireSlowPromiseEvent: true
  514. })
  515. .catch(err => {
  516. if (requestedAudio && requestedVideo) {
  517. // Try audio only...
  518. errors.audioAndVideoError = err;
  519. if (err.name === JitsiTrackErrors.TIMEOUT && !browser.isElectron()) {
  520. // In this case we expect that the permission prompt is still visible. There is no point of
  521. // executing GUM with different source. Also at the time of writing the following
  522. // inconsistency have been noticed in some browsers - if the permissions prompt is visible
  523. // and another GUM is executed the prompt does not change its content but if the user
  524. // clicks allow the user action isassociated with the latest GUM call.
  525. errors.audioOnlyError = err;
  526. errors.videoOnlyError = err;
  527. return [];
  528. }
  529. return createLocalTracksF(audioOptions);
  530. } else if (requestedAudio && !requestedVideo) {
  531. errors.audioOnlyError = err;
  532. return [];
  533. } else if (requestedVideo && !requestedAudio) {
  534. errors.videoOnlyError = err;
  535. return [];
  536. }
  537. logger.error('Should never happen');
  538. })
  539. .catch(err => {
  540. // Log this just in case...
  541. if (!requestedAudio) {
  542. logger.error('The impossible just happened', err);
  543. }
  544. errors.audioOnlyError = err;
  545. // Try video only...
  546. return requestedVideo
  547. ? createLocalTracksF({
  548. devices: [ MEDIA_TYPE.VIDEO ],
  549. firePermissionPromptIsShownEvent: true,
  550. fireSlowPromiseEvent: true
  551. })
  552. : [];
  553. })
  554. .catch(err => {
  555. // Log this just in case...
  556. if (!requestedVideo) {
  557. logger.error('The impossible just happened', err);
  558. }
  559. errors.videoOnlyError = err;
  560. return [];
  561. });
  562. }
  563. // Hide the permissions prompt/overlay as soon as the tracks are
  564. // created. Don't wait for the connection to be made, since in some
  565. // cases, when auth is required, for instance, that won't happen until
  566. // the user inputs their credentials, but the dialog would be
  567. // overshadowed by the overlay.
  568. tryCreateLocalTracks.then(tracks => {
  569. APP.store.dispatch(toggleSlowGUMOverlay(false));
  570. APP.store.dispatch(mediaPermissionPromptVisibilityChanged(false));
  571. return tracks;
  572. });
  573. return {
  574. tryCreateLocalTracks,
  575. errors
  576. };
  577. },
  578. /**
  579. * Displays error notifications according to the state carried by {@code errors} object returned
  580. * by {@link createInitialLocalTracks}.
  581. * @param {Object} errors - the errors (if any) returned by {@link createInitialLocalTracks}.
  582. *
  583. * @returns {void}
  584. * @private
  585. */
  586. _displayErrorsForCreateInitialLocalTracks(errors) {
  587. const {
  588. audioAndVideoError,
  589. audioOnlyError,
  590. screenSharingError,
  591. videoOnlyError
  592. } = errors;
  593. // FIXME If there will be microphone error it will cover any screensharing dialog, but it's still better than in
  594. // the reverse order where the screensharing dialog will sometimes be closing the microphone alert
  595. // ($.prompt.close(); is called). Need to figure out dialogs chaining to fix that.
  596. if (screenSharingError) {
  597. this._handleScreenSharingError(screenSharingError);
  598. }
  599. if (audioAndVideoError || audioOnlyError) {
  600. if (audioOnlyError || videoOnlyError) {
  601. // If both requests for 'audio' + 'video' and 'audio' only failed, we assume that there are some
  602. // problems with user's microphone and show corresponding dialog.
  603. APP.store.dispatch(notifyMicError(audioOnlyError));
  604. APP.store.dispatch(notifyCameraError(videoOnlyError));
  605. } else {
  606. // If request for 'audio' + 'video' failed, but request for 'audio' only was OK, we assume that we had
  607. // problems with camera and show corresponding dialog.
  608. APP.store.dispatch(notifyCameraError(audioAndVideoError));
  609. }
  610. }
  611. },
  612. /**
  613. * Creates local media tracks and connects to a room. Will show error
  614. * dialogs in case accessing the local microphone and/or camera failed. Will
  615. * show guidance overlay for users on how to give access to camera and/or
  616. * microphone.
  617. * @param {string} roomName
  618. * @param {object} options
  619. * @param {boolean} options.startAudioOnly=false - if <tt>true</tt> then
  620. * only audio track will be created and the audio only mode will be turned
  621. * on.
  622. * @param {boolean} options.startScreenSharing=false - if <tt>true</tt>
  623. * should start with screensharing instead of camera video.
  624. * @param {boolean} options.startWithAudioMuted - will start the conference
  625. * without any audio tracks.
  626. * @param {boolean} options.startWithVideoMuted - will start the conference
  627. * without any video tracks.
  628. * @returns {Promise.<JitsiLocalTrack[], JitsiConnection>}
  629. */
  630. createInitialLocalTracksAndConnect(roomName, options = {}) {
  631. const { tryCreateLocalTracks, errors } = this.createInitialLocalTracks(options);
  632. return Promise.all([ tryCreateLocalTracks, connect(roomName) ])
  633. .then(([ tracks, con ]) => {
  634. this._displayErrorsForCreateInitialLocalTracks(errors);
  635. return [ tracks, con ];
  636. });
  637. },
  638. startConference(con, tracks) {
  639. tracks.forEach(track => {
  640. if ((track.isAudioTrack() && this.isLocalAudioMuted())
  641. || (track.isVideoTrack() && this.isLocalVideoMuted())) {
  642. const mediaType = track.getType();
  643. sendAnalytics(
  644. createTrackMutedEvent(mediaType, 'initial mute'));
  645. logger.log(`${mediaType} mute: initially muted.`);
  646. track.mute();
  647. }
  648. });
  649. con.addEventListener(JitsiConnectionEvents.CONNECTION_FAILED, _connectionFailedHandler);
  650. APP.connection = connection = con;
  651. this._createRoom(tracks);
  652. // if user didn't give access to mic or camera or doesn't have
  653. // them at all, we mark corresponding toolbar buttons as muted,
  654. // so that the user can try unmute later on and add audio/video
  655. // to the conference
  656. if (!tracks.find(t => t.isAudioTrack())) {
  657. this.setAudioMuteStatus(true);
  658. }
  659. if (!tracks.find(t => t.isVideoTrack())) {
  660. this.setVideoMuteStatus();
  661. }
  662. if (config.iAmRecorder) {
  663. this.recorder = new Recorder();
  664. }
  665. if (config.startSilent) {
  666. sendAnalytics(createStartSilentEvent());
  667. APP.store.dispatch(showNotification({
  668. descriptionKey: 'notify.startSilentDescription',
  669. titleKey: 'notify.startSilentTitle'
  670. }, NOTIFICATION_TIMEOUT_TYPE.LONG));
  671. }
  672. // XXX The API will take care of disconnecting from the XMPP
  673. // server (and, thus, leaving the room) on unload.
  674. return new Promise((resolve, reject) => {
  675. new ConferenceConnector(resolve, reject).connect();
  676. });
  677. },
  678. /**
  679. * Open new connection and join the conference when prejoin page is not enabled.
  680. * If prejoin page is enabled open an new connection in the background
  681. * and create local tracks.
  682. *
  683. * @param {{ roomName: string }} options
  684. * @returns {Promise}
  685. */
  686. async init({ roomName }) {
  687. const initialOptions = {
  688. startAudioOnly: config.startAudioOnly,
  689. startScreenSharing: config.startScreenSharing,
  690. startWithAudioMuted: getStartWithAudioMuted(APP.store.getState())
  691. || config.startSilent
  692. || isUserInteractionRequiredForUnmute(APP.store.getState()),
  693. startWithVideoMuted: getStartWithVideoMuted(APP.store.getState())
  694. || isUserInteractionRequiredForUnmute(APP.store.getState())
  695. };
  696. this.roomName = roomName;
  697. try {
  698. // Initialize the device list first. This way, when creating tracks
  699. // based on preferred devices, loose label matching can be done in
  700. // cases where the exact ID match is no longer available, such as
  701. // when the camera device has switched USB ports.
  702. // when in startSilent mode we want to start with audio muted
  703. await this._initDeviceList();
  704. } catch (error) {
  705. logger.warn('initial device list initialization failed', error);
  706. }
  707. const handleStartAudioMuted = (options, tracks) => {
  708. if (options.startWithAudioMuted) {
  709. // Always add the track on Safari because of a known issue where audio playout doesn't happen
  710. // if the user joins audio and video muted, i.e., if there is no local media capture.
  711. if (browser.isWebKitBased()) {
  712. this.muteAudio(true, true);
  713. } else {
  714. return tracks.filter(track => track.getType() !== MEDIA_TYPE.AUDIO);
  715. }
  716. }
  717. return tracks;
  718. };
  719. if (isPrejoinPageVisible(APP.store.getState())) {
  720. _connectionPromise = connect(roomName).then(c => {
  721. // we want to initialize it early, in case of errors to be able
  722. // to gather logs
  723. APP.connection = c;
  724. return c;
  725. });
  726. if (_onConnectionPromiseCreated) {
  727. _onConnectionPromiseCreated();
  728. }
  729. APP.store.dispatch(makePrecallTest(this._getConferenceOptions()));
  730. const { tryCreateLocalTracks, errors } = this.createInitialLocalTracks(initialOptions);
  731. const tracks = await tryCreateLocalTracks;
  732. // Initialize device list a second time to ensure device labels
  733. // get populated in case of an initial gUM acceptance; otherwise
  734. // they may remain as empty strings.
  735. this._initDeviceList(true);
  736. if (isPrejoinPageVisible(APP.store.getState())) {
  737. return APP.store.dispatch(initPrejoin(tracks, errors));
  738. }
  739. logger.debug('Prejoin screen no longer displayed at the time when tracks were created');
  740. this._displayErrorsForCreateInitialLocalTracks(errors);
  741. let localTracks = handleStartAudioMuted(initialOptions, tracks);
  742. // in case where gum is slow and resolves after the startAudio/VideoMuted coming from jicofo, we can be
  743. // join unmuted even though jicofo had instruct us to mute, so let's respect that before passing the tracks
  744. if (!browser.isWebKitBased()) {
  745. if (room?.isStartAudioMuted()) {
  746. localTracks = localTracks.filter(track => track.getType() !== MEDIA_TYPE.AUDIO);
  747. }
  748. }
  749. if (room?.isStartVideoMuted()) {
  750. localTracks = localTracks.filter(track => track.getType() !== MEDIA_TYPE.VIDEO);
  751. }
  752. return this._setLocalAudioVideoStreams(localTracks);
  753. }
  754. const [ tracks, con ] = await this.createInitialLocalTracksAndConnect(roomName, initialOptions);
  755. this._initDeviceList(true);
  756. return this.startConference(con, handleStartAudioMuted(initialOptions, tracks));
  757. },
  758. /**
  759. * Joins conference after the tracks have been configured in the prejoin screen.
  760. *
  761. * @param {Object[]} tracks - An array with the configured tracks
  762. * @returns {void}
  763. */
  764. async prejoinStart(tracks) {
  765. if (!_connectionPromise) {
  766. // The conference object isn't initialized yet. Wait for the promise to initialise.
  767. await new Promise(resolve => {
  768. _onConnectionPromiseCreated = resolve;
  769. });
  770. _onConnectionPromiseCreated = undefined;
  771. }
  772. let con;
  773. try {
  774. con = await _connectionPromise;
  775. this.startConference(con, tracks);
  776. } catch (error) {
  777. logger.error(`An error occurred while trying to join a meeting from the prejoin screen: ${error}`);
  778. APP.store.dispatch(setJoiningInProgress(false));
  779. }
  780. },
  781. /**
  782. * Check if id is id of the local user.
  783. * @param {string} id id to check
  784. * @returns {boolean}
  785. */
  786. isLocalId(id) {
  787. return this.getMyUserId() === id;
  788. },
  789. /**
  790. * Tells whether the local video is muted or not.
  791. * @return {boolean}
  792. */
  793. isLocalVideoMuted() {
  794. // If the tracks are not ready, read from base/media state
  795. return this._localTracksInitialized
  796. ? isLocalCameraTrackMuted(
  797. APP.store.getState()['features/base/tracks'])
  798. : isVideoMutedByUser(APP.store);
  799. },
  800. /**
  801. * Simulates toolbar button click for audio mute. Used by shortcuts and API.
  802. * @param {boolean} mute true for mute and false for unmute.
  803. * @param {boolean} [showUI] when set to false will not display any error
  804. * dialogs in case of media permissions error.
  805. */
  806. muteAudio(mute, showUI = true) {
  807. const state = APP.store.getState();
  808. if (!mute
  809. && isUserInteractionRequiredForUnmute(state)) {
  810. logger.error('Unmuting audio requires user interaction');
  811. return;
  812. }
  813. // check for A/V Moderation when trying to unmute
  814. if (!mute && shouldShowModeratedNotification(MEDIA_TYPE.AUDIO, state)) {
  815. if (!isModerationNotificationDisplayed(MEDIA_TYPE.AUDIO, state)) {
  816. APP.store.dispatch(showModeratedNotification(MEDIA_TYPE.AUDIO));
  817. }
  818. return;
  819. }
  820. // Not ready to modify track's state yet
  821. if (!this._localTracksInitialized) {
  822. // This will only modify base/media.audio.muted which is then synced
  823. // up with the track at the end of local tracks initialization.
  824. muteLocalAudio(mute);
  825. this.setAudioMuteStatus(mute);
  826. return;
  827. } else if (this.isLocalAudioMuted() === mute) {
  828. // NO-OP
  829. return;
  830. }
  831. const localAudio = getLocalJitsiAudioTrack(APP.store.getState());
  832. if (!localAudio && !mute) {
  833. const maybeShowErrorDialog = error => {
  834. showUI && APP.store.dispatch(notifyMicError(error));
  835. };
  836. createLocalTracksF({ devices: [ 'audio' ] })
  837. .then(([ audioTrack ]) => audioTrack)
  838. .catch(error => {
  839. maybeShowErrorDialog(error);
  840. // Rollback the audio muted status by using null track
  841. return null;
  842. })
  843. .then(audioTrack => this.useAudioStream(audioTrack));
  844. } else {
  845. muteLocalAudio(mute);
  846. }
  847. },
  848. /**
  849. * Returns whether local audio is muted or not.
  850. * @returns {boolean}
  851. */
  852. isLocalAudioMuted() {
  853. // If the tracks are not ready, read from base/media state
  854. return this._localTracksInitialized
  855. ? isLocalTrackMuted(
  856. APP.store.getState()['features/base/tracks'],
  857. MEDIA_TYPE.AUDIO)
  858. : Boolean(
  859. APP.store.getState()['features/base/media'].audio.muted);
  860. },
  861. /**
  862. * Simulates toolbar button click for audio mute. Used by shortcuts
  863. * and API.
  864. * @param {boolean} [showUI] when set to false will not display any error
  865. * dialogs in case of media permissions error.
  866. */
  867. toggleAudioMuted(showUI = true) {
  868. this.muteAudio(!this.isLocalAudioMuted(), showUI);
  869. },
  870. /**
  871. * Simulates toolbar button click for presenter video mute. Used by
  872. * shortcuts and API.
  873. * @param mute true for mute and false for unmute.
  874. * @param {boolean} [showUI] when set to false will not display any error
  875. * dialogs in case of media permissions error.
  876. */
  877. async mutePresenter(mute, showUI = true) {
  878. const maybeShowErrorDialog = error => {
  879. showUI && APP.store.dispatch(notifyCameraError(error));
  880. };
  881. const localVideo = getLocalJitsiVideoTrack(APP.store.getState());
  882. if (mute) {
  883. try {
  884. await localVideo.setEffect(undefined);
  885. } catch (err) {
  886. logger.error('Failed to remove the presenter effect', err);
  887. maybeShowErrorDialog(err);
  888. }
  889. } else {
  890. try {
  891. await localVideo.setEffect(await this._createPresenterStreamEffect());
  892. } catch (err) {
  893. logger.error('Failed to apply the presenter effect', err);
  894. maybeShowErrorDialog(err);
  895. }
  896. }
  897. },
  898. /**
  899. * Simulates toolbar button click for video mute. Used by shortcuts and API.
  900. * @param mute true for mute and false for unmute.
  901. * @param {boolean} [showUI] when set to false will not display any error
  902. * dialogs in case of media permissions error.
  903. */
  904. muteVideo(mute, showUI = true) {
  905. if (this.videoSwitchInProgress) {
  906. // Turning the camera on while the screen sharing mode is being turned off is causing issues around
  907. // the presenter mode handling. It should be okay for the user to click the button again once that's done.
  908. console.warn('muteVideo - unable to perform operations while video switch is in progress');
  909. return;
  910. }
  911. if (!mute
  912. && isUserInteractionRequiredForUnmute(APP.store.getState())) {
  913. logger.error('Unmuting video requires user interaction');
  914. return;
  915. }
  916. if (this.isSharingScreen) {
  917. // Chain _mutePresenterVideo calls
  918. _prevMutePresenterVideo = _prevMutePresenterVideo.then(() => this._mutePresenterVideo(mute));
  919. return;
  920. }
  921. // If not ready to modify track's state yet adjust the base/media
  922. if (!this._localTracksInitialized) {
  923. // This will only modify base/media.video.muted which is then synced
  924. // up with the track at the end of local tracks initialization.
  925. muteLocalVideo(mute);
  926. this.setVideoMuteStatus();
  927. return;
  928. } else if (this.isLocalVideoMuted() === mute) {
  929. // NO-OP
  930. return;
  931. }
  932. const localVideo = getLocalJitsiVideoTrack(APP.store.getState());
  933. if (!localVideo && !mute) {
  934. const maybeShowErrorDialog = error => {
  935. showUI && APP.store.dispatch(notifyCameraError(error));
  936. };
  937. // Try to create local video if there wasn't any.
  938. // This handles the case when user joined with no video
  939. // (dismissed screen sharing screen or in audio only mode), but
  940. // decided to add it later on by clicking on muted video icon or
  941. // turning off the audio only mode.
  942. //
  943. // FIXME when local track creation is moved to react/redux
  944. // it should take care of the use case described above
  945. createLocalTracksF({ devices: [ 'video' ] })
  946. .then(([ videoTrack ]) => videoTrack)
  947. .catch(error => {
  948. // FIXME should send some feedback to the API on error ?
  949. maybeShowErrorDialog(error);
  950. // Rollback the video muted status by using null track
  951. return null;
  952. })
  953. .then(videoTrack => {
  954. logger.debug(`muteVideo: calling useVideoStream for track: ${videoTrack}`);
  955. return this.useVideoStream(videoTrack);
  956. });
  957. } else {
  958. // FIXME show error dialog if it fails (should be handled by react)
  959. muteLocalVideo(mute);
  960. }
  961. },
  962. /**
  963. * Simulates toolbar button click for video mute. Used by shortcuts and API.
  964. * @param {boolean} [showUI] when set to false will not display any error
  965. * dialogs in case of media permissions error.
  966. */
  967. toggleVideoMuted(showUI = true) {
  968. this.muteVideo(!this.isLocalVideoMuted(), showUI);
  969. },
  970. /**
  971. * Retrieve list of ids of conference participants (without local user).
  972. * @returns {string[]}
  973. */
  974. listMembersIds() {
  975. return room.getParticipants().map(p => p.getId());
  976. },
  977. /**
  978. * Checks whether the participant identified by id is a moderator.
  979. * @id id to search for participant
  980. * @return {boolean} whether the participant is moderator
  981. */
  982. isParticipantModerator(id) {
  983. const user = room.getParticipantById(id);
  984. return user && user.isModerator();
  985. },
  986. /**
  987. * Retrieve list of conference participants (without local user).
  988. * @returns {JitsiParticipant[]}
  989. *
  990. * NOTE: Used by jitsi-meet-torture!
  991. */
  992. listMembers() {
  993. return room.getParticipants();
  994. },
  995. /**
  996. * Used by Jibri to detect when it's alone and the meeting should be terminated.
  997. */
  998. get membersCount() {
  999. return room.getParticipants()
  1000. .filter(p => !p.isHidden() || !(config.iAmRecorder && p.isHiddenFromRecorder())).length + 1;
  1001. },
  1002. /**
  1003. * Returns true if the callstats integration is enabled, otherwise returns
  1004. * false.
  1005. *
  1006. * @returns true if the callstats integration is enabled, otherwise returns
  1007. * false.
  1008. */
  1009. isCallstatsEnabled() {
  1010. return room && room.isCallstatsEnabled();
  1011. },
  1012. /**
  1013. * Get speaker stats that track total dominant speaker time.
  1014. *
  1015. * @returns {object} A hash with keys being user ids and values being the
  1016. * library's SpeakerStats model used for calculating time as dominant
  1017. * speaker.
  1018. */
  1019. getSpeakerStats() {
  1020. return room.getSpeakerStats();
  1021. },
  1022. /**
  1023. * Returns the connection times stored in the library.
  1024. */
  1025. getConnectionTimes() {
  1026. return room.getConnectionTimes();
  1027. },
  1028. // used by torture currently
  1029. isJoined() {
  1030. return room && room.isJoined();
  1031. },
  1032. getConnectionState() {
  1033. return room && room.getConnectionState();
  1034. },
  1035. /**
  1036. * Obtains current P2P ICE connection state.
  1037. * @return {string|null} ICE connection state or <tt>null</tt> if there's no
  1038. * P2P connection
  1039. */
  1040. getP2PConnectionState() {
  1041. return room && room.getP2PConnectionState();
  1042. },
  1043. /**
  1044. * Starts P2P (for tests only)
  1045. * @private
  1046. */
  1047. _startP2P() {
  1048. try {
  1049. room && room.startP2PSession();
  1050. } catch (error) {
  1051. logger.error('Start P2P failed', error);
  1052. throw error;
  1053. }
  1054. },
  1055. /**
  1056. * Stops P2P (for tests only)
  1057. * @private
  1058. */
  1059. _stopP2P() {
  1060. try {
  1061. room && room.stopP2PSession();
  1062. } catch (error) {
  1063. logger.error('Stop P2P failed', error);
  1064. throw error;
  1065. }
  1066. },
  1067. /**
  1068. * Checks whether or not our connection is currently in interrupted and
  1069. * reconnect attempts are in progress.
  1070. *
  1071. * @returns {boolean} true if the connection is in interrupted state or
  1072. * false otherwise.
  1073. */
  1074. isConnectionInterrupted() {
  1075. return room.isConnectionInterrupted();
  1076. },
  1077. /**
  1078. * Finds JitsiParticipant for given id.
  1079. *
  1080. * @param {string} id participant's identifier(MUC nickname).
  1081. *
  1082. * @returns {JitsiParticipant|null} participant instance for given id or
  1083. * null if not found.
  1084. */
  1085. getParticipantById(id) {
  1086. return room ? room.getParticipantById(id) : null;
  1087. },
  1088. getMyUserId() {
  1089. return room && room.myUserId();
  1090. },
  1091. /**
  1092. * Will be filled with values only when config.debug is enabled.
  1093. * Its used by torture to check audio levels.
  1094. */
  1095. audioLevelsMap: {},
  1096. /**
  1097. * Returns the stored audio level (stored only if config.debug is enabled)
  1098. * @param id the id for the user audio level to return (the id value is
  1099. * returned for the participant using getMyUserId() method)
  1100. */
  1101. getPeerSSRCAudioLevel(id) {
  1102. return this.audioLevelsMap[id];
  1103. },
  1104. /**
  1105. * @return {number} the number of participants in the conference with at
  1106. * least one track.
  1107. */
  1108. getNumberOfParticipantsWithTracks() {
  1109. return room.getParticipants()
  1110. .filter(p => p.getTracks().length > 0)
  1111. .length;
  1112. },
  1113. /**
  1114. * Returns the stats.
  1115. */
  1116. getStats() {
  1117. return room.connectionQuality.getStats();
  1118. },
  1119. // end used by torture
  1120. /**
  1121. * Download logs, a function that can be called from console while
  1122. * debugging.
  1123. * @param filename (optional) specify target filename
  1124. */
  1125. saveLogs(filename = 'meetlog.json') {
  1126. // this can be called from console and will not have reference to this
  1127. // that's why we reference the global var
  1128. const logs = APP.connection.getLogs();
  1129. downloadJSON(logs, filename);
  1130. },
  1131. /**
  1132. * Exposes a Command(s) API on this instance. It is necessitated by (1) the
  1133. * desire to keep room private to this instance and (2) the need of other
  1134. * modules to send and receive commands to and from participants.
  1135. * Eventually, this instance remains in control with respect to the
  1136. * decision whether the Command(s) API of room (i.e. lib-jitsi-meet's
  1137. * JitsiConference) is to be used in the implementation of the Command(s)
  1138. * API of this instance.
  1139. */
  1140. commands: {
  1141. /**
  1142. * Known custom conference commands.
  1143. */
  1144. defaults: commands,
  1145. /**
  1146. * Receives notifications from other participants about commands aka
  1147. * custom events (sent by sendCommand or sendCommandOnce methods).
  1148. * @param command {String} the name of the command
  1149. * @param handler {Function} handler for the command
  1150. */
  1151. addCommandListener() {
  1152. // eslint-disable-next-line prefer-rest-params
  1153. room.addCommandListener(...arguments);
  1154. },
  1155. /**
  1156. * Removes command.
  1157. * @param name {String} the name of the command.
  1158. */
  1159. removeCommand() {
  1160. // eslint-disable-next-line prefer-rest-params
  1161. room.removeCommand(...arguments);
  1162. },
  1163. /**
  1164. * Sends command.
  1165. * @param name {String} the name of the command.
  1166. * @param values {Object} with keys and values that will be sent.
  1167. */
  1168. sendCommand() {
  1169. // eslint-disable-next-line prefer-rest-params
  1170. room.sendCommand(...arguments);
  1171. },
  1172. /**
  1173. * Sends command one time.
  1174. * @param name {String} the name of the command.
  1175. * @param values {Object} with keys and values that will be sent.
  1176. */
  1177. sendCommandOnce() {
  1178. // eslint-disable-next-line prefer-rest-params
  1179. room.sendCommandOnce(...arguments);
  1180. }
  1181. },
  1182. /**
  1183. * Used by the Breakout Rooms feature to join a breakout room or go back to the main room.
  1184. */
  1185. async joinRoom(roomName, options) {
  1186. // Reset VideoLayout. It's destroyed in features/video-layout/middleware.web.js so re-initialize it.
  1187. VideoLayout.initLargeVideo();
  1188. VideoLayout.resizeVideoArea();
  1189. // Restore initial state.
  1190. this._localTracksInitialized = false;
  1191. this.isSharingScreen = false;
  1192. this.localPresenterVideo = null;
  1193. this.roomName = roomName;
  1194. const { tryCreateLocalTracks, errors } = this.createInitialLocalTracks(options);
  1195. const localTracks = await tryCreateLocalTracks;
  1196. this._displayErrorsForCreateInitialLocalTracks(errors);
  1197. localTracks.forEach(track => {
  1198. if ((track.isAudioTrack() && this.isLocalAudioMuted())
  1199. || (track.isVideoTrack() && this.isLocalVideoMuted())) {
  1200. track.mute();
  1201. }
  1202. });
  1203. this._createRoom(localTracks);
  1204. return new Promise((resolve, reject) => {
  1205. new ConferenceConnector(resolve, reject).connect();
  1206. });
  1207. },
  1208. _createRoom(localTracks) {
  1209. room = connection.initJitsiConference(APP.conference.roomName, this._getConferenceOptions());
  1210. // Filter out the tracks that are muted (except on Safari).
  1211. const tracks = browser.isWebKitBased() ? localTracks : localTracks.filter(track => !track.isMuted());
  1212. this._setLocalAudioVideoStreams(tracks);
  1213. this._room = room; // FIXME do not use this
  1214. APP.store.dispatch(_conferenceWillJoin(room));
  1215. sendLocalParticipant(APP.store, room);
  1216. this._setupListeners();
  1217. },
  1218. /**
  1219. * Sets local video and audio streams.
  1220. * @param {JitsiLocalTrack[]} tracks=[]
  1221. * @returns {Promise[]}
  1222. * @private
  1223. */
  1224. _setLocalAudioVideoStreams(tracks = []) {
  1225. const promises = tracks.map(track => {
  1226. if (track.isAudioTrack()) {
  1227. return this.useAudioStream(track);
  1228. } else if (track.isVideoTrack()) {
  1229. logger.debug(`_setLocalAudioVideoStreams is calling useVideoStream with track: ${track}`);
  1230. return this.useVideoStream(track);
  1231. }
  1232. logger.error('Ignored not an audio nor a video track: ', track);
  1233. return Promise.resolve();
  1234. });
  1235. return Promise.allSettled(promises).then(() => {
  1236. this._localTracksInitialized = true;
  1237. logger.log(`Initialized with ${tracks.length} local tracks`);
  1238. });
  1239. },
  1240. _getConferenceOptions() {
  1241. const options = getConferenceOptions(APP.store.getState());
  1242. options.createVADProcessor = createRnnoiseProcessor;
  1243. return options;
  1244. },
  1245. /**
  1246. * Start using provided video stream.
  1247. * Stops previous video stream.
  1248. * @param {JitsiLocalTrack} newTrack - new track to use or null
  1249. * @returns {Promise}
  1250. */
  1251. useVideoStream(newTrack) {
  1252. logger.debug(`useVideoStream: ${newTrack}`);
  1253. return new Promise((resolve, reject) => {
  1254. _replaceLocalVideoTrackQueue.enqueue(onFinish => {
  1255. const oldTrack = getLocalJitsiVideoTrack(APP.store.getState());
  1256. logger.debug(`useVideoStream: Replacing ${oldTrack} with ${newTrack}`);
  1257. if (oldTrack === newTrack) {
  1258. resolve();
  1259. onFinish();
  1260. return;
  1261. }
  1262. APP.store.dispatch(
  1263. replaceLocalTrack(oldTrack, newTrack, room))
  1264. .then(() => {
  1265. this._setSharingScreen(newTrack);
  1266. this.setVideoMuteStatus();
  1267. })
  1268. .then(resolve)
  1269. .catch(error => {
  1270. logger.error(`useVideoStream failed: ${error}`);
  1271. reject(error);
  1272. })
  1273. .then(onFinish);
  1274. });
  1275. });
  1276. },
  1277. /**
  1278. * Sets `this.isSharingScreen` depending on provided video stream.
  1279. * In case new screen sharing status is not equal previous one
  1280. * it updates desktop sharing buttons in UI
  1281. * and notifies external application.
  1282. *
  1283. * @param {JitsiLocalTrack} [newStream] new stream to use or null
  1284. * @private
  1285. * @returns {void}
  1286. */
  1287. _setSharingScreen(newStream) {
  1288. const wasSharingScreen = this.isSharingScreen;
  1289. this.isSharingScreen = newStream && newStream.videoType === 'desktop';
  1290. if (wasSharingScreen !== this.isSharingScreen) {
  1291. const details = {};
  1292. if (this.isSharingScreen) {
  1293. details.sourceType = newStream.sourceType;
  1294. }
  1295. APP.API.notifyScreenSharingStatusChanged(
  1296. this.isSharingScreen, details);
  1297. }
  1298. },
  1299. /**
  1300. * Start using provided audio stream.
  1301. * Stops previous audio stream.
  1302. * @param {JitsiLocalTrack} newTrack - new track to use or null
  1303. * @returns {Promise}
  1304. */
  1305. useAudioStream(newTrack) {
  1306. return new Promise((resolve, reject) => {
  1307. _replaceLocalAudioTrackQueue.enqueue(onFinish => {
  1308. const oldTrack = getLocalJitsiAudioTrack(APP.store.getState());
  1309. if (oldTrack === newTrack) {
  1310. resolve();
  1311. onFinish();
  1312. return;
  1313. }
  1314. APP.store.dispatch(
  1315. replaceLocalTrack(oldTrack, newTrack, room))
  1316. .then(() => {
  1317. this.setAudioMuteStatus(this.isLocalAudioMuted());
  1318. })
  1319. .then(resolve)
  1320. .catch(reject)
  1321. .then(onFinish);
  1322. });
  1323. });
  1324. },
  1325. /**
  1326. * Returns whether or not the conference is currently in audio only mode.
  1327. *
  1328. * @returns {boolean}
  1329. */
  1330. isAudioOnly() {
  1331. return Boolean(APP.store.getState()['features/base/audio-only'].enabled);
  1332. },
  1333. videoSwitchInProgress: false,
  1334. /**
  1335. * This fields stores a handler which will create a Promise which turns off
  1336. * the screen sharing and restores the previous video state (was there
  1337. * any video, before switching to screen sharing ? was it muted ?).
  1338. *
  1339. * Once called this fields is cleared to <tt>null</tt>.
  1340. * @type {Function|null}
  1341. */
  1342. _untoggleScreenSharing: null,
  1343. /**
  1344. * Creates a Promise which turns off the screen sharing and restores
  1345. * the previous state described by the arguments.
  1346. *
  1347. * This method is bound to the appropriate values, after switching to screen
  1348. * sharing and stored in {@link _untoggleScreenSharing}.
  1349. *
  1350. * @param {boolean} didHaveVideo indicates if there was a camera video being
  1351. * used, before switching to screen sharing.
  1352. * @param {boolean} ignoreDidHaveVideo indicates if the camera video should be
  1353. * ignored when switching screen sharing off.
  1354. * @return {Promise} resolved after the screen sharing is turned off, or
  1355. * rejected with some error (no idea what kind of error, possible GUM error)
  1356. * in case it fails.
  1357. * @private
  1358. */
  1359. async _turnScreenSharingOff(didHaveVideo, ignoreDidHaveVideo) {
  1360. this._untoggleScreenSharing = null;
  1361. this.videoSwitchInProgress = true;
  1362. APP.store.dispatch(stopReceiver());
  1363. this._stopProxyConnection();
  1364. APP.store.dispatch(toggleScreenshotCaptureSummary(false));
  1365. const tracks = APP.store.getState()['features/base/tracks'];
  1366. const duration = getLocalVideoTrack(tracks)?.jitsiTrack.getDuration() ?? 0;
  1367. // It can happen that presenter GUM is in progress while screensharing is being turned off. Here it needs to
  1368. // wait for that GUM to be resolved in order to prevent leaking the presenter track(this.localPresenterVideo
  1369. // will be null when SS is being turned off, but it will initialize once GUM resolves).
  1370. let promise = _prevMutePresenterVideo = _prevMutePresenterVideo.then(() => {
  1371. // mute the presenter track if it exists.
  1372. if (this.localPresenterVideo) {
  1373. APP.store.dispatch(setVideoMuted(true, MEDIA_TYPE.PRESENTER));
  1374. return this.localPresenterVideo.dispose().then(() => {
  1375. APP.store.dispatch(trackRemoved(this.localPresenterVideo));
  1376. this.localPresenterVideo = null;
  1377. });
  1378. }
  1379. });
  1380. // If system audio was also shared stop the AudioMixerEffect and dispose of the desktop audio track.
  1381. if (this._mixerEffect) {
  1382. const localAudio = getLocalJitsiAudioTrack(APP.store.getState());
  1383. await localAudio.setEffect(undefined);
  1384. await this._desktopAudioStream.dispose();
  1385. this._mixerEffect = undefined;
  1386. this._desktopAudioStream = undefined;
  1387. // In case there was no local audio when screen sharing was started the fact that we set the audio stream to
  1388. // null will take care of the desktop audio stream cleanup.
  1389. } else if (this._desktopAudioStream) {
  1390. await this.useAudioStream(null);
  1391. this._desktopAudioStream = undefined;
  1392. }
  1393. APP.store.dispatch(setScreenAudioShareState(false));
  1394. if (didHaveVideo && !ignoreDidHaveVideo) {
  1395. promise = promise.then(() => createLocalTracksF({ devices: [ 'video' ] }))
  1396. .then(([ stream ]) => {
  1397. logger.debug(`_turnScreenSharingOff using ${stream} for useVideoStream`);
  1398. return this.useVideoStream(stream);
  1399. })
  1400. .catch(error => {
  1401. logger.error('failed to switch back to local video', error);
  1402. return this.useVideoStream(null).then(() =>
  1403. // Still fail with the original err
  1404. Promise.reject(error)
  1405. );
  1406. });
  1407. } else {
  1408. promise = promise.then(() => {
  1409. logger.debug('_turnScreenSharingOff using null for useVideoStream');
  1410. return this.useVideoStream(null);
  1411. });
  1412. }
  1413. return promise.then(
  1414. () => {
  1415. this.videoSwitchInProgress = false;
  1416. sendAnalytics(createScreenSharingEvent('stopped',
  1417. duration === 0 ? null : duration));
  1418. logger.info('Screen sharing stopped.');
  1419. },
  1420. error => {
  1421. this.videoSwitchInProgress = false;
  1422. logger.error(`_turnScreenSharingOff failed: ${error}`);
  1423. throw error;
  1424. });
  1425. },
  1426. /**
  1427. * Toggles between screen sharing and camera video if the toggle parameter
  1428. * is not specified and starts the procedure for obtaining new screen
  1429. * sharing/video track otherwise.
  1430. *
  1431. * @param {boolean} [toggle] - If true - new screen sharing track will be
  1432. * obtained. If false - new video track will be obtain. If not specified -
  1433. * toggles between screen sharing and camera video.
  1434. * @param {Object} [options] - Screen sharing options that will be passed to
  1435. * createLocalTracks.
  1436. * @param {Array<string>} [options.desktopSharingSources] - Array with the
  1437. * sources that have to be displayed in the desktop picker window ('screen',
  1438. * 'window', etc.).
  1439. * @param {boolean} ignoreDidHaveVideo - if true ignore if video was on when sharing started.
  1440. * @return {Promise.<T>}
  1441. */
  1442. async toggleScreenSharing(toggle = !this._untoggleScreenSharing, options = {}, ignoreDidHaveVideo) {
  1443. logger.debug(`toggleScreenSharing: ${toggle}`);
  1444. if (this.videoSwitchInProgress) {
  1445. return Promise.reject(`toggleScreenSharing: ${toggle} aborted - video switch in progress.`);
  1446. }
  1447. if (!JitsiMeetJS.isDesktopSharingEnabled()) {
  1448. return Promise.reject('Cannot toggle screen sharing: not supported.');
  1449. }
  1450. if (this.isAudioOnly()) {
  1451. return Promise.reject('No screensharing in audio only mode');
  1452. }
  1453. if (toggle) {
  1454. try {
  1455. await this._switchToScreenSharing(options);
  1456. return;
  1457. } catch (err) {
  1458. logger.error('Failed to switch to screensharing', err);
  1459. return;
  1460. }
  1461. }
  1462. return this._untoggleScreenSharing
  1463. ? this._untoggleScreenSharing(ignoreDidHaveVideo)
  1464. : Promise.resolve();
  1465. },
  1466. /**
  1467. * Creates desktop (screensharing) {@link JitsiLocalTrack}
  1468. *
  1469. * @param {Object} [options] - Screen sharing options that will be passed to
  1470. * createLocalTracks.
  1471. * @param {Object} [options.desktopSharing]
  1472. * @param {Object} [options.desktopStream] - An existing desktop stream to
  1473. * use instead of creating a new desktop stream.
  1474. * @return {Promise.<JitsiLocalTrack>} - A Promise resolved with
  1475. * {@link JitsiLocalTrack} for the screensharing or rejected with
  1476. * {@link JitsiTrackError}.
  1477. *
  1478. * @private
  1479. */
  1480. _createDesktopTrack(options = {}) {
  1481. const didHaveVideo = !this.isLocalVideoMuted();
  1482. const getDesktopStreamPromise = options.desktopStream
  1483. ? Promise.resolve([ options.desktopStream ])
  1484. : createLocalTracksF({
  1485. desktopSharingSourceDevice: options.desktopSharingSources
  1486. ? null : config._desktopSharingSourceDevice,
  1487. desktopSharingSources: options.desktopSharingSources,
  1488. devices: [ 'desktop' ]
  1489. });
  1490. return getDesktopStreamPromise.then(desktopStreams => {
  1491. // Stores the "untoggle" handler which remembers whether was
  1492. // there any video before and whether was it muted.
  1493. this._untoggleScreenSharing
  1494. = this._turnScreenSharingOff.bind(this, didHaveVideo);
  1495. const desktopVideoStream = desktopStreams.find(stream => stream.getType() === MEDIA_TYPE.VIDEO);
  1496. const desktopAudioStream = desktopStreams.find(stream => stream.getType() === MEDIA_TYPE.AUDIO);
  1497. if (desktopAudioStream) {
  1498. desktopAudioStream.on(
  1499. JitsiTrackEvents.LOCAL_TRACK_STOPPED,
  1500. () => {
  1501. logger.debug(`Local screensharing audio track stopped. ${this.isSharingScreen}`);
  1502. // Handle case where screen share was stopped from the browsers 'screen share in progress'
  1503. // window. If audio screen sharing is stopped via the normal UX flow this point shouldn't
  1504. // be reached.
  1505. isScreenAudioShared(APP.store.getState())
  1506. && this._untoggleScreenSharing
  1507. && this._untoggleScreenSharing();
  1508. }
  1509. );
  1510. }
  1511. if (desktopVideoStream) {
  1512. desktopVideoStream.on(
  1513. JitsiTrackEvents.LOCAL_TRACK_STOPPED,
  1514. () => {
  1515. logger.debug(`Local screensharing track stopped. ${this.isSharingScreen}`);
  1516. // If the stream was stopped during screen sharing
  1517. // session then we should switch back to video.
  1518. this.isSharingScreen
  1519. && this._untoggleScreenSharing
  1520. && this._untoggleScreenSharing();
  1521. }
  1522. );
  1523. }
  1524. return desktopStreams;
  1525. }, error => {
  1526. throw error;
  1527. });
  1528. },
  1529. /**
  1530. * Creates a new instance of presenter effect. A new video track is created
  1531. * using the new set of constraints that are calculated based on
  1532. * the height of the desktop that is being currently shared.
  1533. *
  1534. * @param {number} height - The height of the desktop stream that is being
  1535. * currently shared.
  1536. * @param {string} cameraDeviceId - The device id of the camera to be used.
  1537. * @return {Promise<JitsiStreamPresenterEffect>} - A promise resolved with
  1538. * {@link JitsiStreamPresenterEffect} if it succeeds.
  1539. */
  1540. async _createPresenterStreamEffect(height = null, cameraDeviceId = null) {
  1541. if (!this.localPresenterVideo) {
  1542. const camera = cameraDeviceId ?? getUserSelectedCameraDeviceId(APP.store.getState());
  1543. try {
  1544. this.localPresenterVideo = await createLocalPresenterTrack({ cameraDeviceId: camera }, height);
  1545. } catch (err) {
  1546. logger.error('Failed to create a camera track for presenter', err);
  1547. return;
  1548. }
  1549. APP.store.dispatch(trackAdded(this.localPresenterVideo));
  1550. }
  1551. try {
  1552. const effect = await createPresenterEffect(this.localPresenterVideo.stream);
  1553. return effect;
  1554. } catch (err) {
  1555. logger.error('Failed to create the presenter effect', err);
  1556. }
  1557. },
  1558. /**
  1559. * Tries to turn the presenter video track on or off. If a presenter track
  1560. * doesn't exist, a new video track is created.
  1561. *
  1562. * @param mute - true for mute and false for unmute.
  1563. *
  1564. * @private
  1565. */
  1566. async _mutePresenterVideo(mute) {
  1567. const maybeShowErrorDialog = error => {
  1568. APP.store.dispatch(notifyCameraError(error));
  1569. };
  1570. // Check for NO-OP
  1571. if (mute && (!this.localPresenterVideo || this.localPresenterVideo.isMuted())) {
  1572. return;
  1573. } else if (!mute && this.localPresenterVideo && !this.localPresenterVideo.isMuted()) {
  1574. return;
  1575. }
  1576. // Create a new presenter track and apply the presenter effect.
  1577. if (!this.localPresenterVideo && !mute) {
  1578. const localVideo = getLocalJitsiVideoTrack(APP.store.getState());
  1579. const { height, width } = localVideo.track.getSettings() ?? localVideo.track.getConstraints();
  1580. const isPortrait = height >= width;
  1581. const DESKTOP_STREAM_CAP = 720;
  1582. const highResolutionTrack
  1583. = (isPortrait && width > DESKTOP_STREAM_CAP) || (!isPortrait && height > DESKTOP_STREAM_CAP);
  1584. // Resizing the desktop track for presenter is causing blurriness of the desktop share on chrome.
  1585. // Disable resizing by default, enable it only when config.js setting is enabled.
  1586. const resizeDesktopStream = highResolutionTrack && config.videoQuality?.resizeDesktopForPresenter;
  1587. if (resizeDesktopStream) {
  1588. let desktopResizeConstraints = {};
  1589. if (height && width) {
  1590. const advancedConstraints = [ { aspectRatio: (width / height).toPrecision(4) } ];
  1591. const constraint = isPortrait ? { width: DESKTOP_STREAM_CAP } : { height: DESKTOP_STREAM_CAP };
  1592. advancedConstraints.push(constraint);
  1593. desktopResizeConstraints.advanced = advancedConstraints;
  1594. } else {
  1595. desktopResizeConstraints = {
  1596. width: 1280,
  1597. height: 720
  1598. };
  1599. }
  1600. // Apply the constraints on the desktop track.
  1601. try {
  1602. await localVideo.track.applyConstraints(desktopResizeConstraints);
  1603. } catch (err) {
  1604. logger.error('Failed to apply constraints on the desktop stream for presenter mode', err);
  1605. return;
  1606. }
  1607. }
  1608. const trackHeight = resizeDesktopStream
  1609. ? localVideo.track.getSettings().height ?? DESKTOP_STREAM_CAP
  1610. : height;
  1611. let effect;
  1612. try {
  1613. effect = await this._createPresenterStreamEffect(trackHeight);
  1614. } catch (err) {
  1615. logger.error('Failed to unmute Presenter Video', err);
  1616. maybeShowErrorDialog(err);
  1617. return;
  1618. }
  1619. // Replace the desktop track on the peerconnection.
  1620. try {
  1621. await localVideo.setEffect(effect);
  1622. APP.store.dispatch(setVideoMuted(mute, MEDIA_TYPE.PRESENTER));
  1623. this.setVideoMuteStatus();
  1624. } catch (err) {
  1625. logger.error('Failed to apply the Presenter effect', err);
  1626. }
  1627. } else {
  1628. APP.store.dispatch(setVideoMuted(mute, MEDIA_TYPE.PRESENTER));
  1629. }
  1630. },
  1631. /**
  1632. * Tries to switch to the screensharing mode by disposing camera stream and
  1633. * replacing it with a desktop one.
  1634. *
  1635. * @param {Object} [options] - Screen sharing options that will be passed to
  1636. * createLocalTracks.
  1637. *
  1638. * @return {Promise} - A Promise resolved if the operation succeeds or
  1639. * rejected with some unknown type of error in case it fails. Promise will
  1640. * be rejected immediately if {@link videoSwitchInProgress} is true.
  1641. *
  1642. * @private
  1643. */
  1644. _switchToScreenSharing(options = {}) {
  1645. if (this.videoSwitchInProgress) {
  1646. return Promise.reject('Switch in progress.');
  1647. }
  1648. this.videoSwitchInProgress = true;
  1649. return this._createDesktopTrack(options)
  1650. .then(async streams => {
  1651. let desktopVideoStream = streams.find(stream => stream.getType() === MEDIA_TYPE.VIDEO);
  1652. this._desktopAudioStream = streams.find(stream => stream.getType() === MEDIA_TYPE.AUDIO);
  1653. const { audioOnly = false } = options;
  1654. // If we're in audio only mode dispose of the video track otherwise the screensharing state will be
  1655. // inconsistent.
  1656. if (audioOnly) {
  1657. desktopVideoStream.dispose();
  1658. desktopVideoStream = undefined;
  1659. if (!this._desktopAudioStream) {
  1660. return Promise.reject(AUDIO_ONLY_SCREEN_SHARE_NO_TRACK);
  1661. }
  1662. }
  1663. if (desktopVideoStream) {
  1664. logger.debug(`_switchToScreenSharing is using ${desktopVideoStream} for useVideoStream`);
  1665. await this.useVideoStream(desktopVideoStream);
  1666. }
  1667. if (this._desktopAudioStream) {
  1668. const localAudio = getLocalJitsiAudioTrack(APP.store.getState());
  1669. // If there is a localAudio stream, mix in the desktop audio stream captured by the screen sharing
  1670. // api.
  1671. if (localAudio) {
  1672. this._mixerEffect = new AudioMixerEffect(this._desktopAudioStream);
  1673. await localAudio.setEffect(this._mixerEffect);
  1674. } else {
  1675. // If no local stream is present ( i.e. no input audio devices) we use the screen share audio
  1676. // stream as we would use a regular stream.
  1677. await this.useAudioStream(this._desktopAudioStream);
  1678. }
  1679. APP.store.dispatch(setScreenAudioShareState(true));
  1680. }
  1681. })
  1682. .then(() => {
  1683. this.videoSwitchInProgress = false;
  1684. if (isScreenshotCaptureEnabled(APP.store.getState(), false, true)) {
  1685. APP.store.dispatch(toggleScreenshotCaptureSummary(true));
  1686. }
  1687. sendAnalytics(createScreenSharingEvent('started'));
  1688. logger.log('Screen sharing started');
  1689. })
  1690. .catch(error => {
  1691. this.videoSwitchInProgress = false;
  1692. // Pawel: With this call I'm trying to preserve the original
  1693. // behaviour although it is not clear why would we "untoggle"
  1694. // on failure. I suppose it was to restore video in case there
  1695. // was some problem during "this.useVideoStream(desktopStream)".
  1696. // It's important to note that the handler will not be available
  1697. // if we fail early on trying to get desktop media (which makes
  1698. // sense, because the camera video is still being used, so
  1699. // nothing to "untoggle").
  1700. if (this._untoggleScreenSharing) {
  1701. this._untoggleScreenSharing();
  1702. }
  1703. // FIXME the code inside of _handleScreenSharingError is
  1704. // asynchronous, but does not return a Promise and is not part
  1705. // of the current Promise chain.
  1706. this._handleScreenSharingError(error);
  1707. return Promise.reject(error);
  1708. });
  1709. },
  1710. /**
  1711. * Handles {@link JitsiTrackError} returned by the lib-jitsi-meet when
  1712. * trying to create screensharing track. It will either do nothing if
  1713. * the dialog was canceled on user's request or display an error if
  1714. * screensharing couldn't be started.
  1715. * @param {JitsiTrackError} error - The error returned by
  1716. * {@link _createDesktopTrack} Promise.
  1717. * @private
  1718. */
  1719. _handleScreenSharingError(error) {
  1720. if (error.name === JitsiTrackErrors.SCREENSHARING_USER_CANCELED) {
  1721. return;
  1722. }
  1723. logger.error('failed to share local desktop', error);
  1724. // Handling:
  1725. // JitsiTrackErrors.CONSTRAINT_FAILED
  1726. // JitsiTrackErrors.PERMISSION_DENIED
  1727. // JitsiTrackErrors.SCREENSHARING_GENERIC_ERROR
  1728. // and any other
  1729. let descriptionKey;
  1730. let titleKey;
  1731. if (error.name === JitsiTrackErrors.PERMISSION_DENIED) {
  1732. descriptionKey = 'dialog.screenSharingPermissionDeniedError';
  1733. titleKey = 'dialog.screenSharingFailedTitle';
  1734. } else if (error.name === JitsiTrackErrors.CONSTRAINT_FAILED) {
  1735. descriptionKey = 'dialog.cameraConstraintFailedError';
  1736. titleKey = 'deviceError.cameraError';
  1737. } else if (error.name === JitsiTrackErrors.SCREENSHARING_GENERIC_ERROR) {
  1738. descriptionKey = 'dialog.screenSharingFailed';
  1739. titleKey = 'dialog.screenSharingFailedTitle';
  1740. } else if (error === AUDIO_ONLY_SCREEN_SHARE_NO_TRACK) {
  1741. descriptionKey = 'notify.screenShareNoAudio';
  1742. titleKey = 'notify.screenShareNoAudioTitle';
  1743. }
  1744. APP.UI.messageHandler.showError({
  1745. descriptionKey,
  1746. titleKey
  1747. });
  1748. },
  1749. /**
  1750. * Setup interaction between conference and UI.
  1751. */
  1752. _setupListeners() {
  1753. // add local streams when joined to the conference
  1754. room.on(JitsiConferenceEvents.CONFERENCE_JOINED, () => {
  1755. this._onConferenceJoined();
  1756. });
  1757. room.on(JitsiConferenceEvents.CONFERENCE_JOIN_IN_PROGRESS, () => {
  1758. APP.store.dispatch(setPrejoinPageVisibility(false));
  1759. });
  1760. room.on(
  1761. JitsiConferenceEvents.CONFERENCE_LEFT,
  1762. (...args) => {
  1763. APP.store.dispatch(conferenceTimestampChanged(0));
  1764. APP.store.dispatch(conferenceLeft(room, ...args));
  1765. });
  1766. room.on(
  1767. JitsiConferenceEvents.CONFERENCE_UNIQUE_ID_SET,
  1768. (...args) => {
  1769. // Preserve the sessionId so that the value is accessible even after room
  1770. // is disconnected.
  1771. room.sessionId = room.getMeetingUniqueId();
  1772. APP.store.dispatch(conferenceUniqueIdSet(room, ...args));
  1773. });
  1774. room.on(
  1775. JitsiConferenceEvents.AUTH_STATUS_CHANGED,
  1776. (authEnabled, authLogin) =>
  1777. APP.store.dispatch(authStatusChanged(authEnabled, authLogin)));
  1778. room.on(JitsiConferenceEvents.PARTCIPANT_FEATURES_CHANGED, user => {
  1779. APP.store.dispatch(updateRemoteParticipantFeatures(user));
  1780. });
  1781. room.on(JitsiConferenceEvents.USER_JOINED, (id, user) => {
  1782. if (config.iAmRecorder && user.isHiddenFromRecorder()) {
  1783. return;
  1784. }
  1785. // The logic shared between RN and web.
  1786. commonUserJoinedHandling(APP.store, room, user);
  1787. if (user.isHidden()) {
  1788. return;
  1789. }
  1790. APP.store.dispatch(updateRemoteParticipantFeatures(user));
  1791. logger.log(`USER ${id} connected:`, user);
  1792. APP.UI.addUser(user);
  1793. });
  1794. room.on(JitsiConferenceEvents.USER_LEFT, (id, user) => {
  1795. // The logic shared between RN and web.
  1796. commonUserLeftHandling(APP.store, room, user);
  1797. if (user.isHidden()) {
  1798. return;
  1799. }
  1800. logger.log(`USER ${id} LEFT:`, user);
  1801. });
  1802. room.on(JitsiConferenceEvents.USER_STATUS_CHANGED, (id, status) => {
  1803. APP.store.dispatch(participantPresenceChanged(id, status));
  1804. const user = room.getParticipantById(id);
  1805. if (user) {
  1806. APP.UI.updateUserStatus(user, status);
  1807. }
  1808. });
  1809. room.on(JitsiConferenceEvents.USER_ROLE_CHANGED, (id, role) => {
  1810. if (this.isLocalId(id)) {
  1811. logger.info(`My role changed, new role: ${role}`);
  1812. APP.store.dispatch(localParticipantRoleChanged(role));
  1813. APP.API.notifyUserRoleChanged(id, role);
  1814. } else {
  1815. APP.store.dispatch(participantRoleChanged(id, role));
  1816. }
  1817. });
  1818. room.on(JitsiConferenceEvents.TRACK_ADDED, track => {
  1819. if (!track || track.isLocal()) {
  1820. return;
  1821. }
  1822. if (config.iAmRecorder) {
  1823. const participant = room.getParticipantById(track.getParticipantId());
  1824. if (participant.isHiddenFromRecorder()) {
  1825. return;
  1826. }
  1827. }
  1828. APP.store.dispatch(trackAdded(track));
  1829. });
  1830. room.on(JitsiConferenceEvents.TRACK_REMOVED, track => {
  1831. if (!track || track.isLocal()) {
  1832. return;
  1833. }
  1834. APP.store.dispatch(trackRemoved(track));
  1835. });
  1836. room.on(JitsiConferenceEvents.TRACK_AUDIO_LEVEL_CHANGED, (id, lvl) => {
  1837. const localAudio = getLocalJitsiAudioTrack(APP.store.getState());
  1838. let newLvl = lvl;
  1839. if (this.isLocalId(id)) {
  1840. APP.store.dispatch(localParticipantAudioLevelChanged(lvl));
  1841. }
  1842. if (this.isLocalId(id) && localAudio?.isMuted()) {
  1843. newLvl = 0;
  1844. }
  1845. if (config.debug) {
  1846. this.audioLevelsMap[id] = newLvl;
  1847. if (config.debugAudioLevels) {
  1848. logger.log(`AudioLevel:${id}/${newLvl}`);
  1849. }
  1850. }
  1851. APP.UI.setAudioLevel(id, newLvl);
  1852. });
  1853. room.on(JitsiConferenceEvents.TRACK_MUTE_CHANGED, (track, participantThatMutedUs) => {
  1854. if (participantThatMutedUs) {
  1855. APP.store.dispatch(participantMutedUs(participantThatMutedUs, track));
  1856. if (this.isSharingScreen && track.isVideoTrack()) {
  1857. logger.debug('TRACK_MUTE_CHANGED while screen sharing');
  1858. this._turnScreenSharingOff(false);
  1859. }
  1860. }
  1861. });
  1862. room.on(JitsiConferenceEvents.TRACK_UNMUTE_REJECTED, track => APP.store.dispatch(destroyLocalTracks(track)));
  1863. room.on(JitsiConferenceEvents.SUBJECT_CHANGED,
  1864. subject => APP.store.dispatch(conferenceSubjectChanged(subject)));
  1865. room.on(
  1866. JitsiConferenceEvents.LAST_N_ENDPOINTS_CHANGED,
  1867. (leavingIds, enteringIds) =>
  1868. APP.UI.handleLastNEndpoints(leavingIds, enteringIds));
  1869. room.on(
  1870. JitsiConferenceEvents.P2P_STATUS,
  1871. (jitsiConference, p2p) =>
  1872. APP.store.dispatch(p2pStatusChanged(p2p)));
  1873. room.on(
  1874. JitsiConferenceEvents.PARTICIPANT_CONN_STATUS_CHANGED,
  1875. (id, connectionStatus) => APP.store.dispatch(
  1876. participantConnectionStatusChanged(id, connectionStatus)));
  1877. room.on(
  1878. JitsiConferenceEvents.DOMINANT_SPEAKER_CHANGED,
  1879. (dominant, previous) => APP.store.dispatch(dominantSpeakerChanged(dominant, previous, room)));
  1880. room.on(
  1881. JitsiConferenceEvents.CONFERENCE_CREATED_TIMESTAMP,
  1882. conferenceTimestamp => APP.store.dispatch(conferenceTimestampChanged(conferenceTimestamp)));
  1883. room.on(JitsiConferenceEvents.CONNECTION_INTERRUPTED, () => {
  1884. APP.store.dispatch(localParticipantConnectionStatusChanged(
  1885. JitsiParticipantConnectionStatus.INTERRUPTED));
  1886. });
  1887. room.on(JitsiConferenceEvents.CONNECTION_RESTORED, () => {
  1888. APP.store.dispatch(localParticipantConnectionStatusChanged(
  1889. JitsiParticipantConnectionStatus.ACTIVE));
  1890. });
  1891. room.on(
  1892. JitsiConferenceEvents.DISPLAY_NAME_CHANGED,
  1893. (id, displayName) => {
  1894. const formattedDisplayName
  1895. = getNormalizedDisplayName(displayName);
  1896. const state = APP.store.getState();
  1897. const {
  1898. defaultRemoteDisplayName
  1899. } = state['features/base/config'];
  1900. APP.store.dispatch(participantUpdated({
  1901. conference: room,
  1902. id,
  1903. name: formattedDisplayName
  1904. }));
  1905. APP.API.notifyDisplayNameChanged(id, {
  1906. displayName: formattedDisplayName,
  1907. formattedDisplayName:
  1908. appendSuffix(
  1909. formattedDisplayName
  1910. || defaultRemoteDisplayName)
  1911. });
  1912. }
  1913. );
  1914. room.on(
  1915. JitsiConferenceEvents.BOT_TYPE_CHANGED,
  1916. (id, botType) => {
  1917. APP.store.dispatch(participantUpdated({
  1918. conference: room,
  1919. id,
  1920. botType
  1921. }));
  1922. }
  1923. );
  1924. room.on(
  1925. JitsiConferenceEvents.ENDPOINT_MESSAGE_RECEIVED,
  1926. (...args) => {
  1927. APP.store.dispatch(endpointMessageReceived(...args));
  1928. if (args && args.length >= 2) {
  1929. const [ sender, eventData ] = args;
  1930. if (eventData.name === ENDPOINT_TEXT_MESSAGE_NAME) {
  1931. APP.API.notifyEndpointTextMessageReceived({
  1932. senderInfo: {
  1933. jid: sender._jid,
  1934. id: sender._id
  1935. },
  1936. eventData
  1937. });
  1938. }
  1939. }
  1940. });
  1941. room.on(
  1942. JitsiConferenceEvents.NON_PARTICIPANT_MESSAGE_RECEIVED,
  1943. (...args) => APP.store.dispatch(nonParticipantMessageReceived(...args)));
  1944. room.on(
  1945. JitsiConferenceEvents.LOCK_STATE_CHANGED,
  1946. (...args) => APP.store.dispatch(lockStateChanged(room, ...args)));
  1947. room.on(JitsiConferenceEvents.KICKED, (participant, reason, isReplaced) => {
  1948. if (isReplaced) {
  1949. // this event triggers when the local participant is kicked, `participant`
  1950. // is the kicker. In replace participant case, kicker is undefined,
  1951. // as the server initiated it. We mark in store the local participant
  1952. // as being replaced based on jwt.
  1953. const localParticipant = getLocalParticipant(APP.store.getState());
  1954. APP.store.dispatch(participantUpdated({
  1955. conference: room,
  1956. id: localParticipant.id,
  1957. isReplaced
  1958. }));
  1959. // we send readyToClose when kicked participant is replace so that
  1960. // embedding app can choose to dispose the iframe API on the handler.
  1961. APP.API.notifyReadyToClose();
  1962. }
  1963. APP.store.dispatch(kickedOut(room, participant));
  1964. });
  1965. room.on(JitsiConferenceEvents.PARTICIPANT_KICKED, (kicker, kicked) => {
  1966. APP.store.dispatch(participantKicked(kicker, kicked));
  1967. });
  1968. room.on(JitsiConferenceEvents.SUSPEND_DETECTED, () => {
  1969. APP.store.dispatch(suspendDetected());
  1970. });
  1971. room.on(
  1972. JitsiConferenceEvents.AUDIO_UNMUTE_PERMISSIONS_CHANGED,
  1973. disableAudioMuteChange => {
  1974. APP.store.dispatch(setAudioUnmutePermissions(disableAudioMuteChange));
  1975. });
  1976. room.on(
  1977. JitsiConferenceEvents.VIDEO_UNMUTE_PERMISSIONS_CHANGED,
  1978. disableVideoMuteChange => {
  1979. APP.store.dispatch(setVideoUnmutePermissions(disableVideoMuteChange));
  1980. });
  1981. APP.UI.addListener(UIEvents.AUDIO_MUTED, muted => {
  1982. this.muteAudio(muted);
  1983. });
  1984. APP.UI.addListener(UIEvents.VIDEO_MUTED, muted => {
  1985. this.muteVideo(muted);
  1986. });
  1987. room.addCommandListener(this.commands.defaults.ETHERPAD,
  1988. ({ value }) => {
  1989. APP.UI.initEtherpad(value);
  1990. }
  1991. );
  1992. APP.UI.addListener(UIEvents.EMAIL_CHANGED,
  1993. this.changeLocalEmail.bind(this));
  1994. room.addCommandListener(this.commands.defaults.EMAIL, (data, from) => {
  1995. APP.store.dispatch(participantUpdated({
  1996. conference: room,
  1997. id: from,
  1998. email: data.value
  1999. }));
  2000. });
  2001. room.addCommandListener(
  2002. this.commands.defaults.AVATAR_URL,
  2003. (data, from) => {
  2004. APP.store.dispatch(
  2005. participantUpdated({
  2006. conference: room,
  2007. id: from,
  2008. avatarURL: data.value
  2009. }));
  2010. });
  2011. APP.UI.addListener(UIEvents.NICKNAME_CHANGED,
  2012. this.changeLocalDisplayName.bind(this));
  2013. room.on(
  2014. JitsiConferenceEvents.START_MUTED_POLICY_CHANGED,
  2015. ({ audio, video }) => {
  2016. APP.store.dispatch(
  2017. onStartMutedPolicyChanged(audio, video));
  2018. }
  2019. );
  2020. room.on(JitsiConferenceEvents.STARTED_MUTED, () => {
  2021. const audioMuted = room.isStartAudioMuted();
  2022. const videoMuted = room.isStartVideoMuted();
  2023. const localTracks = getLocalTracks(APP.store.getState()['features/base/tracks']);
  2024. const promises = [];
  2025. APP.store.dispatch(setAudioMuted(audioMuted));
  2026. APP.store.dispatch(setVideoMuted(videoMuted));
  2027. // Remove the tracks from the peerconnection.
  2028. for (const track of localTracks) {
  2029. // Always add the track on Safari because of a known issue where audio playout doesn't happen
  2030. // if the user joins audio and video muted, i.e., if there is no local media capture.
  2031. if (audioMuted && track.jitsiTrack?.getType() === MEDIA_TYPE.AUDIO && !browser.isWebKitBased()) {
  2032. promises.push(this.useAudioStream(null));
  2033. }
  2034. if (videoMuted && track.jitsiTrack?.getType() === MEDIA_TYPE.VIDEO) {
  2035. promises.push(this.useVideoStream(null));
  2036. }
  2037. }
  2038. Promise.allSettled(promises)
  2039. .then(() => {
  2040. APP.store.dispatch(showNotification({
  2041. titleKey: 'notify.mutedTitle',
  2042. descriptionKey: 'notify.muted'
  2043. }, NOTIFICATION_TIMEOUT_TYPE.SHORT));
  2044. });
  2045. });
  2046. room.on(
  2047. JitsiConferenceEvents.DATA_CHANNEL_OPENED, () => {
  2048. APP.store.dispatch(dataChannelOpened());
  2049. }
  2050. );
  2051. // call hangup
  2052. APP.UI.addListener(UIEvents.HANGUP, () => {
  2053. this.hangup(true);
  2054. });
  2055. // logout
  2056. APP.UI.addListener(UIEvents.LOGOUT, () => {
  2057. AuthHandler.logout(room).then(url => {
  2058. if (url) {
  2059. UIUtil.redirect(url);
  2060. } else {
  2061. this.hangup(true);
  2062. }
  2063. });
  2064. });
  2065. APP.UI.addListener(UIEvents.AUTH_CLICKED, () => {
  2066. AuthHandler.authenticate(room);
  2067. });
  2068. APP.UI.addListener(
  2069. UIEvents.VIDEO_DEVICE_CHANGED,
  2070. cameraDeviceId => {
  2071. const localVideo = getLocalJitsiVideoTrack(APP.store.getState());
  2072. const videoWasMuted = this.isLocalVideoMuted();
  2073. sendAnalytics(createDeviceChangedEvent('video', 'input'));
  2074. // If both screenshare and video are in progress, restart the
  2075. // presenter mode with the new camera device.
  2076. if (this.isSharingScreen && !videoWasMuted) {
  2077. const { height } = localVideo.track.getSettings();
  2078. // dispose the existing presenter track and create a new
  2079. // camera track.
  2080. // FIXME JitsiLocalTrack.dispose is async and should be waited for
  2081. this.localPresenterVideo && this.localPresenterVideo.dispose();
  2082. this.localPresenterVideo = null;
  2083. return this._createPresenterStreamEffect(height, cameraDeviceId)
  2084. .then(effect => localVideo.setEffect(effect))
  2085. .then(() => {
  2086. this.setVideoMuteStatus();
  2087. logger.log('Switched local video device while screen sharing and the video is unmuted');
  2088. this._updateVideoDeviceId();
  2089. })
  2090. .catch(err => APP.store.dispatch(notifyCameraError(err)));
  2091. // If screenshare is in progress but video is muted, update the default device
  2092. // id for video, dispose the existing presenter track and create a new effect
  2093. // that can be applied on un-mute.
  2094. } else if (this.isSharingScreen && videoWasMuted) {
  2095. logger.log('Switched local video device: while screen sharing and the video is muted');
  2096. const { height } = localVideo.track.getSettings();
  2097. this._updateVideoDeviceId();
  2098. // FIXME JitsiLocalTrack.dispose is async and should be waited for
  2099. this.localPresenterVideo && this.localPresenterVideo.dispose();
  2100. this.localPresenterVideo = null;
  2101. this._createPresenterStreamEffect(height, cameraDeviceId);
  2102. // if there is only video, switch to the new camera stream.
  2103. } else {
  2104. createLocalTracksF({
  2105. devices: [ 'video' ],
  2106. cameraDeviceId,
  2107. micDeviceId: null
  2108. })
  2109. .then(([ stream ]) => {
  2110. // if we are in audio only mode or video was muted before
  2111. // changing device, then mute
  2112. if (this.isAudioOnly() || videoWasMuted) {
  2113. return stream.mute()
  2114. .then(() => stream);
  2115. }
  2116. return stream;
  2117. })
  2118. .then(stream => {
  2119. logger.log('Switching the local video device.');
  2120. return this.useVideoStream(stream);
  2121. })
  2122. .then(() => {
  2123. logger.log('Switched local video device.');
  2124. this._updateVideoDeviceId();
  2125. })
  2126. .catch(error => {
  2127. logger.error(`Switching the local video device failed: ${error}`);
  2128. return APP.store.dispatch(notifyCameraError(error));
  2129. });
  2130. }
  2131. }
  2132. );
  2133. APP.UI.addListener(
  2134. UIEvents.AUDIO_DEVICE_CHANGED,
  2135. micDeviceId => {
  2136. const audioWasMuted = this.isLocalAudioMuted();
  2137. // When the 'default' mic needs to be selected, we need to
  2138. // pass the real device id to gUM instead of 'default' in order
  2139. // to get the correct MediaStreamTrack from chrome because of the
  2140. // following bug.
  2141. // https://bugs.chromium.org/p/chromium/issues/detail?id=997689
  2142. const hasDefaultMicChanged = micDeviceId === 'default';
  2143. sendAnalytics(createDeviceChangedEvent('audio', 'input'));
  2144. createLocalTracksF({
  2145. devices: [ 'audio' ],
  2146. cameraDeviceId: null,
  2147. micDeviceId: hasDefaultMicChanged
  2148. ? getDefaultDeviceId(APP.store.getState(), 'audioInput')
  2149. : micDeviceId
  2150. })
  2151. .then(([ stream ]) => {
  2152. // if audio was muted before changing the device, mute
  2153. // with the new device
  2154. if (audioWasMuted) {
  2155. return stream.mute()
  2156. .then(() => stream);
  2157. }
  2158. return stream;
  2159. })
  2160. .then(async stream => {
  2161. // In case screen sharing audio is also shared we mix it with new input stream. The old _mixerEffect
  2162. // will be cleaned up when the existing track is replaced.
  2163. if (this._mixerEffect) {
  2164. this._mixerEffect = new AudioMixerEffect(this._desktopAudioStream);
  2165. await stream.setEffect(this._mixerEffect);
  2166. }
  2167. return this.useAudioStream(stream);
  2168. })
  2169. .then(() => {
  2170. const localAudio = getLocalJitsiAudioTrack(APP.store.getState());
  2171. if (localAudio && hasDefaultMicChanged) {
  2172. // workaround for the default device to be shown as selected in the
  2173. // settings even when the real device id was passed to gUM because of the
  2174. // above mentioned chrome bug.
  2175. localAudio._realDeviceId = localAudio.deviceId = 'default';
  2176. }
  2177. logger.log(`switched local audio device: ${localAudio?.getDeviceId()}`);
  2178. this._updateAudioDeviceId();
  2179. })
  2180. .catch(err => {
  2181. APP.store.dispatch(notifyMicError(err));
  2182. });
  2183. }
  2184. );
  2185. APP.UI.addListener(UIEvents.TOGGLE_AUDIO_ONLY, audioOnly => {
  2186. // FIXME On web video track is stored both in redux and in
  2187. // 'localVideo' field, video is attempted to be unmuted twice when
  2188. // turning off the audio only mode. This will crash the app with
  2189. // 'unmute operation is already in progress'.
  2190. // Because there's no logic in redux about creating new track in
  2191. // case unmute when not track exists the things have to go through
  2192. // muteVideo logic in such case.
  2193. const tracks = APP.store.getState()['features/base/tracks'];
  2194. const isTrackInRedux
  2195. = Boolean(
  2196. tracks.find(
  2197. track => track.jitsiTrack
  2198. && track.jitsiTrack.getType() === 'video'));
  2199. if (!isTrackInRedux) {
  2200. this.muteVideo(audioOnly);
  2201. }
  2202. // Immediately update the UI by having remote videos and the large
  2203. // video update themselves instead of waiting for some other event
  2204. // to cause the update, usually PARTICIPANT_CONN_STATUS_CHANGED.
  2205. // There is no guarantee another event will trigger the update
  2206. // immediately and in all situations, for example because a remote
  2207. // participant is having connection trouble so no status changes.
  2208. const displayedUserId = APP.UI.getLargeVideoID();
  2209. if (displayedUserId) {
  2210. APP.UI.updateLargeVideo(displayedUserId, true);
  2211. }
  2212. });
  2213. APP.UI.addListener(
  2214. UIEvents.TOGGLE_SCREENSHARING, ({ enabled, audioOnly, ignoreDidHaveVideo }) => {
  2215. this.toggleScreenSharing(enabled, { audioOnly }, ignoreDidHaveVideo);
  2216. }
  2217. );
  2218. },
  2219. /**
  2220. * Cleanups local conference on suspend.
  2221. */
  2222. onSuspendDetected() {
  2223. // After wake up, we will be in a state where conference is left
  2224. // there will be dialog shown to user.
  2225. // We do not want video/audio as we show an overlay and after it
  2226. // user need to rejoin or close, while waking up we can detect
  2227. // camera wakeup as a problem with device.
  2228. // We also do not care about device change, which happens
  2229. // on resume after suspending PC.
  2230. if (this.deviceChangeListener) {
  2231. JitsiMeetJS.mediaDevices.removeEventListener(
  2232. JitsiMediaDevicesEvents.DEVICE_LIST_CHANGED,
  2233. this.deviceChangeListener);
  2234. }
  2235. },
  2236. /**
  2237. * Callback invoked when the conference has been successfully joined.
  2238. * Initializes the UI and various other features.
  2239. *
  2240. * @private
  2241. * @returns {void}
  2242. */
  2243. _onConferenceJoined() {
  2244. const { dispatch } = APP.store;
  2245. APP.UI.initConference();
  2246. if (!config.disableShortcuts) {
  2247. APP.keyboardshortcut.init();
  2248. }
  2249. dispatch(conferenceJoined(room));
  2250. const jwt = APP.store.getState()['features/base/jwt'];
  2251. if (jwt?.user?.hiddenFromRecorder) {
  2252. dispatch(muteLocal(true, MEDIA_TYPE.AUDIO));
  2253. dispatch(muteLocal(true, MEDIA_TYPE.VIDEO));
  2254. dispatch(setAudioUnmutePermissions(true, true));
  2255. dispatch(setVideoUnmutePermissions(true, true));
  2256. }
  2257. },
  2258. /**
  2259. * Updates the list of current devices.
  2260. * @param {boolean} setDeviceListChangeHandler - Whether to add the deviceList change handlers.
  2261. * @private
  2262. * @returns {Promise}
  2263. */
  2264. _initDeviceList(setDeviceListChangeHandler = false) {
  2265. const { mediaDevices } = JitsiMeetJS;
  2266. if (mediaDevices.isDeviceListAvailable()
  2267. && mediaDevices.isDeviceChangeAvailable()) {
  2268. if (setDeviceListChangeHandler) {
  2269. this.deviceChangeListener = devices =>
  2270. window.setTimeout(() => this._onDeviceListChanged(devices), 0);
  2271. mediaDevices.addEventListener(
  2272. JitsiMediaDevicesEvents.DEVICE_LIST_CHANGED,
  2273. this.deviceChangeListener);
  2274. }
  2275. const { dispatch } = APP.store;
  2276. return dispatch(getAvailableDevices())
  2277. .then(devices => {
  2278. // Ugly way to synchronize real device IDs with local
  2279. // storage and settings menu. This is a workaround until
  2280. // getConstraints() method will be implemented in browsers.
  2281. this._updateAudioDeviceId();
  2282. this._updateVideoDeviceId();
  2283. APP.UI.onAvailableDevicesChanged(devices);
  2284. });
  2285. }
  2286. return Promise.resolve();
  2287. },
  2288. /**
  2289. * Updates the settings for the currently used video device, extracting
  2290. * the device id from the used track.
  2291. * @private
  2292. */
  2293. _updateVideoDeviceId() {
  2294. const localVideo = getLocalJitsiVideoTrack(APP.store.getState());
  2295. if (localVideo && localVideo.videoType === 'camera') {
  2296. APP.store.dispatch(updateSettings({
  2297. cameraDeviceId: localVideo.getDeviceId()
  2298. }));
  2299. }
  2300. // If screenshare is in progress, get the device id from the presenter track.
  2301. if (this.localPresenterVideo) {
  2302. APP.store.dispatch(updateSettings({
  2303. cameraDeviceId: this.localPresenterVideo.getDeviceId()
  2304. }));
  2305. }
  2306. },
  2307. /**
  2308. * Updates the settings for the currently used audio device, extracting
  2309. * the device id from the used track.
  2310. * @private
  2311. */
  2312. _updateAudioDeviceId() {
  2313. const localAudio = getLocalJitsiAudioTrack(APP.store.getState());
  2314. if (localAudio) {
  2315. APP.store.dispatch(updateSettings({
  2316. micDeviceId: localAudio.getDeviceId()
  2317. }));
  2318. }
  2319. },
  2320. /**
  2321. * Event listener for JitsiMediaDevicesEvents.DEVICE_LIST_CHANGED to
  2322. * handle change of available media devices.
  2323. * @private
  2324. * @param {MediaDeviceInfo[]} devices
  2325. * @returns {Promise}
  2326. */
  2327. _onDeviceListChanged(devices) {
  2328. const oldDevices = APP.store.getState()['features/base/devices'].availableDevices;
  2329. const localAudio = getLocalJitsiAudioTrack(APP.store.getState());
  2330. const localVideo = getLocalJitsiVideoTrack(APP.store.getState());
  2331. APP.store.dispatch(updateDeviceList(devices));
  2332. // Firefox users can choose their preferred device in the gUM prompt. In that case
  2333. // we should respect that and not attempt to switch to the preferred device from
  2334. // our settings.
  2335. const newLabelsOnly = mediaDeviceHelper.newDeviceListAddedLabelsOnly(oldDevices, devices);
  2336. const newDevices
  2337. = mediaDeviceHelper.getNewMediaDevicesAfterDeviceListChanged(
  2338. devices,
  2339. this.isSharingScreen,
  2340. localVideo,
  2341. localAudio,
  2342. newLabelsOnly);
  2343. const promises = [];
  2344. const audioWasMuted = this.isLocalAudioMuted();
  2345. const videoWasMuted = this.isLocalVideoMuted();
  2346. const requestedInput = {
  2347. audio: Boolean(newDevices.audioinput),
  2348. video: Boolean(newDevices.videoinput)
  2349. };
  2350. if (typeof newDevices.audiooutput !== 'undefined') {
  2351. const { dispatch } = APP.store;
  2352. const setAudioOutputPromise
  2353. = setAudioOutputDeviceId(newDevices.audiooutput, dispatch)
  2354. .catch(); // Just ignore any errors in catch block.
  2355. promises.push(setAudioOutputPromise);
  2356. }
  2357. // Handles the use case when the default device is changed (we are always stopping the streams because it's
  2358. // simpler):
  2359. // If the default device is changed we need to first stop the local streams and then call GUM. Otherwise GUM
  2360. // will return a stream using the old default device.
  2361. if (requestedInput.audio && localAudio) {
  2362. localAudio.stopStream();
  2363. }
  2364. if (requestedInput.video && localVideo) {
  2365. localVideo.stopStream();
  2366. }
  2367. // Let's handle unknown/non-preferred devices
  2368. const newAvailDevices
  2369. = APP.store.getState()['features/base/devices'].availableDevices;
  2370. let newAudioDevices = [];
  2371. let oldAudioDevices = [];
  2372. if (typeof newDevices.audiooutput === 'undefined') {
  2373. newAudioDevices = newAvailDevices.audioOutput;
  2374. oldAudioDevices = oldDevices.audioOutput;
  2375. }
  2376. if (!requestedInput.audio) {
  2377. newAudioDevices = newAudioDevices.concat(newAvailDevices.audioInput);
  2378. oldAudioDevices = oldAudioDevices.concat(oldDevices.audioInput);
  2379. }
  2380. // check for audio
  2381. if (newAudioDevices.length > 0) {
  2382. APP.store.dispatch(
  2383. checkAndNotifyForNewDevice(newAudioDevices, oldAudioDevices));
  2384. }
  2385. // check for video
  2386. if (!requestedInput.video) {
  2387. APP.store.dispatch(
  2388. checkAndNotifyForNewDevice(newAvailDevices.videoInput, oldDevices.videoInput));
  2389. }
  2390. // When the 'default' mic needs to be selected, we need to
  2391. // pass the real device id to gUM instead of 'default' in order
  2392. // to get the correct MediaStreamTrack from chrome because of the
  2393. // following bug.
  2394. // https://bugs.chromium.org/p/chromium/issues/detail?id=997689
  2395. const hasDefaultMicChanged = newDevices.audioinput === 'default';
  2396. // This is the case when the local video is muted and a preferred device is connected.
  2397. if (requestedInput.video && this.isLocalVideoMuted()) {
  2398. // We want to avoid creating a new video track in order to prevent turning on the camera.
  2399. requestedInput.video = false;
  2400. APP.store.dispatch(updateSettings({ // Update the current selected camera for the device selection dialog.
  2401. cameraDeviceId: newDevices.videoinput
  2402. }));
  2403. delete newDevices.videoinput;
  2404. // Removing the current video track in order to force the unmute to select the preferred device.
  2405. logger.debug('_onDeviceListChanged: Removing the current video track.');
  2406. this.useVideoStream(null);
  2407. }
  2408. promises.push(
  2409. mediaDeviceHelper.createLocalTracksAfterDeviceListChanged(
  2410. createLocalTracksF,
  2411. newDevices.videoinput,
  2412. hasDefaultMicChanged
  2413. ? getDefaultDeviceId(APP.store.getState(), 'audioInput')
  2414. : newDevices.audioinput)
  2415. .then(tracks => {
  2416. // If audio or video muted before, or we unplugged current
  2417. // device and selected new one, then mute new track.
  2418. const muteSyncPromises = tracks.map(track => {
  2419. if ((track.isVideoTrack() && videoWasMuted)
  2420. || (track.isAudioTrack() && audioWasMuted)) {
  2421. return track.mute();
  2422. }
  2423. return Promise.resolve();
  2424. });
  2425. return Promise.all(muteSyncPromises)
  2426. .then(() =>
  2427. Promise.all(Object.keys(requestedInput).map(mediaType => {
  2428. if (requestedInput[mediaType]) {
  2429. const useStream
  2430. = mediaType === 'audio'
  2431. ? this.useAudioStream.bind(this)
  2432. : this.useVideoStream.bind(this);
  2433. const track = tracks.find(t => t.getType() === mediaType) || null;
  2434. // Use the new stream or null if we failed to obtain it.
  2435. return useStream(track)
  2436. .then(() => {
  2437. if (track?.isAudioTrack() && hasDefaultMicChanged) {
  2438. // workaround for the default device to be shown as selected in the
  2439. // settings even when the real device id was passed to gUM because of
  2440. // the above mentioned chrome bug.
  2441. track._realDeviceId = track.deviceId = 'default';
  2442. }
  2443. mediaType === 'audio'
  2444. ? this._updateAudioDeviceId()
  2445. : this._updateVideoDeviceId();
  2446. });
  2447. }
  2448. return Promise.resolve();
  2449. })));
  2450. })
  2451. .then(() => {
  2452. // Log and sync known mute state.
  2453. if (audioWasMuted) {
  2454. sendAnalytics(createTrackMutedEvent(
  2455. 'audio',
  2456. 'device list changed'));
  2457. logger.log('Audio mute: device list changed');
  2458. muteLocalAudio(true);
  2459. }
  2460. if (!this.isSharingScreen && videoWasMuted) {
  2461. sendAnalytics(createTrackMutedEvent(
  2462. 'video',
  2463. 'device list changed'));
  2464. logger.log('Video mute: device list changed');
  2465. muteLocalVideo(true);
  2466. }
  2467. }));
  2468. return Promise.all(promises)
  2469. .then(() => {
  2470. APP.UI.onAvailableDevicesChanged(devices);
  2471. });
  2472. },
  2473. /**
  2474. * Determines whether or not the audio button should be enabled.
  2475. */
  2476. updateAudioIconEnabled() {
  2477. const localAudio = getLocalJitsiAudioTrack(APP.store.getState());
  2478. const audioMediaDevices = APP.store.getState()['features/base/devices'].availableDevices.audioInput;
  2479. const audioDeviceCount = audioMediaDevices ? audioMediaDevices.length : 0;
  2480. // The audio functionality is considered available if there are any
  2481. // audio devices detected or if the local audio stream already exists.
  2482. const available = audioDeviceCount > 0 || Boolean(localAudio);
  2483. APP.store.dispatch(setAudioAvailable(available));
  2484. APP.API.notifyAudioAvailabilityChanged(available);
  2485. },
  2486. /**
  2487. * Determines whether or not the video button should be enabled.
  2488. */
  2489. updateVideoIconEnabled() {
  2490. const videoMediaDevices
  2491. = APP.store.getState()['features/base/devices'].availableDevices.videoInput;
  2492. const videoDeviceCount
  2493. = videoMediaDevices ? videoMediaDevices.length : 0;
  2494. const localVideo = getLocalJitsiVideoTrack(APP.store.getState());
  2495. // The video functionality is considered available if there are any
  2496. // video devices detected or if there is local video stream already
  2497. // active which could be either screensharing stream or a video track
  2498. // created before the permissions were rejected (through browser
  2499. // config).
  2500. const available = videoDeviceCount > 0 || Boolean(localVideo);
  2501. APP.store.dispatch(setVideoAvailable(available));
  2502. APP.API.notifyVideoAvailabilityChanged(available);
  2503. },
  2504. /**
  2505. * Disconnect from the conference and optionally request user feedback.
  2506. * @param {boolean} [requestFeedback=false] if user feedback should be
  2507. * requested
  2508. */
  2509. hangup(requestFeedback = false) {
  2510. APP.store.dispatch(disableReceiver());
  2511. this._stopProxyConnection();
  2512. APP.store.dispatch(destroyLocalTracks());
  2513. this._localTracksInitialized = false;
  2514. // Remove unnecessary event listeners from firing callbacks.
  2515. if (this.deviceChangeListener) {
  2516. JitsiMeetJS.mediaDevices.removeEventListener(
  2517. JitsiMediaDevicesEvents.DEVICE_LIST_CHANGED,
  2518. this.deviceChangeListener);
  2519. }
  2520. APP.UI.removeAllListeners();
  2521. let requestFeedbackPromise;
  2522. if (requestFeedback) {
  2523. requestFeedbackPromise
  2524. = APP.store.dispatch(maybeOpenFeedbackDialog(room))
  2525. // false because the thank you dialog shouldn't be displayed
  2526. .catch(() => Promise.resolve(false));
  2527. } else {
  2528. requestFeedbackPromise = Promise.resolve(true);
  2529. }
  2530. Promise.all([
  2531. requestFeedbackPromise,
  2532. this.leaveRoom()
  2533. ])
  2534. .then(values => {
  2535. this._room = undefined;
  2536. room = undefined;
  2537. /**
  2538. * Don't call {@code notifyReadyToClose} if the promotional page flag is set
  2539. * and let the page take care of sending the message, since there will be
  2540. * a redirect to the page regardlessly.
  2541. */
  2542. if (!interfaceConfig.SHOW_PROMOTIONAL_CLOSE_PAGE) {
  2543. APP.API.notifyReadyToClose();
  2544. }
  2545. APP.store.dispatch(maybeRedirectToWelcomePage(values[0]));
  2546. });
  2547. },
  2548. /**
  2549. * Leaves the room.
  2550. *
  2551. * @param {boolean} doDisconnect - Wether leaving the room should also terminate the connection.
  2552. * @returns {Promise}
  2553. */
  2554. async leaveRoom(doDisconnect = true) {
  2555. APP.store.dispatch(conferenceWillLeave(room));
  2556. if (room && room.isJoined()) {
  2557. return room.leave().finally(() => {
  2558. if (doDisconnect) {
  2559. return disconnect();
  2560. }
  2561. });
  2562. }
  2563. if (doDisconnect) {
  2564. return disconnect();
  2565. }
  2566. },
  2567. /**
  2568. * Changes the email for the local user
  2569. * @param email {string} the new email
  2570. */
  2571. changeLocalEmail(email = '') {
  2572. const localParticipant = getLocalParticipant(APP.store.getState());
  2573. const formattedEmail = String(email).trim();
  2574. if (formattedEmail === localParticipant.email) {
  2575. return;
  2576. }
  2577. const localId = localParticipant.id;
  2578. APP.store.dispatch(participantUpdated({
  2579. // XXX Only the local participant is allowed to update without
  2580. // stating the JitsiConference instance (i.e. participant property
  2581. // `conference` for a remote participant) because the local
  2582. // participant is uniquely identified by the very fact that there is
  2583. // only one local participant.
  2584. id: localId,
  2585. local: true,
  2586. email: formattedEmail
  2587. }));
  2588. APP.store.dispatch(updateSettings({
  2589. email: formattedEmail
  2590. }));
  2591. APP.API.notifyEmailChanged(localId, {
  2592. email: formattedEmail
  2593. });
  2594. sendData(commands.EMAIL, formattedEmail);
  2595. },
  2596. /**
  2597. * Changes the avatar url for the local user
  2598. * @param url {string} the new url
  2599. */
  2600. changeLocalAvatarUrl(url = '') {
  2601. const { avatarURL, id } = getLocalParticipant(APP.store.getState());
  2602. const formattedUrl = String(url).trim();
  2603. if (formattedUrl === avatarURL) {
  2604. return;
  2605. }
  2606. APP.store.dispatch(participantUpdated({
  2607. // XXX Only the local participant is allowed to update without
  2608. // stating the JitsiConference instance (i.e. participant property
  2609. // `conference` for a remote participant) because the local
  2610. // participant is uniquely identified by the very fact that there is
  2611. // only one local participant.
  2612. id,
  2613. local: true,
  2614. avatarURL: formattedUrl
  2615. }));
  2616. APP.store.dispatch(updateSettings({
  2617. avatarURL: formattedUrl
  2618. }));
  2619. sendData(commands.AVATAR_URL, url);
  2620. },
  2621. /**
  2622. * Sends a message via the data channel.
  2623. * @param {string} to the id of the endpoint that should receive the
  2624. * message. If "" - the message will be sent to all participants.
  2625. * @param {object} payload the payload of the message.
  2626. * @throws NetworkError or InvalidStateError or Error if the operation
  2627. * fails.
  2628. */
  2629. sendEndpointMessage(to, payload) {
  2630. room.sendEndpointMessage(to, payload);
  2631. },
  2632. /**
  2633. * Sends a facial expression as a string and its duration as a number
  2634. * @param {object} payload - Object containing the {string} facialExpression
  2635. * and {number} duration
  2636. */
  2637. sendFacialExpression(payload) {
  2638. room.sendFacialExpression(payload);
  2639. },
  2640. /**
  2641. * Adds new listener.
  2642. * @param {String} eventName the name of the event
  2643. * @param {Function} listener the listener.
  2644. */
  2645. addListener(eventName, listener) {
  2646. eventEmitter.addListener(eventName, listener);
  2647. },
  2648. /**
  2649. * Removes listener.
  2650. * @param {String} eventName the name of the event that triggers the
  2651. * listener
  2652. * @param {Function} listener the listener.
  2653. */
  2654. removeListener(eventName, listener) {
  2655. eventEmitter.removeListener(eventName, listener);
  2656. },
  2657. /**
  2658. * Changes the display name for the local user
  2659. * @param nickname {string} the new display name
  2660. */
  2661. changeLocalDisplayName(nickname = '') {
  2662. const formattedNickname = getNormalizedDisplayName(nickname);
  2663. const { id, name } = getLocalParticipant(APP.store.getState());
  2664. if (formattedNickname === name) {
  2665. return;
  2666. }
  2667. APP.store.dispatch(participantUpdated({
  2668. // XXX Only the local participant is allowed to update without
  2669. // stating the JitsiConference instance (i.e. participant property
  2670. // `conference` for a remote participant) because the local
  2671. // participant is uniquely identified by the very fact that there is
  2672. // only one local participant.
  2673. id,
  2674. local: true,
  2675. name: formattedNickname
  2676. }));
  2677. APP.store.dispatch(updateSettings({
  2678. displayName: formattedNickname
  2679. }));
  2680. },
  2681. /**
  2682. * Callback invoked by the external api create or update a direct connection
  2683. * from the local client to an external client.
  2684. *
  2685. * @param {Object} event - The object containing information that should be
  2686. * passed to the {@code ProxyConnectionService}.
  2687. * @returns {void}
  2688. */
  2689. onProxyConnectionEvent(event) {
  2690. if (!this._proxyConnection) {
  2691. this._proxyConnection = new JitsiMeetJS.ProxyConnectionService({
  2692. /**
  2693. * Pass the {@code JitsiConnection} instance which will be used
  2694. * to fetch TURN credentials.
  2695. */
  2696. jitsiConnection: APP.connection,
  2697. /**
  2698. * The proxy connection feature is currently tailored towards
  2699. * taking a proxied video stream and showing it as a local
  2700. * desktop screen.
  2701. */
  2702. convertVideoToDesktop: true,
  2703. /**
  2704. * Callback invoked when the connection has been closed
  2705. * automatically. Triggers cleanup of screensharing if active.
  2706. *
  2707. * @returns {void}
  2708. */
  2709. onConnectionClosed: () => {
  2710. if (this._untoggleScreenSharing) {
  2711. this._untoggleScreenSharing();
  2712. }
  2713. },
  2714. /**
  2715. * Callback invoked to pass messages from the local client back
  2716. * out to the external client.
  2717. *
  2718. * @param {string} peerJid - The jid of the intended recipient
  2719. * of the message.
  2720. * @param {Object} data - The message that should be sent. For
  2721. * screensharing this is an iq.
  2722. * @returns {void}
  2723. */
  2724. onSendMessage: (peerJid, data) =>
  2725. APP.API.sendProxyConnectionEvent({
  2726. data,
  2727. to: peerJid
  2728. }),
  2729. /**
  2730. * Callback invoked when the remote peer of the proxy connection
  2731. * has provided a video stream, intended to be used as a local
  2732. * desktop stream.
  2733. *
  2734. * @param {JitsiLocalTrack} remoteProxyStream - The media
  2735. * stream to use as a local desktop stream.
  2736. * @returns {void}
  2737. */
  2738. onRemoteStream: desktopStream => {
  2739. if (desktopStream.videoType !== 'desktop') {
  2740. logger.warn('Received a non-desktop stream to proxy.');
  2741. desktopStream.dispose();
  2742. return;
  2743. }
  2744. this.toggleScreenSharing(undefined, { desktopStream });
  2745. }
  2746. });
  2747. }
  2748. this._proxyConnection.processMessage(event);
  2749. },
  2750. /**
  2751. * Sets the video muted status.
  2752. */
  2753. setVideoMuteStatus() {
  2754. APP.UI.setVideoMuted(this.getMyUserId());
  2755. },
  2756. /**
  2757. * Sets the audio muted status.
  2758. *
  2759. * @param {boolean} muted - New muted status.
  2760. */
  2761. setAudioMuteStatus(muted) {
  2762. APP.UI.setAudioMuted(this.getMyUserId(), muted);
  2763. APP.API.notifyAudioMutedStatusChanged(muted);
  2764. },
  2765. /**
  2766. * Dispatches the passed in feedback for submission. The submitted score
  2767. * should be a number inclusively between 1 through 5, or -1 for no score.
  2768. *
  2769. * @param {number} score - a number between 1 and 5 (inclusive) or -1 for no
  2770. * score.
  2771. * @param {string} message - An optional message to attach to the feedback
  2772. * in addition to the score.
  2773. * @returns {void}
  2774. */
  2775. submitFeedback(score = -1, message = '') {
  2776. if (score === -1 || (score >= 1 && score <= 5)) {
  2777. APP.store.dispatch(submitFeedback(score, message, room));
  2778. }
  2779. },
  2780. /**
  2781. * Terminates any proxy screensharing connection that is active.
  2782. *
  2783. * @private
  2784. * @returns {void}
  2785. */
  2786. _stopProxyConnection() {
  2787. if (this._proxyConnection) {
  2788. this._proxyConnection.stop();
  2789. }
  2790. this._proxyConnection = null;
  2791. }
  2792. };