Skip to content

1. Installation

Jump to bottom Edit New page
Trouffman edited this page May 13, 2024 · 13 revisions

Installation

Required - NDI Runtime

The obs-ndi plugin require the NDI runtime to be installed and accessible on your system.

Manually install NDI Runtime:

The NDI runtime is also available if you use :

Windows

Use the built-in Windows Package Manager to install NDI Runtime. winget install --exact --id NDI.NDIRuntime

Install the NDI Tools (optional) winget install --exact --id NDI.NDITools

MacOS

Manual installation only. Make sure install libNDI v6.0.1 or higher

Linux

Debian/Ubuntu install script: .CI/libndi-get.sh This script download and install the LibNDI from the official NDI site

Additional Requirements for NDI to work on linux

sudo apt install avahi-daemon ffmpeg
sudo systemctl enable avahi-daemon
sudo systemctl start avahi-daemon
sudo ufw allow 5353/udp
sudo ufw allow 5959:5969/tcp
sudo ufw allow 5959:5969/udp
sudo ufw allow 6960:6970/tcp
sudo ufw allow 6960:6970/udp
sudo ufw allow 7960:7970/tcp
sudo ufw allow 7960:7970/udp
sudo ufw allow 5960/tcp

References:

OBS-NDI plugin

Install the latest release from Releases.

Windows

Get the latest version of the plugin .exe at Releases

Alternative Installation Methods Use the .zip method if you are using OBS in portable mode or have windows warning "file is suspicious" Unzip directly in your obs-studio folder.

Known issues

  • The system might prompt a warning that the file is not trusted/signed: Select Run Anyway

MacOS

Get the latest version of the plugin .pkg at Releases

Known issues

  • The system might prompt a warning that the file is not trusted/signed
    1. Press "control^" and open -or-
    2. Allow it in System Settings->Privacy & Security
      -or-
    3. sudo xattr -r -d com.apple.quarantine [obs-ndi-package-file].pkg

Linux

Debian

Get the latest version of the plugin .deb at Releases Install package sudo dpkg -i [obs-ndi-package-file].deb

Known issues If the previous steps did not succeed, try:

sudo ln -s /usr/lib/x86_64-linux-gnu/obs-plugins/obs-ndi.so /usr/local/lib/obs-plugins/obs-ndi.so
sudo ln -s /usr/share/obs/obs-plugins/obs-ndi/ /usr/local/share/obs/obs-plugins/obs-ndi

Flatpak

_This is a work in progress)

flatpak install com.obsproject.Studio com.obsproject.Studio.Plugin.NDI
obs --system-talk-name=org.freedesktop.Avahi

obs-ndi's Flakpak is still a work in progress; please experiment and report problems or improvement suggestions.

Uninstall

To remove the plugin, you can follow the official OBS documentation or check the steps below

Windows

  1. Add/Remove Programs: obs-ndi (only available if you used the installer method)
  2. Delete %ProgramFiles%\obs-studio\obs-plugins\64bit\obs-ndi.*
  3. Delete %ProgramFiles%\obs-studio\data\obs-plugins\obs-ndi\
  4. (Optional) Remove other NDI components
    1. Add/Remove Programs
      1. NDI 5 Runtime
      2. NDI 5 Tools
      3. NDI 5 SDK
      4. NDI 5 Advanced SDK
    2. Delete %ProgramFiles%\NDI\NDI 5 Runtime
    3. Delete %ProgramFiles%\NDI\NDI 5 Tools
    4. Delete %ProgramFiles%\NDI\NDI 5 SDK
    5. Delete %ProgramFiles%\NDI\NDI 5 Advanced SDK

MacOS

  1. Open Finder
  2. Show hidden files with Command-Shift-.
  3. Delete ~/Library/Application Support/obs-studio/plugins/obs-ndi.plugin
  4. (Optional) Remove other NDI components
    1. Finder->Applications: Delete all NDI * applications
    2. Delete /Library/Application Support/NewTek/NDI
    3. Delete /usr/local/lib/libndi*

Linux

Debian Remove the plugin

sudo rm /usr/lib/x86_64-linux-gnu/obs-plugins/obs-ndi.so
sudo rm -rf /usr/share/obs/obs-plugins/obs-ndi/

(Optional) Remove the NDI Runtime:

sudo rm /usr/local/lib/libndi*
sudo ldconfig

Flatpak _This is a work in progress)

Add a custom footer
Add a custom sidebar
Clone this wiki locally