Utilities for jitsi-meet-electron project.
jitsi-meet-electron-utils contains native code for some utilities. You'll need node-gyp to build it and also you'll need to rebuild the package for Electron. For more information see Using Native Node Modules and electron-rebuild.
NOTE: For Linux install libxtst-dev and libpng++-dev (sudo apt-get install libxtst-dev libpng++-dev
). This dependancies are related to RobotJS which is a dependency of jitsi-meet-electron-utils. You can see the build instructions for RobotJS here
Requirements: The remote control utility requires iframe HTML Element that will load Jitsi Meet.
Enable the remote control:
const {
RemoteControl
} = require("jitsi-meet-electron-utils");
// iframe - the Jitsi Meet iframe
const remoteControl = new RemoteControl(iframe);
To disable the remote control:
remoteControl.dispose();
NOTE: dispose
method will be called automatically when the Jitsi Meet iframe unload.
Requirements: The screen sharing utility requires iframe HTML Element that will load Jitsi Meet.
Enable the screen sharing:
const {
setupScreenSharingForWindow
} = require("jitsi-meet-electron-utils");
// iframe - the Jitsi Meet iframe
setupScreenSharingForWindow(iframe);
Displays a small window with the current active speaker video when the main Jitsi Meet window is not focused.
Requirements:
- Jitsi Meet should be initialized through our iframe API
- The
BrowserWindow
instance where Jitsi Meet is displayed should use the Chrome's window.open implementation (setnativeWindowOpen
option ofBrowserWindow
's constructor totrue
). - If you have a custom handler for opening windows you have to filter the always on top window. You can do this by its
frameName
argument which will be set toAlwaysOnTop
. - Electron version
>=1.7.x
.
Enable the aways on top:
In the main electron process:
const {
setupAlwaysOnTopMain
} = require("jitsi-meet-electron-utils");
// jitsiMeetWindow - The BrowserWindow instance
// of the window where Jitsi Meet is loaded.
setupAlwaysOnTopMain(jitsiMeetWindow);
In the render electron process of the window where Jitsi Meet is displayed:
const {
setupAlwaysOnTopRender
} = require("jitsi-meet-electron-utils");
const api = new JitsiMeetExternalAPI(...);
const alwaysOnTop = setupAlwaysOnTopRender(api);
alwaysOnTop.on('will-close', handleAlwaysOnTopClose);
setupAlwaysOnTopRender
return an instance of EventEmitter with the following events:
-
dismissed - emitted when the always on top window is explicitly dismissed via its close button
-
will-close - emitted right before the always on top window is going to close
Provides a function to query for wifi stats on the host computer. Returns information like interface name, addresses, signal quality, noise (not available on all OS).
WiFi Stats:
In the render electron process of the window where Jitsi Meet is displayed:
const {
setupWiFiStats
} = require("jitsi-meet-electron-utils");
const api = new JitsiMeetExternalAPI(...);
setupWiFiStats(api.getIFrame());
Provides a way to query electron for system idle and receive power monitor events.
enable power monitor: In the main electron process:
const {
setupPowerMonitorMain
} = require("jitsi-meet-electron-utils");
// jitsiMeetWindow - The BrowserWindow instance
// of the window where Jitsi Meet is loaded.
setupPowerMonitorMain(jitsiMeetWindow);
In the render electron process of the window where Jitsi Meet is displayed:
const {
setupPowerMonitorRender
} = require("jitsi-meet-electron-utils");
const api = new JitsiMeetExternalAPI(...);
setupPowerMonitorRender(api);
If you are using electron 5 you'll need to add 'disable-site-isolation-trials' switch because of electron/electron#18214:
app.commandLine.appendSwitch('disable-site-isolation-trials')
For examples of installation and usage checkout the Jitsi Meet Electron project.