Syphon.NET 0.1.0-alpha.2

This is a prerelease version of Syphon.NET.

There is a newer prerelease version of this package available.
See the version list below for details.

dotnet add package Syphon.NET --version 0.1.0-alpha.2

NuGet\Install-Package Syphon.NET -Version 0.1.0-alpha.2

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Syphon.NET" Version="0.1.0-alpha.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Syphon.NET" Version="0.1.0-alpha.2" />
                    

                            Directory.Packages.props

<PackageReference Include="Syphon.NET" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Syphon.NET --version 0.1.0-alpha.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Syphon.NET, 0.1.0-alpha.2"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Syphon.NET@0.1.0-alpha.2

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Syphon.NET&version=0.1.0-alpha.2&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=Syphon.NET&version=0.1.0-alpha.2&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Syphon.NET

.NET bindings for Syphon, the macOS framework for sharing video frames between applications in real time. Publish frames for other apps to pick up, or receive frames another app is sharing, with no pixel copies in between. Works with OBS, Resolume, TouchDesigner, and other tools that speak Syphon.

Requirements

macOS on Apple Silicon or Intel, with a Metal-capable GPU.
.NET 10 (or .NET 11).

Install

dotnet add package Syphon.NET

The package bundles the native helper it needs; there is nothing else to install.

Publish

using Syphon.NET;

using var server = new SyphonServer("My Output");

// From CPU pixels (BGRA):
server.PublishPixels(bgraPixels, width: 1920, height: 1080);

// Or from a GPU IOSurface you already hold (zero-copy), e.g. a VideoToolbox CVPixelBuffer:
server.Publish(surface);

In OBS, add a Syphon Client source and choose "My Output".

Receive

using Syphon.NET;

using var directory = new SyphonServerDirectory();

// An app with a Cocoa run loop (MAUI/AppKit) discovers automatically. A plain console or server
// process pumps the run loop so discovery notifications arrive:
directory.PumpEvents(TimeSpan.FromMilliseconds(200));

using var client = directory.CreateClient(index: 0);

using SyphonFrame? frame = client.TryGetFrame();
if (frame is not null)
{
    int w = frame.Surface.Width, h = frame.Surface.Height;
    byte[] pixels = new byte[w * h * 4];
    frame.CopyTo(pixels);
}

Each frame is backed by an IOSurface (frame.Surface.Handle), so you can read it on the CPU as shown or hand it straight to VideoToolbox for a zero-copy hardware encode.

Building from source

git clone --recursive https://github.com/Agash/Syphon.NET
cd Syphon.NET
bash native/build-native.sh
dotnet build Syphon.NET.slnx
dotnet test

The native helper compiles the Syphon framework (a git submodule) and a small shim into one universal binary; the managed library is plain net10.0 / net11.0.

License

MIT. See LICENSE. Bundled Syphon framework code is BSD licensed; see THIRD-PARTY-NOTICES.md.

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. net11.0 is compatible.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- No dependencies.
net11.0
- No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
0.1.0-alpha.4	86	6/20/2026
0.1.0-alpha.3	325	6/4/2026
0.1.0-alpha.2	104	6/3/2026
0.1.0-alpha	55	6/2/2026