Video Effects SDK for Electron

In Electron the SDK uses the same JavaScript API as the web, while segmentation runs in a native C++ module — faster than WebAssembly on the same machine. Windows, macOS and Linux are supported.

Run the sample#

git clone [email protected]:EffectsSDK/electron-integration-sample.git
cd electron-integration-sample
npm install
npm start

Put your Customer ID from the Developer Portal into index.html:

const sdk = new window.tsvb('YOUR_CUSTOMER_ID', window.inferer);

Pick the native module for the OS#

In preload.js load the module for the target platform:

const tsvb = require('./libs/win/tsvb');      // Windows
// const tsvb = require('./libs/mac/tsvb');   // macOS
// const tsvb = require('./libs/linux/TSVB'); // Linux

Use the effects#

sdk.onReady = () => {
  sdk.run();
  sdk.setBackground('image-background.jpg');
};

All Web SDK features are available: backgrounds and blur, beautification, auto-framing, color correction, layouts, lower thirds, overlays, color filters, low light and sharpness.

Next steps#

• Web guide — the same API.
• API reference
• Electron sample