- FFmpeg (FFmpeg6 on Linux, FFmpeg 7 on MacOS)
- Gstreamer
- NodeJS + npm
Before running demos, install JS dependencies with:
npm installLiveCompositor should run on any computer with modern GPU, but if you want to check detailed requirements, visit requirements section in docs.
- Install FFmpeg 7
brew install ffmpeg- Install GStreamer
- Go to GStreamer website, download and open runtime installers (we tested 1.24 release, but should work on the others as well).
- Check if directory
/Library/Frameworks/GStreamer.framework/Commands/exists. - Add
/Library/Frameworks/GStreamer.framework/Commands/toPATH. If you're usingzshrcadd:export PATH="$PATH:/Library/Frameworks/GStreamer.framework/Commands"to~/.zshrc
- Install
node
brew install node- Install JS dependencies
npm installRun this example with:
npm run 1-videoconferencingThis example simulates composing video conference footage. It demonstrate how you can change output dynamically with smooth transitions.
This example also use your webcam. If you have problems with webcam footage, you can substitute it with prerecorded mp4 file:
export LIVE_COMPOSITOR_WEBCAM=falseRun this example with:
npm run 2-tv_broadcastThis example simulates TV broadcasting scenario. It demonstrate how you can combine build-in components with own shaders, customizing LiveCompositor for specific use-case, while utilizing GPU rendering acceleration. In this example, green-screen is removed from input stream with use of custom shader. Transformed input stream, background image, logo, and text are combined in output stream.
Run this example with:
npm run 3-live_streamThis example simulates live streaming screen footage with webcam. It demonstrate how to setup simple output and add elements like donate notifications.
This example also use your webcam. If you have problems with webcam footage, you can substitute it with prerecorded mp4 file:
export LIVE_COMPOSITOR_WEBCAM=falseYou can learn more from documentation. API reference and guides can be found there.