https://github.com/stephenmp/slobsharp

A .NET Standard Client library used to integrate with StreamLabs OBS
https://github.com/stephenmp/slobsharp

csharp netcore20 netcore21 netstandard netstandard20 nuget nuget-package obs streamlabs streamlabs-obs

Last synced: 2 months ago
JSON representation

A .NET Standard Client library used to integrate with StreamLabs OBS

• Host: GitHub
• URL: https://github.com/stephenmp/slobsharp
• Owner: StephenMP
• License: mit
• Created: 2018-10-20T18:17:50.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T05:25:15.000Z (about 2 years ago)
• Last Synced: 2024-10-30T14:28:15.083Z (3 months ago)
• Topics: csharp, netcore20, netcore21, netstandard, netstandard20, nuget, nuget-package, obs, streamlabs, streamlabs-obs
• Language: C#
• Size: 68.4 KB
• Stars: 7
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SLOBSharp

A .NET Standard Client library used to integrate with StreamLabs OBS

|Build|Release|Code Coverage|

|:---:|:-----:|:-----------:|

|[![Build status](https://ci.appveyor.com/api/projects/status/x5b3uimq6puxe5aw/branch/master?svg=true)](https://ci.appveyor.com/project/StephenMP/slobsharp/branch/master)|[![Build status](https://ci.appveyor.com/api/projects/status/x5b3uimq6puxe5aw/branch/release?svg=true)](https://ci.appveyor.com/project/StephenMP/slobsharp/branch/release) [![NuGet](https://img.shields.io/nuget/v/SLOBSharp.svg)](https://www.nuget.org/packages/SLOBSharp/) [![NuGet](https://img.shields.io/nuget/dt/SLOBSharp.svg)](https://www.nuget.org/packages/SLOBSharp/)|[![codecov](https://codecov.io/gh/StephenMP/SLOBSharp/branch/master/graph/badge.svg)](https://codecov.io/gh/StephenMP/SLOBSharp)|

## Current API Support

Currently, this project only supports using named pipes for [StreamLabs OBS](https://streamlabs.com/streamlabs-obs). WebSocket support may be added at a later date.

## Simple Example

```csharp

/* 

 * This example will get the currently active scene in SLOBS

 * Make sure you have SLOBS running and that you've enabled named pipes before trying

 * See https://github.com/stream-labs/streamlabs-obs-api-docs#how-to-connect-web-application-to-streamlabs-obs

 * on how to enable named pipes in SLOBS

 */

// Constructor takes the name of the pipe (default constructor uses the pipe name "slobs")

var client = new SlobsPipeClient("slobs");

// Build our request

var slobsRequest = SlobsRequestBuilder.NewRequest().SetMethod("activeScene").SetResource("ScenesService").BuildRequest();

// Issue the request

var slobsRpcResponse = await this.slobsClient.ExecuteRequestAsync(request).ConfigureAwait(false);

// Get the result

var activeScene = slobsRpcResponse.Result.FirstOrDefault();

```