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

config.js 63KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496
  1. /* eslint-disable comma-dangle, no-unused-vars, no-var, prefer-template, vars-on-top */
  2. /*
  3. * NOTE: If you add a new option please remember to document it here:
  4. * https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-configuration
  5. */
  6. var subdir = '<!--# echo var="subdir" default="" -->';
  7. var subdomain = '<!--# echo var="subdomain" default="" -->';
  8. if (subdomain) {
  9. subdomain = subdomain.substr(0, subdomain.length - 1).split('.')
  10. .join('_')
  11. .toLowerCase() + '.';
  12. }
  13. // In case of no ssi provided by the webserver, use empty strings
  14. if (subdir.startsWith('<!--')) {
  15. subdir = '';
  16. }
  17. if (subdomain.startsWith('<!--')) {
  18. subdomain = '';
  19. }
  20. var config = {
  21. // Connection
  22. //
  23. hosts: {
  24. // XMPP domain.
  25. domain: 'jitsi-meet.example.com',
  26. // When using authentication, domain for guest users.
  27. // anonymousdomain: 'guest.example.com',
  28. // Domain for authenticated users. Defaults to <domain>.
  29. // authdomain: 'jitsi-meet.example.com',
  30. // Focus component domain. Defaults to focus.<domain>.
  31. // focus: 'focus.jitsi-meet.example.com',
  32. // XMPP MUC domain. FIXME: use XEP-0030 to discover it.
  33. muc: 'conference.' + subdomain + 'jitsi-meet.example.com',
  34. },
  35. // BOSH URL. FIXME: use XEP-0156 to discover it.
  36. bosh: '//jitsi-meet.example.com/' + subdir + 'http-bind',
  37. // Websocket URL
  38. // websocket: 'wss://jitsi-meet.example.com/' + subdir + 'xmpp-websocket',
  39. // The real JID of focus participant - can be overridden here
  40. // Do not change username - FIXME: Make focus username configurable
  41. // https://github.com/jitsi/jitsi-meet/issues/7376
  42. // focusUserJid: 'focus@auth.jitsi-meet.example.com',
  43. // Testing / experimental features.
  44. //
  45. testing: {
  46. // Disables the End to End Encryption feature. Useful for debugging
  47. // issues related to insertable streams.
  48. // disableE2EE: false,
  49. // Enables/disables thumbnail reordering in the filmstrip. It is enabled by default unless explicitly
  50. // disabled by the below option.
  51. // enableThumbnailReordering: true,
  52. // Enables XMPP WebSocket (as opposed to BOSH) for the given amount of users.
  53. // mobileXmppWsThreshold: 10, // enable XMPP WebSockets on mobile for 10% of the users
  54. // P2P test mode disables automatic switching to P2P when there are 2
  55. // participants in the conference.
  56. // p2pTestMode: false,
  57. // Enables the test specific features consumed by jitsi-meet-torture
  58. // testMode: false,
  59. // Disables the auto-play behavior of *all* newly created video element.
  60. // This is useful when the client runs on a host with limited resources.
  61. // noAutoPlayVideo: false,
  62. // Enable / disable 500 Kbps bitrate cap on desktop tracks. When enabled,
  63. // simulcast is turned off for the desktop share. If presenter is turned
  64. // on while screensharing is in progress, the max bitrate is automatically
  65. // adjusted to 2.5 Mbps. This takes a value between 0 and 1 which determines
  66. // the probability for this to be enabled. This setting has been deprecated.
  67. // desktopSharingFrameRate.max now determines whether simulcast will be enabled
  68. // or disabled for the screenshare.
  69. // capScreenshareBitrate: 1, // 0 to disable - deprecated.
  70. // Whether to use fake constraints (height: 99999, width: 99999) when calling getDisplayMedia on
  71. // Chromium based browsers. This is intended as a workaround for
  72. // https://bugs.chromium.org/p/chromium/issues/detail?id=1056311
  73. // setScreenSharingResolutionConstraints: true,
  74. // Enable callstats only for a percentage of users.
  75. // This takes a value between 0 and 100 which determines the probability for
  76. // the callstats to be enabled.
  77. // callStatsThreshold: 5, // enable callstats for 5% of the users.
  78. },
  79. // Feature Flags.
  80. flags: {
  81. // Enables source names in the signaling.
  82. // sourceNameSignaling: false,
  83. // Enables sending multiple video streams, i.e., camera and desktop tracks can be shared in the conference
  84. // separately as two different streams instead of one composite stream.
  85. // sendMultipleVideoStreams: false,
  86. // Signal that this client supports receiving multiple video streams. Without this flag jicofo will enable
  87. // multi-stream backward compatibility.
  88. receiveMultipleVideoStreams: true,
  89. },
  90. // Disables moderator indicators.
  91. // disableModeratorIndicator: false,
  92. // Disables the reactions feature.
  93. // disableReactions: true,
  94. // Disables the reactions moderation feature.
  95. // disableReactionsModeration: false,
  96. // Disables polls feature.
  97. // disablePolls: false,
  98. // Disables self-view tile. (hides it from tile view and from filmstrip)
  99. // disableSelfView: false,
  100. // Disables self-view settings in UI
  101. // disableSelfViewSettings: false,
  102. // screenshotCapture : {
  103. // Enables the screensharing capture feature.
  104. // enabled: false,
  105. //
  106. // The mode for the screenshot capture feature.
  107. // Can be either 'recording' - screensharing screenshots are taken
  108. // only when the recording is also on,
  109. // or 'always' - screensharing screenshots are always taken.
  110. // mode: 'recording',
  111. // }
  112. // Disables ICE/UDP by filtering out local and remote UDP candidates in
  113. // signalling.
  114. // webrtcIceUdpDisable: false,
  115. // Disables ICE/TCP by filtering out local and remote TCP candidates in
  116. // signalling.
  117. // webrtcIceTcpDisable: false,
  118. // Media
  119. //
  120. // Enable unified plan implementation support on Chromium based browsers.
  121. // enableUnifiedOnChrome: false,
  122. // Audio
  123. // Disable measuring of audio levels.
  124. // disableAudioLevels: false,
  125. // audioLevelsInterval: 200,
  126. // Enabling this will run the lib-jitsi-meet no audio detection module which
  127. // will notify the user if the current selected microphone has no audio
  128. // input and will suggest another valid device if one is present.
  129. enableNoAudioDetection: true,
  130. // Enabling this will show a "Save Logs" link in the GSM popover that can be
  131. // used to collect debug information (XMPP IQs, SDP offer/answer cycles)
  132. // about the call.
  133. // enableSaveLogs: false,
  134. // Enabling this will hide the "Show More" link in the GSM popover that can be
  135. // used to display more statistics about the connection (IP, Port, protocol, etc).
  136. // disableShowMoreStats: true,
  137. // Enabling this will run the lib-jitsi-meet noise detection module which will
  138. // notify the user if there is noise, other than voice, coming from the current
  139. // selected microphone. The purpose it to let the user know that the input could
  140. // be potentially unpleasant for other meeting participants.
  141. enableNoisyMicDetection: true,
  142. // Start the conference in audio only mode (no video is being received nor
  143. // sent).
  144. // startAudioOnly: false,
  145. // Every participant after the Nth will start audio muted.
  146. // startAudioMuted: 10,
  147. // Start calls with audio muted. Unlike the option above, this one is only
  148. // applied locally. FIXME: having these 2 options is confusing.
  149. // startWithAudioMuted: false,
  150. // Enabling it (with #params) will disable local audio output of remote
  151. // participants and to enable it back a reload is needed.
  152. // startSilent: false,
  153. // Enables support for opus-red (redundancy for Opus).
  154. // enableOpusRed: false,
  155. // Specify audio quality stereo and opusMaxAverageBitrate values in order to enable HD audio.
  156. // Beware, by doing so, you are disabling echo cancellation, noise suppression and AGC.
  157. // audioQuality: {
  158. // stereo: false,
  159. // opusMaxAverageBitrate: null, // Value to fit the 6000 to 510000 range.
  160. // },
  161. // Video
  162. // Sets the preferred resolution (height) for local video. Defaults to 720.
  163. // resolution: 720,
  164. // Specifies whether the raised hand will hide when someone becomes a dominant speaker or not
  165. // disableRemoveRaisedHandOnFocus: false,
  166. // Specifies whether there will be a search field in speaker stats or not
  167. // disableSpeakerStatsSearch: false,
  168. // Specifies whether participants in speaker stats should be ordered or not, and with what priority
  169. // speakerStatsOrder: [
  170. // 'role', <- Moderators on top
  171. // 'name', <- Alphabetically by name
  172. // 'hasLeft', <- The ones that have left in the bottom
  173. // ], <- the order of the array elements determines priority
  174. // How many participants while in the tile view mode, before the receiving video quality is reduced from HD to SD.
  175. // Use -1 to disable.
  176. // maxFullResolutionParticipants: 2,
  177. // w3c spec-compliant video constraints to use for video capture. Currently
  178. // used by browsers that return true from lib-jitsi-meet's
  179. // util#browser#usesNewGumFlow. The constraints are independent from
  180. // this config's resolution value. Defaults to requesting an ideal
  181. // resolution of 720p.
  182. // constraints: {
  183. // video: {
  184. // height: {
  185. // ideal: 720,
  186. // max: 720,
  187. // min: 240,
  188. // },
  189. // },
  190. // },
  191. // Enable / disable simulcast support.
  192. // disableSimulcast: false,
  193. // Enable / disable layer suspension. If enabled, endpoints whose HD layers are not in use will be suspended
  194. // (no longer sent) until they are requested again. This is enabled by default. This must be enabled for screen
  195. // sharing to work as expected on Chrome. Disabling this might result in low resolution screenshare being sent
  196. // by the client.
  197. // enableLayerSuspension: false,
  198. // Every participant after the Nth will start video muted.
  199. // startVideoMuted: 10,
  200. // Start calls with video muted. Unlike the option above, this one is only
  201. // applied locally. FIXME: having these 2 options is confusing.
  202. // startWithVideoMuted: false,
  203. // If set to true, prefer to use the H.264 video codec (if supported).
  204. // Note that it's not recommended to do this because simulcast is not
  205. // supported when using H.264. For 1-to-1 calls this setting is enabled by
  206. // default and can be toggled in the p2p section.
  207. // This option has been deprecated, use preferredCodec under videoQuality section instead.
  208. // preferH264: true,
  209. // If set to true, disable H.264 video codec by stripping it out of the
  210. // SDP.
  211. // disableH264: false,
  212. // Desktop sharing
  213. // Optional desktop sharing frame rate options. Default value: min:5, max:5.
  214. // desktopSharingFrameRate: {
  215. // min: 5,
  216. // max: 5,
  217. // },
  218. // This option has been deprecated since it is no longer supported as per the w3c spec.
  219. // https://w3c.github.io/mediacapture-screen-share/#dom-mediadevices-getdisplaymedia. If the user has not
  220. // interacted with the webpage before the getDisplayMedia call, the promise will be rejected by the browser. This
  221. // has already been implemented in Firefox and Safari and will be implemented in Chrome soon.
  222. // https://bugs.chromium.org/p/chromium/issues/detail?id=1198918
  223. // startScreenSharing: false,
  224. // Recording
  225. // DEPRECATED. Use recordingService.enabled instead.
  226. // fileRecordingsEnabled: false,
  227. // Enable the dropbox integration.
  228. // dropbox: {
  229. // appKey: '<APP_KEY>', // Specify your app key here.
  230. // // A URL to redirect the user to, after authenticating
  231. // // by default uses:
  232. // // 'https://jitsi-meet.example.com/static/oauth.html'
  233. // redirectURI:
  234. // 'https://jitsi-meet.example.com/subfolder/static/oauth.html',
  235. // },
  236. // recordingService: {
  237. // // When integrations like dropbox are enabled only that will be shown,
  238. // // by enabling fileRecordingsServiceEnabled, we show both the integrations
  239. // // and the generic recording service (its configuration and storage type
  240. // // depends on jibri configuration)
  241. // enabled: false,
  242. // // Whether to show the possibility to share file recording with other people
  243. // // (e.g. meeting participants), based on the actual implementation
  244. // // on the backend.
  245. // sharingEnabled: false,
  246. // // Hide the warning that says we only store the recording for 24 hours.
  247. // hideStorageWarning: false,
  248. // },
  249. // DEPRECATED. Use recordingService.enabled instead.
  250. // fileRecordingsServiceEnabled: false,
  251. // DEPRECATED. Use recordingService.sharingEnabled instead.
  252. // fileRecordingsServiceSharingEnabled: false,
  253. // Local recording configuration.
  254. // localRecording: {
  255. // // Whether to disable local recording or not.
  256. // disable: false,
  257. // // Whether to notify all participants when a participant is recording locally.
  258. // notifyAllParticipants: false,
  259. // // Whether to disable the self recording feature (only local participant streams).
  260. // disableSelfRecording: false,
  261. // },
  262. // Customize the Live Streaming dialog. Can be modified for a non-YouTube provider.
  263. // liveStreaming: {
  264. // // Whether to enable live streaming or not.
  265. // enabled: false,
  266. // // Terms link
  267. // termsLink: 'https://www.youtube.com/t/terms',
  268. // // Data privacy link
  269. // dataPrivacyLink: 'https://policies.google.com/privacy',
  270. // // RegExp string that validates the stream key input field
  271. // validatorRegExpString: '^(?:[a-zA-Z0-9]{4}(?:-(?!$)|$)){4}',
  272. // // Documentation reference for the live streaming feature.
  273. // helpLink: 'https://jitsi.org/live'
  274. // },
  275. // DEPRECATED. Use liveStreaming.enabled instead.
  276. // liveStreamingEnabled: false,
  277. // DEPRECATED. Use transcription.enabled instead.
  278. // transcribingEnabled: false,
  279. // DEPRECATED. Use transcription.useAppLanguage instead.
  280. // transcribeWithAppLanguage: true,
  281. // DEPRECATED. Use transcription.preferredLanguage instead.
  282. // preferredTranscribeLanguage: 'en-US',
  283. // DEPRECATED. Use transcription.autoCaptionOnRecord instead.
  284. // autoCaptionOnRecord: false,
  285. // Transcription options.
  286. // transcription: {
  287. // // Whether the feature should be enabled or not.
  288. // enabled: false,
  289. // // If true transcriber will use the application language.
  290. // // The application language is either explicitly set by participants in their settings or automatically
  291. // // detected based on the environment, e.g. if the app is opened in a chrome instance which
  292. // // is using french as its default language then transcriptions for that participant will be in french.
  293. // // Defaults to true.
  294. // useAppLanguage: true,
  295. // // Transcriber language. This settings will only work if "useAppLanguage"
  296. // // is explicitly set to false.
  297. // // Available languages can be found in
  298. // // ./src/react/features/transcribing/transcriber-langs.json.
  299. // preferredLanguage: 'en-US',
  300. // // Disable start transcription for all participants.
  301. // disableStartForAll: false,
  302. // // Enables automatic turning on captions when recording is started
  303. // autoCaptionOnRecord: false,
  304. // },
  305. // Misc
  306. // Default value for the channel "last N" attribute. -1 for unlimited.
  307. channelLastN: -1,
  308. // Connection indicators
  309. // connectionIndicators: {
  310. // autoHide: true,
  311. // autoHideTimeout: 5000,
  312. // disabled: false,
  313. // disableDetails: false,
  314. // inactiveDisabled: false
  315. // },
  316. // Provides a way for the lastN value to be controlled through the UI.
  317. // When startLastN is present, conference starts with a last-n value of startLastN and channelLastN
  318. // value will be used when the quality level is selected using "Manage Video Quality" slider.
  319. // startLastN: 1,
  320. // Provides a way to use different "last N" values based on the number of participants in the conference.
  321. // The keys in an Object represent number of participants and the values are "last N" to be used when number of
  322. // participants gets to or above the number.
  323. //
  324. // For the given example mapping, "last N" will be set to 20 as long as there are at least 5, but less than
  325. // 29 participants in the call and it will be lowered to 15 when the 30th participant joins. The 'channelLastN'
  326. // will be used as default until the first threshold is reached.
  327. //
  328. // lastNLimits: {
  329. // 5: 20,
  330. // 30: 15,
  331. // 50: 10,
  332. // 70: 5,
  333. // 90: 2,
  334. // },
  335. // Provides a way to translate the legacy bridge signaling messages, 'LastNChangedEvent',
  336. // 'SelectedEndpointsChangedEvent' and 'ReceiverVideoConstraint' into the new 'ReceiverVideoConstraints' message
  337. // that invokes the new bandwidth allocation algorithm in the bridge which is described here
  338. // - https://github.com/jitsi/jitsi-videobridge/blob/master/doc/allocation.md.
  339. // useNewBandwidthAllocationStrategy: false,
  340. // Specify the settings for video quality optimizations on the client.
  341. // videoQuality: {
  342. // // Provides a way to prevent a video codec from being negotiated on the JVB connection. The codec specified
  343. // // here will be removed from the list of codecs present in the SDP answer generated by the client. If the
  344. // // same codec is specified for both the disabled and preferred option, the disable settings will prevail.
  345. // // Note that 'VP8' cannot be disabled since it's a mandatory codec, the setting will be ignored in this case.
  346. // disabledCodec: 'H264',
  347. //
  348. // // Provides a way to set a preferred video codec for the JVB connection. If 'H264' is specified here,
  349. // // simulcast will be automatically disabled since JVB doesn't support H264 simulcast yet. This will only
  350. // // rearrange the the preference order of the codecs in the SDP answer generated by the browser only if the
  351. // // preferred codec specified here is present. Please ensure that the JVB offers the specified codec for this
  352. // // to take effect.
  353. // preferredCodec: 'VP8',
  354. //
  355. // // Provides a way to enforce the preferred codec for the conference even when the conference has endpoints
  356. // // that do not support the preferred codec. For example, older versions of Safari do not support VP9 yet.
  357. // // This will result in Safari not being able to decode video from endpoints sending VP9 video.
  358. // // When set to false, the conference falls back to VP8 whenever there is an endpoint that doesn't support the
  359. // // preferred codec and goes back to the preferred codec when that endpoint leaves.
  360. // enforcePreferredCodec: false,
  361. //
  362. // // Provides a way to configure the maximum bitrates that will be enforced on the simulcast streams for
  363. // // video tracks. The keys in the object represent the type of the stream (LD, SD or HD) and the values
  364. // // are the max.bitrates to be set on that particular type of stream. The actual send may vary based on
  365. // // the available bandwidth calculated by the browser, but it will be capped by the values specified here.
  366. // // This is currently not implemented on app based clients on mobile.
  367. // maxBitratesVideo: {
  368. // H264: {
  369. // low: 200000,
  370. // standard: 500000,
  371. // high: 1500000,
  372. // },
  373. // VP8 : {
  374. // low: 200000,
  375. // standard: 500000,
  376. // high: 1500000,
  377. // },
  378. // VP9: {
  379. // low: 100000,
  380. // standard: 300000,
  381. // high: 1200000,
  382. // },
  383. // },
  384. //
  385. // // The options can be used to override default thresholds of video thumbnail heights corresponding to
  386. // // the video quality levels used in the application. At the time of this writing the allowed levels are:
  387. // // 'low' - for the low quality level (180p at the time of this writing)
  388. // // 'standard' - for the medium quality level (360p)
  389. // // 'high' - for the high quality level (720p)
  390. // // The keys should be positive numbers which represent the minimal thumbnail height for the quality level.
  391. // //
  392. // // With the default config value below the application will use 'low' quality until the thumbnails are
  393. // // at least 360 pixels tall. If the thumbnail height reaches 720 pixels then the application will switch to
  394. // // the high quality.
  395. // minHeightForQualityLvl: {
  396. // 360: 'standard',
  397. // 720: 'high',
  398. // },
  399. //
  400. // // Provides a way to resize the desktop track to 720p (if it is greater than 720p) before creating a canvas
  401. // // for the presenter mode (camera picture-in-picture mode with screenshare).
  402. // resizeDesktopForPresenter: false,
  403. // },
  404. // Notification timeouts
  405. // notificationTimeouts: {
  406. // short: 2500,
  407. // medium: 5000,
  408. // long: 10000,
  409. // },
  410. // // Options for the recording limit notification.
  411. // recordingLimit: {
  412. //
  413. // // The recording limit in minutes. Note: This number appears in the notification text
  414. // // but doesn't enforce the actual recording time limit. This should be configured in
  415. // // jibri!
  416. // limit: 60,
  417. //
  418. // // The name of the app with unlimited recordings.
  419. // appName: 'Unlimited recordings APP',
  420. //
  421. // // The URL of the app with unlimited recordings.
  422. // appURL: 'https://unlimited.recordings.app.com/',
  423. // },
  424. // Disables or enables RTX (RFC 4588) (defaults to false).
  425. // disableRtx: false,
  426. // Moves all Jitsi Meet 'beforeunload' logic (cleanup, leaving, disconnecting, etc) to the 'unload' event.
  427. // disableBeforeUnloadHandlers: true,
  428. // Disables or enables TCC support in this client (default: enabled).
  429. // enableTcc: true,
  430. // Disables or enables REMB support in this client (default: enabled).
  431. // enableRemb: true,
  432. // Enables ICE restart logic in LJM and displays the page reload overlay on
  433. // ICE failure. Current disabled by default because it's causing issues with
  434. // signaling when Octo is enabled. Also when we do an "ICE restart"(which is
  435. // not a real ICE restart), the client maintains the TCC sequence number
  436. // counter, but the bridge resets it. The bridge sends media packets with
  437. // TCC sequence numbers starting from 0.
  438. // enableIceRestart: false,
  439. // Enables forced reload of the client when the call is migrated as a result of
  440. // the bridge going down.
  441. // enableForcedReload: true,
  442. // Use TURN/UDP servers for the jitsi-videobridge connection (by default
  443. // we filter out TURN/UDP because it is usually not needed since the
  444. // bridge itself is reachable via UDP)
  445. // useTurnUdp: false
  446. // Enable support for encoded transform in supported browsers. This allows
  447. // E2EE to work in Safari if the corresponding flag is enabled in the browser.
  448. // Experimental.
  449. // enableEncodedTransformSupport: false,
  450. // UI
  451. //
  452. // Disables responsive tiles.
  453. // disableResponsiveTiles: false,
  454. // Hides lobby button
  455. // hideLobbyButton: false,
  456. // If Lobby is enabled starts knocking automatically.
  457. // autoKnockLobby: false,
  458. // Enable lobby chat.
  459. // enableLobbyChat: true,
  460. // DEPRECATED! Use `breakoutRooms.hideAddRoomButton` instead.
  461. // Hides add breakout room button
  462. // hideAddRoomButton: false,
  463. // Require users to always specify a display name.
  464. // requireDisplayName: true,
  465. // Whether to use a welcome page or not. In case it's false a random room
  466. // will be joined when no room is specified.
  467. enableWelcomePage: true,
  468. // Disable app shortcuts that are registered upon joining a conference
  469. // disableShortcuts: false,
  470. // Disable initial browser getUserMedia requests.
  471. // This is useful for scenarios where users might want to start a conference for screensharing only
  472. // disableInitialGUM: false,
  473. // Enabling the close page will ignore the welcome page redirection when
  474. // a call is hangup.
  475. // enableClosePage: false,
  476. // Disable hiding of remote thumbnails when in a 1-on-1 conference call.
  477. // Setting this to null, will also disable showing the remote videos
  478. // when the toolbar is shown on mouse movements
  479. // disable1On1Mode: null | false | true,
  480. // Default local name to be displayed
  481. // defaultLocalDisplayName: 'me',
  482. // Default remote name to be displayed
  483. // defaultRemoteDisplayName: 'Fellow Jitster',
  484. // Hides the display name from the participant thumbnail
  485. // hideDisplayName: false,
  486. // Hides the dominant speaker name badge that hovers above the toolbox
  487. // hideDominantSpeakerBadge: false,
  488. // Default language for the user interface. Cannot be overwritten.
  489. // defaultLanguage: 'en',
  490. // Disables profile and the edit of all fields from the profile settings (display name and email)
  491. // disableProfile: false,
  492. // Hides the email section under profile settings.
  493. // hideEmailInSettings: false,
  494. // When enabled the password used for locking a room is restricted to up to the number of digits specified
  495. // default: roomPasswordNumberOfDigits: false,
  496. // roomPasswordNumberOfDigits: 10,
  497. // Message to show the users. Example: 'The service will be down for
  498. // maintenance at 01:00 AM GMT,
  499. // noticeMessage: '',
  500. // Enables calendar integration, depends on googleApiApplicationClientID
  501. // and microsoftApiApplicationClientID
  502. // enableCalendarIntegration: false,
  503. // Configs for prejoin page.
  504. // prejoinConfig: {
  505. // // When 'true', it shows an intermediate page before joining, where the user can configure their devices.
  506. // // This replaces `prejoinPageEnabled`.
  507. // enabled: true,
  508. // // Hides the participant name editing field in the prejoin screen.
  509. // // If requireDisplayName is also set as true, a name should still be provided through
  510. // // either the jwt or the userInfo from the iframe api init object in order for this to have an effect.
  511. // hideDisplayName: false,
  512. // // List of buttons to hide from the extra join options dropdown.
  513. // hideExtraJoinButtons: ['no-audio', 'by-phone'],
  514. // },
  515. // When 'true', the user cannot edit the display name.
  516. // (Mainly useful when used in conjunction with the JWT so the JWT name becomes read only.)
  517. // readOnlyName: false,
  518. // If etherpad integration is enabled, setting this to true will
  519. // automatically open the etherpad when a participant joins. This
  520. // does not affect the mobile app since opening an etherpad
  521. // obscures the conference controls -- it's better to let users
  522. // choose to open the pad on their own in that case.
  523. // openSharedDocumentOnJoin: false,
  524. // If true, shows the unsafe room name warning label when a room name is
  525. // deemed unsafe (due to the simplicity in the name) and a password is not
  526. // set or the lobby is not enabled.
  527. // enableInsecureRoomNameWarning: false,
  528. // Whether to automatically copy invitation URL after creating a room.
  529. // Document should be focused for this option to work
  530. // enableAutomaticUrlCopy: false,
  531. // Array with avatar URL prefixes that need to use CORS.
  532. // corsAvatarURLs: [ 'https://www.gravatar.com/avatar/' ],
  533. // Base URL for a Gravatar-compatible service. Defaults to Gravatar.
  534. // DEPRECATED! Use `gravatar.baseUrl` instead.
  535. // gravatarBaseURL: 'https://www.gravatar.com/avatar/',
  536. // Setup for Gravatar-compatible services.
  537. // gravatar: {
  538. // // Defaults to Gravatar.
  539. // baseUrl: 'https://www.gravatar.com/avatar/',
  540. // // True if Gravatar should be disabled.
  541. // disabled: false,
  542. // },
  543. // App name to be displayed in the invitation email subject, as an alternative to
  544. // interfaceConfig.APP_NAME.
  545. // inviteAppName: null,
  546. // Moved from interfaceConfig(TOOLBAR_BUTTONS).
  547. // The name of the toolbar buttons to display in the toolbar, including the
  548. // "More actions" menu. If present, the button will display. Exceptions are
  549. // "livestreaming" and "recording" which also require being a moderator and
  550. // some other values in config.js to be enabled. Also, the "profile" button will
  551. // not display for users with a JWT.
  552. // Notes:
  553. // - it's impossible to choose which buttons go in the "More actions" menu
  554. // - it's impossible to control the placement of buttons
  555. // - 'desktop' controls the "Share your screen" button
  556. // - if `toolbarButtons` is undefined, we fallback to enabling all buttons on the UI
  557. // toolbarButtons: [
  558. // 'camera',
  559. // 'chat',
  560. // 'closedcaptions',
  561. // 'desktop',
  562. // 'dock-iframe',
  563. // 'download',
  564. // 'embedmeeting',
  565. // 'etherpad',
  566. // 'feedback',
  567. // 'filmstrip',
  568. // 'fullscreen',
  569. // 'hangup',
  570. // 'help',
  571. // 'highlight',
  572. // 'invite',
  573. // 'linktosalesforce',
  574. // 'livestreaming',
  575. // 'microphone',
  576. // 'noisesuppression',
  577. // 'participants-pane',
  578. // 'profile',
  579. // 'raisehand',
  580. // 'recording',
  581. // 'security',
  582. // 'select-background',
  583. // 'settings',
  584. // 'shareaudio',
  585. // 'sharedvideo',
  586. // 'shortcuts',
  587. // 'stats',
  588. // 'tileview',
  589. // 'toggle-camera',
  590. // 'undock-iframe',
  591. // 'videoquality',
  592. // ],
  593. // Holds values related to toolbar visibility control.
  594. // toolbarConfig: {
  595. // // Moved from interfaceConfig.INITIAL_TOOLBAR_TIMEOUT
  596. // // The initial number of milliseconds for the toolbar buttons to be visible on screen.
  597. // initialTimeout: 20000,
  598. // // Moved from interfaceConfig.TOOLBAR_TIMEOUT
  599. // // Number of milliseconds for the toolbar buttons to be visible on screen.
  600. // timeout: 4000,
  601. // // Moved from interfaceConfig.TOOLBAR_ALWAYS_VISIBLE
  602. // // Whether toolbar should be always visible or should hide after x milliseconds.
  603. // alwaysVisible: false,
  604. // // Indicates whether the toolbar should still autohide when chat is open
  605. // autoHideWhileChatIsOpen: false,
  606. // },
  607. // Toolbar buttons which have their click/tap event exposed through the API on
  608. // `toolbarButtonClicked`. Passing a string for the button key will
  609. // prevent execution of the click/tap routine; passing an object with `key` and
  610. // `preventExecution` flag on false will not prevent execution of the click/tap
  611. // routine. Below array with mixed mode for passing the buttons.
  612. // buttonsWithNotifyClick: [
  613. // 'camera',
  614. // {
  615. // key: 'chat',
  616. // preventExecution: false
  617. // },
  618. // {
  619. // key: 'closedcaptions',
  620. // preventExecution: true
  621. // },
  622. // 'desktop',
  623. // 'download',
  624. // 'embedmeeting',
  625. // 'etherpad',
  626. // 'feedback',
  627. // 'filmstrip',
  628. // 'fullscreen',
  629. // 'hangup',
  630. // 'help',
  631. // {
  632. // key: 'invite',
  633. // preventExecution: false
  634. // },
  635. // 'livestreaming',
  636. // 'microphone',
  637. // 'mute-everyone',
  638. // 'mute-video-everyone',
  639. // 'noisesuppression',
  640. // 'participants-pane',
  641. // 'profile',
  642. // {
  643. // key: 'raisehand',
  644. // preventExecution: true
  645. // },
  646. // 'recording',
  647. // 'security',
  648. // 'select-background',
  649. // 'settings',
  650. // 'shareaudio',
  651. // 'sharedvideo',
  652. // 'shortcuts',
  653. // 'stats',
  654. // 'tileview',
  655. // 'toggle-camera',
  656. // 'videoquality',
  657. // // The add passcode button from the security dialog.
  658. // {
  659. // key: 'add-passcode',
  660. // preventExecution: false
  661. // },
  662. // ],
  663. // List of pre meeting screens buttons to hide. The values must be one or more of the 5 allowed buttons:
  664. // 'microphone', 'camera', 'select-background', 'invite', 'settings'
  665. // hiddenPremeetingButtons: [],
  666. // Stats
  667. //
  668. // Whether to enable stats collection or not in the TraceablePeerConnection.
  669. // This can be useful for debugging purposes (post-processing/analysis of
  670. // the webrtc stats) as it is done in the jitsi-meet-torture bandwidth
  671. // estimation tests.
  672. // gatherStats: false,
  673. // The interval at which PeerConnection.getStats() is called. Defaults to 10000
  674. // pcStatsInterval: 10000,
  675. // To enable sending statistics to callstats.io you must provide the
  676. // Application ID and Secret.
  677. // callStatsID: '',
  678. // callStatsSecret: '',
  679. // callstatsStoreLogs: true,
  680. // The callstats initialize config params as described in the API:
  681. // https://docs.callstats.io/docs/javascript#callstatsinitialize-with-app-secret
  682. // callStatsConfigParams: {
  683. // disableBeforeUnloadHandler: true, // disables callstats.js's window.onbeforeunload parameter.
  684. // applicationVersion: "app_version", // Application version specified by the developer.
  685. // disablePrecalltest: true, // disables the pre-call test, it is enabled by default.
  686. // siteID: "siteID", // The name/ID of the site/campus from where the call/pre-call test is made.
  687. // additionalIDs: { // additionalIDs object, contains application related IDs.
  688. // customerID: "Customer Identifier. Example, walmart.",
  689. // tenantID: "Tenant Identifier. Example, monster.",
  690. // productName: "Product Name. Example, Jitsi.",
  691. // meetingsName: "Meeting Name. Example, Jitsi loves callstats.",
  692. // serverName: "Server/MiddleBox Name. Example, jvb-prod-us-east-mlkncws12.",
  693. // pbxID: "PBX Identifier. Example, walmart.",
  694. // pbxExtensionID: "PBX Extension Identifier. Example, 5625.",
  695. // fqExtensionID: "Fully qualified Extension Identifier. Example, +71 (US) +5625.",
  696. // sessionID: "Session Identifier. Example, session-12-34",
  697. // },
  698. // collectLegacyStats: true, //enables the collection of legacy stats in chrome browser
  699. // collectIP: true, //enables the collection localIP address
  700. // },
  701. // Enables sending participants' display names to callstats
  702. // enableDisplayNameInStats: false,
  703. // Enables sending participants' emails (if available) to callstats and other analytics
  704. // enableEmailInStats: false,
  705. // faceLandmarks: {
  706. // // Enables sharing your face coordinates. Used for centering faces within a video.
  707. // enableFaceCentering: false,
  708. // // Enables detecting face expressions and sharing data with other participants
  709. // enableFaceExpressionsDetection: false,
  710. // // Enables displaying face expressions in speaker stats
  711. // enableDisplayFaceExpressions: false,
  712. // // Enable rtc stats for face landmarks
  713. // enableRTCStats: false,
  714. // // Minimum required face movement percentage threshold for sending new face centering coordinates data.
  715. // faceCenteringThreshold: 10,
  716. // // Milliseconds for processing a new image capture in order to detect face coordinates if they exist.
  717. // captureInterval: 1000,
  718. // },
  719. // Controls the percentage of automatic feedback shown to participants when callstats is enabled.
  720. // The default value is 100%. If set to 0, no automatic feedback will be requested
  721. // feedbackPercentage: 100,
  722. // Privacy
  723. //
  724. // If third party requests are disabled, no other server will be contacted.
  725. // This means avatars will be locally generated and callstats integration
  726. // will not function.
  727. // disableThirdPartyRequests: false,
  728. // Peer-To-Peer mode: used (if enabled) when there are just 2 participants.
  729. //
  730. p2p: {
  731. // Enables peer to peer mode. When enabled the system will try to
  732. // establish a direct connection when there are exactly 2 participants
  733. // in the room. If that succeeds the conference will stop sending data
  734. // through the JVB and use the peer to peer connection instead. When a
  735. // 3rd participant joins the conference will be moved back to the JVB
  736. // connection.
  737. enabled: true,
  738. // Enable unified plan implementation support on Chromium for p2p connection.
  739. // enableUnifiedOnChrome: false,
  740. // Sets the ICE transport policy for the p2p connection. At the time
  741. // of this writing the list of possible values are 'all' and 'relay',
  742. // but that is subject to change in the future. The enum is defined in
  743. // the WebRTC standard:
  744. // https://www.w3.org/TR/webrtc/#rtcicetransportpolicy-enum.
  745. // If not set, the effective value is 'all'.
  746. // iceTransportPolicy: 'all',
  747. // If set to true, it will prefer to use H.264 for P2P calls (if H.264
  748. // is supported). This setting is deprecated, use preferredCodec instead.
  749. // preferH264: true,
  750. // Provides a way to set the video codec preference on the p2p connection. Acceptable
  751. // codec values are 'VP8', 'VP9' and 'H264'.
  752. // preferredCodec: 'H264',
  753. // If set to true, disable H.264 video codec by stripping it out of the
  754. // SDP. This setting is deprecated, use disabledCodec instead.
  755. // disableH264: false,
  756. // Provides a way to prevent a video codec from being negotiated on the p2p connection.
  757. // disabledCodec: '',
  758. // How long we're going to wait, before going back to P2P after the 3rd
  759. // participant has left the conference (to filter out page reload).
  760. // backToP2PDelay: 5,
  761. // The STUN servers that will be used in the peer to peer connections
  762. stunServers: [
  763. // { urls: 'stun:jitsi-meet.example.com:3478' },
  764. { urls: 'stun:meet-jit-si-turnrelay.jitsi.net:443' },
  765. ],
  766. },
  767. analytics: {
  768. // True if the analytics should be disabled
  769. // disabled: false,
  770. // The Google Analytics Tracking ID:
  771. // googleAnalyticsTrackingId: 'your-tracking-id-UA-123456-1',
  772. // Matomo configuration:
  773. // matomoEndpoint: 'https://your-matomo-endpoint/',
  774. // matomoSiteID: '42',
  775. // The Amplitude APP Key:
  776. // amplitudeAPPKey: '<APP_KEY>',
  777. // Obfuscates room name sent to analytics (amplitude, rtcstats)
  778. // Default value is false.
  779. // obfuscateRoomName: false,
  780. // Configuration for the rtcstats server:
  781. // By enabling rtcstats server every time a conference is joined the rtcstats
  782. // module connects to the provided rtcstatsEndpoint and sends statistics regarding
  783. // PeerConnection states along with getStats metrics polled at the specified
  784. // interval.
  785. // rtcstatsEnabled: false,
  786. // rtcstatsStoreLogs: false,
  787. // In order to enable rtcstats one needs to provide a endpoint url.
  788. // rtcstatsEndpoint: wss://rtcstats-server-pilot.jitsi.net/,
  789. // The interval at which rtcstats will poll getStats, defaults to 10000ms.
  790. // If the value is set to 0 getStats won't be polled and the rtcstats client
  791. // will only send data related to RTCPeerConnection events.
  792. // rtcstatsPollInterval: 10000,
  793. // This determines if rtcstats sends the SDP to the rtcstats server or replaces
  794. // all SDPs with an empty string instead.
  795. // rtcstatsSendSdp: false,
  796. // Array of script URLs to load as lib-jitsi-meet "analytics handlers".
  797. // scriptURLs: [
  798. // "libs/analytics-ga.min.js", // google-analytics
  799. // "https://example.com/my-custom-analytics.js",
  800. // ],
  801. },
  802. // Logs that should go be passed through the 'log' event if a handler is defined for it
  803. // apiLogLevels: ['warn', 'log', 'error', 'info', 'debug'],
  804. // Information about the jitsi-meet instance we are connecting to, including
  805. // the user region as seen by the server.
  806. // deploymentInfo: {
  807. // shard: "shard1",
  808. // region: "europe",
  809. // userRegion: "asia",
  810. // },
  811. // Array<string> of disabled sounds.
  812. // Possible values:
  813. // - 'ASKED_TO_UNMUTE_SOUND'
  814. // - 'E2EE_OFF_SOUND'
  815. // - 'E2EE_ON_SOUND'
  816. // - 'INCOMING_MSG_SOUND'
  817. // - 'KNOCKING_PARTICIPANT_SOUND'
  818. // - 'LIVE_STREAMING_OFF_SOUND'
  819. // - 'LIVE_STREAMING_ON_SOUND'
  820. // - 'NO_AUDIO_SIGNAL_SOUND'
  821. // - 'NOISY_AUDIO_INPUT_SOUND'
  822. // - 'OUTGOING_CALL_EXPIRED_SOUND'
  823. // - 'OUTGOING_CALL_REJECTED_SOUND'
  824. // - 'OUTGOING_CALL_RINGING_SOUND'
  825. // - 'OUTGOING_CALL_START_SOUND'
  826. // - 'PARTICIPANT_JOINED_SOUND'
  827. // - 'PARTICIPANT_LEFT_SOUND'
  828. // - 'RAISE_HAND_SOUND'
  829. // - 'REACTION_SOUND'
  830. // - 'RECORDING_OFF_SOUND'
  831. // - 'RECORDING_ON_SOUND'
  832. // - 'TALK_WHILE_MUTED_SOUND'
  833. // disabledSounds: [],
  834. // DEPRECATED! Use `disabledSounds` instead.
  835. // Decides whether the start/stop recording audio notifications should play on record.
  836. // disableRecordAudioNotification: false,
  837. // DEPRECATED! Use `disabledSounds` instead.
  838. // Disables the sounds that play when other participants join or leave the
  839. // conference (if set to true, these sounds will not be played).
  840. // disableJoinLeaveSounds: false,
  841. // DEPRECATED! Use `disabledSounds` instead.
  842. // Disables the sounds that play when a chat message is received.
  843. // disableIncomingMessageSound: false,
  844. // Information for the chrome extension banner
  845. // chromeExtensionBanner: {
  846. // // The chrome extension to be installed address
  847. // url: 'https://chrome.google.com/webstore/detail/jitsi-meetings/kglhbbefdnlheedjiejgomgmfplipfeb',
  848. // edgeUrl: 'https://microsoftedge.microsoft.com/addons/detail/jitsi-meetings/eeecajlpbgjppibfledfihobcabccihn',
  849. // // Extensions info which allows checking if they are installed or not
  850. // chromeExtensionsInfo: [
  851. // {
  852. // id: 'kglhbbefdnlheedjiejgomgmfplipfeb',
  853. // path: 'jitsi-logo-48x48.png',
  854. // },
  855. // // Edge extension info
  856. // {
  857. // id: 'eeecajlpbgjppibfledfihobcabccihn',
  858. // path: 'jitsi-logo-48x48.png',
  859. // },
  860. // ]
  861. // },
  862. // e2ee: {
  863. // labels,
  864. // externallyManagedKey: false,
  865. // },
  866. // Options related to end-to-end (participant to participant) ping.
  867. // e2eping: {
  868. // // Whether ene-to-end pings should be enabled.
  869. // enabled: false,
  870. //
  871. // // The number of responses to wait for.
  872. // numRequests: 5,
  873. //
  874. // // The max conference size in which e2e pings will be sent.
  875. // maxConferenceSize: 200,
  876. //
  877. // // The maximum number of e2e ping messages per second for the whole conference to aim for.
  878. // // This is used to control the pacing of messages in order to reduce the load on the backend.
  879. // maxMessagesPerSecond: 250,
  880. // },
  881. // If set, will attempt to use the provided video input device label when
  882. // triggering a screenshare, instead of proceeding through the normal flow
  883. // for obtaining a desktop stream.
  884. // NOTE: This option is experimental and is currently intended for internal
  885. // use only.
  886. // _desktopSharingSourceDevice: 'sample-id-or-label',
  887. // If true, any checks to handoff to another application will be prevented
  888. // and instead the app will continue to display in the current browser.
  889. // disableDeepLinking: false,
  890. // A property to disable the right click context menu for localVideo
  891. // the menu has option to flip the locally seen video for local presentations
  892. // disableLocalVideoFlip: false,
  893. // A property used to unset the default flip state of the local video.
  894. // When it is set to 'true', the local(self) video will not be mirrored anymore.
  895. // doNotFlipLocalVideo: false,
  896. // Mainly privacy related settings
  897. // Disables all invite functions from the app (share, invite, dial out...etc)
  898. // disableInviteFunctions: true,
  899. // Disables storing the room name to the recents list. When in an iframe this is ignored and
  900. // the room is never stored in the recents list.
  901. // doNotStoreRoom: true,
  902. // Deployment specific URLs.
  903. // deploymentUrls: {
  904. // // If specified a 'Help' button will be displayed in the overflow menu with a link to the specified URL for
  905. // // user documentation.
  906. // userDocumentationURL: 'https://docs.example.com/video-meetings.html',
  907. // // If specified a 'Download our apps' button will be displayed in the overflow menu with a link
  908. // // to the specified URL for an app download page.
  909. // downloadAppsUrl: 'https://docs.example.com/our-apps.html',
  910. // },
  911. // Options related to the remote participant menu.
  912. // remoteVideoMenu: {
  913. // // Whether the remote video context menu to be rendered or not.
  914. // disabled: true,
  915. // // If set to true the 'Kick out' button will be disabled.
  916. // disableKick: true,
  917. // // If set to true the 'Grant moderator' button will be disabled.
  918. // disableGrantModerator: true,
  919. // // If set to true the 'Send private message' button will be disabled.
  920. // disablePrivateChat: true,
  921. // },
  922. // Endpoint that enables support for salesforce integration with in-meeting resource linking
  923. // This is required for:
  924. // listing the most recent records - salesforceUrl/records/recents
  925. // searching records - salesforceUrl/records?text=${text}
  926. // retrieving record details - salesforceUrl/records/${id}?type=${type}
  927. // and linking the meeting - salesforceUrl/sessions/${sessionId}/records/${id}
  928. //
  929. // salesforceUrl: 'https://api.example.com/',
  930. // If set to true all muting operations of remote participants will be disabled.
  931. // disableRemoteMute: true,
  932. // Enables support for lip-sync for this client (if the browser supports it).
  933. // enableLipSync: false,
  934. /**
  935. External API url used to receive branding specific information.
  936. If there is no url set or there are missing fields, the defaults are applied.
  937. The config file should be in JSON.
  938. None of the fields are mandatory and the response must have the shape:
  939. {
  940. // The domain url to apply (will replace the domain in the sharing conference link/embed section)
  941. inviteDomain: 'example-company.org,
  942. // The hex value for the colour used as background
  943. backgroundColor: '#fff',
  944. // The url for the image used as background
  945. backgroundImageUrl: 'https://example.com/background-img.png',
  946. // The anchor url used when clicking the logo image
  947. logoClickUrl: 'https://example-company.org',
  948. // The url used for the image used as logo
  949. logoImageUrl: 'https://example.com/logo-img.png',
  950. // Overwrite for pool of background images for avatars
  951. avatarBackgrounds: ['url(https://example.com/avatar-background-1.png)', '#FFF'],
  952. // The lobby/prejoin screen background
  953. premeetingBackground: 'url(https://example.com/premeeting-background.png)',
  954. // A list of images that can be used as video backgrounds.
  955. // When this field is present, the default images will be replaced with those provided.
  956. virtualBackgrounds: ['https://example.com/img.jpg'],
  957. // Object containing a theme's properties. It also supports partial overwrites of the main theme.
  958. // For a list of all possible theme tokens and their current defaults, please check:
  959. // https://github.com/jitsi/jitsi-meet/tree/master/resources/custom-theme/custom-theme.json
  960. // For a short explanations on each of the tokens, please check:
  961. // https://github.com/jitsi/jitsi-meet/blob/master/react/features/base/ui/Tokens.js
  962. // IMPORTANT!: This is work in progress so many of the various tokens are not yet applied in code
  963. // or they are partially applied.
  964. customTheme: {
  965. palette: {
  966. ui01: "orange !important",
  967. ui02: "maroon",
  968. surface02: 'darkgreen',
  969. ui03: "violet",
  970. ui04: "magenta",
  971. ui05: "blueviolet",
  972. field02Hover: 'red',
  973. action01: 'green',
  974. action01Hover: 'lightgreen',
  975. disabled01: 'beige',
  976. success02: 'cadetblue',
  977. action02Hover: 'aliceblue',
  978. },
  979. typography: {
  980. labelRegular: {
  981. fontSize: 25,
  982. lineHeight: 30,
  983. fontWeight: 500,
  984. }
  985. }
  986. }
  987. }
  988. */
  989. // dynamicBrandingUrl: '',
  990. // Options related to the participants pane.
  991. // participantsPane: {
  992. // // Hides the moderator settings tab.
  993. // hideModeratorSettingsTab: false,
  994. // // Hides the more actions button.
  995. // hideMoreActionsButton: false,
  996. // // Hides the mute all button.
  997. // hideMuteAllButton: false,
  998. // },
  999. // Options related to the breakout rooms feature.
  1000. // breakoutRooms: {
  1001. // // Hides the add breakout room button. This replaces `hideAddRoomButton`.
  1002. // hideAddRoomButton: false,
  1003. // // Hides the auto assign participants button.
  1004. // hideAutoAssignButton: false,
  1005. // // Hides the join breakout room button.
  1006. // hideJoinRoomButton: false,
  1007. // },
  1008. // When true the user cannot add more images to be used as virtual background.
  1009. // Only the default ones from will be available.
  1010. // disableAddingBackgroundImages: false,
  1011. // Disables using screensharing as virtual background.
  1012. // disableScreensharingVirtualBackground: false,
  1013. // Sets the background transparency level. '0' is fully transparent, '1' is opaque.
  1014. // backgroundAlpha: 1,
  1015. // The URL of the moderated rooms microservice, if available. If it
  1016. // is present, a link to the service will be rendered on the welcome page,
  1017. // otherwise the app doesn't render it.
  1018. // moderatedRoomServiceUrl: 'https://moderated.jitsi-meet.example.com',
  1019. // If true, tile view will not be enabled automatically when the participants count threshold is reached.
  1020. // disableTileView: true,
  1021. // If true, the tiles will be displayed contained within the available space rather than enlarged to cover it,
  1022. // with a 16:9 aspect ratio (old behaviour).
  1023. // disableTileEnlargement: true,
  1024. // Controls the visibility and behavior of the top header conference info labels.
  1025. // If a label's id is not in any of the 2 arrays, it will not be visible at all on the header.
  1026. // conferenceInfo: {
  1027. // // those labels will not be hidden in tandem with the toolbox.
  1028. // alwaysVisible: ['recording', 'raised-hands-count'],
  1029. // // those labels will be auto-hidden in tandem with the toolbox buttons.
  1030. // autoHide: [
  1031. // 'subject',
  1032. // 'conference-timer',
  1033. // 'participants-count',
  1034. // 'e2ee',
  1035. // 'transcribing',
  1036. // 'video-quality',
  1037. // 'insecure-room',
  1038. // 'highlight-moment',
  1039. // 'top-panel-toggle',
  1040. // ]
  1041. // },
  1042. // Hides the conference subject
  1043. // hideConferenceSubject: false,
  1044. // Hides the conference timer.
  1045. // hideConferenceTimer: false,
  1046. // Hides the recording label
  1047. // hideRecordingLabel: false,
  1048. // Hides the participants stats
  1049. // hideParticipantsStats: true,
  1050. // Sets the conference subject
  1051. // subject: 'Conference Subject',
  1052. // Sets the conference local subject
  1053. // localSubject: 'Conference Local Subject',
  1054. // This property is related to the use case when jitsi-meet is used via the IFrame API. When the property is true
  1055. // jitsi-meet will use the local storage of the host page instead of its own. This option is useful if the browser
  1056. // is not persisting the local storage inside the iframe.
  1057. // useHostPageLocalStorage: true,
  1058. // Etherpad ("shared document") integration.
  1059. //
  1060. // If set, add a "Open shared document" link to the bottom right menu that
  1061. // will open an etherpad document.
  1062. // etherpad_base: 'https://your-etherpad-installati.on/p/',
  1063. // To enable information about dial-in access to meetings you need to provide
  1064. // dialInNumbersUrl and dialInConfCodeUrl.
  1065. // dialInNumbersUrl returns a json array of numbers that can be used for dial-in.
  1066. // {"countryCode":"US","tollFree":false,"formattedNumber":"+1 123-456-7890"}
  1067. // dialInConfCodeUrl is the conference mapper converting a meeting id to a PIN used for dial-in
  1068. // or the other way around (more info in resources/cloud-api.swagger)
  1069. //
  1070. // For JaaS customers the default values are:
  1071. // dialInNumbersUrl: 'https://conference-mapper.jitsi.net/v1/access/dids',
  1072. // dialInConfCodeUrl: 'https://conference-mapper.jitsi.net/v1/access',
  1073. //
  1074. // List of undocumented settings used in jitsi-meet
  1075. /**
  1076. _immediateReloadThreshold
  1077. debug
  1078. debugAudioLevels
  1079. deploymentInfo
  1080. dialOutAuthUrl
  1081. dialOutCodesUrl
  1082. disableRemoteControl
  1083. displayJids
  1084. externalConnectUrl
  1085. e2eeLabels
  1086. firefox_fake_device
  1087. googleApiApplicationClientID
  1088. iAmRecorder
  1089. iAmSipGateway
  1090. microsoftApiApplicationClientID
  1091. peopleSearchQueryTypes
  1092. peopleSearchUrl
  1093. requireDisplayName
  1094. tokenAuthUrl
  1095. */
  1096. /**
  1097. * This property can be used to alter the generated meeting invite links (in combination with a branding domain
  1098. * which is retrieved internally by jitsi meet) (e.g. https://meet.jit.si/someMeeting
  1099. * can become https://brandedDomain/roomAlias)
  1100. */
  1101. // brandingRoomAlias: null,
  1102. // List of undocumented settings used in lib-jitsi-meet
  1103. /**
  1104. _peerConnStatusOutOfLastNTimeout
  1105. _peerConnStatusRtcMuteTimeout
  1106. abTesting
  1107. avgRtpStatsN
  1108. callStatsConfIDNamespace
  1109. callStatsCustomScriptUrl
  1110. desktopSharingSources
  1111. disableAEC
  1112. disableAGC
  1113. disableAP
  1114. disableHPF
  1115. disableNS
  1116. enableTalkWhileMuted
  1117. forceJVB121Ratio
  1118. forceTurnRelay
  1119. hiddenDomain
  1120. hiddenFromRecorderFeatureEnabled
  1121. ignoreStartMuted
  1122. websocketKeepAlive
  1123. websocketKeepAliveUrl
  1124. */
  1125. /**
  1126. * Default interval (milliseconds) for triggering mouseMoved iframe API event
  1127. */
  1128. mouseMoveCallbackInterval: 1000,
  1129. /**
  1130. Use this array to configure which notifications will be shown to the user
  1131. The items correspond to the title or description key of that notification
  1132. Some of these notifications also depend on some other internal logic to be displayed or not,
  1133. so adding them here will not ensure they will always be displayed
  1134. A falsy value for this prop will result in having all notifications enabled (e.g null, undefined, false)
  1135. */
  1136. // notifications: [
  1137. // 'connection.CONNFAIL', // shown when the connection fails,
  1138. // 'dialog.cameraNotSendingData', // shown when there's no feed from user's camera
  1139. // 'dialog.kickTitle', // shown when user has been kicked
  1140. // 'dialog.liveStreaming', // livestreaming notifications (pending, on, off, limits)
  1141. // 'dialog.lockTitle', // shown when setting conference password fails
  1142. // 'dialog.maxUsersLimitReached', // shown when maximmum users limit has been reached
  1143. // 'dialog.micNotSendingData', // shown when user's mic is not sending any audio
  1144. // 'dialog.passwordNotSupportedTitle', // shown when setting conference password fails due to password format
  1145. // 'dialog.recording', // recording notifications (pending, on, off, limits)
  1146. // 'dialog.remoteControlTitle', // remote control notifications (allowed, denied, start, stop, error)
  1147. // 'dialog.reservationError',
  1148. // 'dialog.serviceUnavailable', // shown when server is not reachable
  1149. // 'dialog.sessTerminated', // shown when there is a failed conference session
  1150. // 'dialog.sessionRestarted', // show when a client reload is initiated because of bridge migration
  1151. // 'dialog.tokenAuthFailed', // show when an invalid jwt is used
  1152. // 'dialog.transcribing', // transcribing notifications (pending, off)
  1153. // 'dialOut.statusMessage', // shown when dial out status is updated.
  1154. // 'liveStreaming.busy', // shown when livestreaming service is busy
  1155. // 'liveStreaming.failedToStart', // shown when livestreaming fails to start
  1156. // 'liveStreaming.unavailableTitle', // shown when livestreaming service is not reachable
  1157. // 'lobby.joinRejectedMessage', // shown when while in a lobby, user's request to join is rejected
  1158. // 'lobby.notificationTitle', // shown when lobby is toggled and when join requests are allowed / denied
  1159. // 'notify.chatMessages', // shown when receiving chat messages while the chat window is closed
  1160. // 'notify.disconnected', // shown when a participant has left
  1161. // 'notify.connectedOneMember', // show when a participant joined
  1162. // 'notify.connectedTwoMembers', // show when two participants joined simultaneously
  1163. // 'notify.connectedThreePlusMembers', // show when more than 2 participants joined simultaneously
  1164. // 'notify.leftOneMember', // show when a participant left
  1165. // 'notify.leftTwoMembers', // show when two participants left simultaneously
  1166. // 'notify.leftThreePlusMembers', // show when more than 2 participants left simultaneously
  1167. // 'notify.grantedTo', // shown when moderator rights were granted to a participant
  1168. // 'notify.hostAskedUnmute', // shown to participant when host asks them to unmute
  1169. // 'notify.invitedOneMember', // shown when 1 participant has been invited
  1170. // 'notify.invitedThreePlusMembers', // shown when 3+ participants have been invited
  1171. // 'notify.invitedTwoMembers', // shown when 2 participants have been invited
  1172. // 'notify.kickParticipant', // shown when a participant is kicked
  1173. // 'notify.linkToSalesforce', // shown when joining a meeting with salesforce integration
  1174. // 'notify.moderationStartedTitle', // shown when AV moderation is activated
  1175. // 'notify.moderationStoppedTitle', // shown when AV moderation is deactivated
  1176. // 'notify.moderationInEffectTitle', // shown when user attempts to unmute audio during AV moderation
  1177. // 'notify.moderationInEffectVideoTitle', // shown when user attempts to enable video during AV moderation
  1178. // 'notify.moderationInEffectCSTitle', // shown when user attempts to share content during AV moderation
  1179. // 'notify.mutedRemotelyTitle', // shown when user is muted by a remote party
  1180. // 'notify.mutedTitle', // shown when user has been muted upon joining,
  1181. // 'notify.newDeviceAudioTitle', // prompts the user to use a newly detected audio device
  1182. // 'notify.newDeviceCameraTitle', // prompts the user to use a newly detected camera
  1183. // 'notify.participantWantsToJoin', // shown when lobby is enabled and participant requests to join meeting
  1184. // 'notify.passwordRemovedRemotely', // shown when a password has been removed remotely
  1185. // 'notify.passwordSetRemotely', // shown when a password has been set remotely
  1186. // 'notify.raisedHand', // shown when a partcipant used raise hand,
  1187. // 'notify.startSilentTitle', // shown when user joined with no audio
  1188. // 'notify.unmute', // shown to moderator when user raises hand during AV moderation
  1189. // 'notify.videoMutedRemotelyTitle', // shown when user's video is muted by a remote party,
  1190. // 'prejoin.errorDialOut',
  1191. // 'prejoin.errorDialOutDisconnected',
  1192. // 'prejoin.errorDialOutFailed',
  1193. // 'prejoin.errorDialOutStatus',
  1194. // 'prejoin.errorStatusCode',
  1195. // 'prejoin.errorValidation',
  1196. // 'recording.busy', // shown when recording service is busy
  1197. // 'recording.failedToStart', // shown when recording fails to start
  1198. // 'recording.unavailableTitle', // shown when recording service is not reachable
  1199. // 'toolbar.noAudioSignalTitle', // shown when a broken mic is detected
  1200. // 'toolbar.noisyAudioInputTitle', // shown when noise is detected for the current microphone
  1201. // 'toolbar.talkWhileMutedPopup', // shown when user tries to speak while muted
  1202. // 'transcribing.failedToStart', // shown when transcribing fails to start
  1203. // ],
  1204. // List of notifications to be disabled. Works in tandem with the above setting.
  1205. // disabledNotifications: [],
  1206. // Prevent the filmstrip from autohiding when screen width is under a certain threshold
  1207. // disableFilmstripAutohiding: false,
  1208. // filmstrip: {
  1209. // // Disables user resizable filmstrip. Also, allows configuration of the filmstrip
  1210. // // (width, tiles aspect ratios) through the interfaceConfig options.
  1211. // disableResizable: false,
  1212. // // Disables the stage filmstrip
  1213. // // (displaying multiple participants on stage besides the vertical filmstrip)
  1214. // disableStageFilmstrip: false,
  1215. // // Disables the top panel (only shown when a user is sharing their screen).
  1216. // disableTopPanel: false,
  1217. // // The minimum number of participants that must be in the call for
  1218. // // the top panel layout to be used.
  1219. // minParticipantCountForTopPanel: 50,
  1220. // },
  1221. // Tile view related config options.
  1222. // tileView: {
  1223. // // The optimal number of tiles that are going to be shown in tile view. Depending on the screen size it may
  1224. // // not be possible to show the exact number of participants specified here.
  1225. // numberOfVisibleTiles: 25,
  1226. // },
  1227. // Specifies whether the chat emoticons are disabled or not
  1228. // disableChatSmileys: false,
  1229. // Settings for the GIPHY integration.
  1230. // giphy: {
  1231. // // Whether the feature is enabled or not.
  1232. // enabled: false,
  1233. // // SDK API Key from Giphy.
  1234. // sdkKey: '',
  1235. // // Display mode can be one of:
  1236. // // - tile: show the GIF on the tile of the participant that sent it.
  1237. // // - chat: show the GIF as a message in chat
  1238. // // - all: all of the above. This is the default option
  1239. // displayMode: 'all',
  1240. // // How long the GIF should be displayed on the tile (in milliseconds).
  1241. // tileTime: 5000,
  1242. // },
  1243. // Logging
  1244. // logging: {
  1245. // // Default log level for the app and lib-jitsi-meet.
  1246. // defaultLogLevel: 'trace',
  1247. // // Option to disable LogCollector (which stores the logs on CallStats).
  1248. // //disableLogCollector: true,
  1249. // // Individual loggers are customizable.
  1250. // loggers: {
  1251. // // The following are too verbose in their logging with the default level.
  1252. // 'modules/RTC/TraceablePeerConnection.js': 'info',
  1253. // 'modules/statistics/CallStats.js': 'info',
  1254. // 'modules/xmpp/strophe.util.js': 'log',
  1255. // },
  1256. // Application logo url
  1257. // defaultLogoUrl: 'images/watermark.svg',
  1258. };