NetObsBindings 0.0.1.37-alpha

This is a prerelease version of NetObsBindings.

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

dotnet add package NetObsBindings --version 0.0.1.37-alpha

NuGet\Install-Package NetObsBindings -Version 0.0.1.37-alpha

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="NetObsBindings" Version="0.0.1.37-alpha" />

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

paket add NetObsBindings --version 0.0.1.37-alpha

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

#r "nuget: NetObsBindings, 0.0.1.37-alpha"

#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.

// Install NetObsBindings as a Cake Addin
#addin nuget:?package=NetObsBindings&version=0.0.1.37-alpha&prerelease

// Install NetObsBindings as a Cake Tool
#tool nuget:?package=NetObsBindings&version=0.0.1.37-alpha&prerelease

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

NetObsBindings

NetObsBindings is a library that provides .NET bindings for Open Broadcaster Software (OBS).

These bindings are generated from the OBS repository, specifically libobs and obs-frontend projects.

The approach taken is to generate a static class per header file via ClangSharp generator. This means, that, for example, you could find functions exported from the obs-service.h file in the ObsService C# class.

How to use these bindings?

These bindings can be used to create your own plugin in C#. There is one caveat: make sure you are publishing the plugins as NativeAOT libraries, this is essential to make it work due to the plugin model of OBS.

Examples:

samples folder contains a simple plugin example.
more comprehensive example - ObsCSharpExample by @YorVeX

Example for an OBS plugin written in C# containing various standard items like output, filter, source or a settings dialog in the OBS Tools menu.

Plugins made using this library:

xObsBrowserAutoRefresh by @YorVeX

OBS plugin providing a filter for automatically refreshing a browser source in a configurable interval.

How to generate bindings locally?

In order to generate bindings locally, please use the build.ps1 script. Make sure that you have ClangSharpPInvokeGenerator dotnet tool installed.

This script will:

Clone the OBS repository
Generate bindings for all required modules
Insert the version of the OBS library to Obs.Version.cs file.

NB: to change the OBS version - modify the $GitTag variable in the ./init_obs.ps1 script

Originally, these bindings generated in the blog post https://sharovarskyi.com/blog/posts/clangsharp-dotnet-interop-bindings/

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

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net7.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.