https://github.com/fzwoch/obs-teleport

An OBS Studio plugin for an open NDI-like replacement. Pretty simple, straight forward. No NDI compatibility in any form.
https://github.com/fzwoch/obs-teleport

ndi obs obs-studio plugin teleport

Last synced: 6 days ago
JSON representation

An OBS Studio plugin for an open NDI-like replacement. Pretty simple, straight forward. No NDI compatibility in any form.

• Host: GitHub
• URL: https://github.com/fzwoch/obs-teleport
• Owner: fzwoch
• License: gpl-2.0
• Created: 2021-12-17T08:45:50.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-05T19:47:23.000Z (3 months ago)
• Last Synced: 2024-08-05T22:41:35.360Z (3 months ago)
• Topics: ndi, obs, obs-studio, plugin, teleport
• Language: Go
• Homepage:
• Size: 902 KB
• Stars: 428
• Watchers: 15
• Forks: 16
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• Pop_OS-Guide - Teleport - like replacement. (Setting up OBS Studio / Useful OBS Studio 3rd party plugins and themes.)

README

        
# OBS Teleport

An [OBS Studio] plugin for an open [NDI]-like replacement. Pretty simple, straight forward. No NDI compatibility in any form.

Just as an alternative option for stream setups with multiple machines wanting to transmit some OBS Studio scenes to the main streaming machine in LAN.

![](img/obs-teleport.png)

[OBS Studio]: https://obsproject.com

[NDI]: https://ndi.tv/

## Notes

Obviously a network connection must be made between sender and receiver. So they must be on the same network for peer discovery. **In case no discovery is working, or no video/audio is being transmitted, make sure to disable network firewalls**.

Alternatively you can force the sender to listen on a specific port and set the firewall to allow this port to accept connections.

**Having at least 1 Gbps of a stable network connection is kind of required / highly recommendend.** You can try to make a lower quality stream work with less bandwidth, but this is then up to you to experiment with.

As of now only the Audio/Video filter mechanic is implemented on the filter feature (Async sources). Adding it as an effect filter (Sync sources) is currently not supported. Revert to the output mode in this case.

## Installation

Please refer to the OBS Studio documentation: [plugins-guide], on how and where to install plugins. There are too many platforms and installation options available as the scope of this project could explain and maintain.

Most platforms do have an installer though that may help you with the installation.

Binaries can be grabbed from the [Releases] section.

[plugins-guide]: https://obsproject.com/kb/plugins-guide

[Releases]: https://github.com/fzwoch/obs-teleport/releases

## Setup Sender

Go to `Tools → Teleport`.

![](img/teleport-tools.png)

Check `Teleport Enabled`.

![](img/teleport-output.png)

## Setup Sender as Audio/Video Filter

Click ` Right click → Filters`.

![](img/teleport-properties.png)

Click `+ → Teleport`.

![](img/teleport-filter.png)

## Setup Receiver

In your Scene do `Sources → Add → Teleport`.

![](img/teleport-add.png)

Select a detected stream from the `Teleport` drop down.

![](img/teleport-source.png)