OBSClient 2.0.0-preview.2

Additional Details

Please upgrade to v2.

This is a prerelease version of OBSClient.
There is a newer version of this package available.
See the version list below for details.
dotnet add package OBSClient --version 2.0.0-preview.2
NuGet\Install-Package OBSClient -Version 2.0.0-preview.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="OBSClient" Version="2.0.0-preview.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add OBSClient --version 2.0.0-preview.2
#r "nuget: OBSClient, 2.0.0-preview.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.
// Install OBSClient as a Cake Addin
#addin nuget:?package=OBSClient&version=2.0.0-preview.2&prerelease

// Install OBSClient as a Cake Tool
#tool nuget:?package=OBSClient&version=2.0.0-preview.2&prerelease

ObsClient

A Complete cross platform .NET WebSocket Client for OBS Studio version 28 and up.
Currently implementing: obs-websocket 5.3.0 Protocol Our intent is to create a <ins>complete</ins> and <ins>easy to use</ins> client for OBS Studio.

Version 2

We're working on Version 2 of the client. You can download and use our second preview version. Although the changes between v1 and v2 are not huge, they are breaking compatibility with previous versions, so we decided to bump the major version. (See: SemVer) The main goal for Version 2 is to reduce (cognitive) complexity and improve the overall design of the client. For now, the main branch will contain the latest preview version of the code. For future releases (post V2-release), we will use seperate branches.

What's new in V2?

  • Reduced (Cognitive) Complexity
  • Improved support for Request Batches
  • Improved Event handling
  • (Optional) Automatic reconnecting

Installation

Install from the NuGet Gallery
Or through the NuGet CLI: NuGet\Install-Package OBSClient -Version 1.4.0
From the command line: dotnet add package OBSClient --version 1.4.0

Sample usages (Version 1 and Version 2)

ObsClient client = new();
bool isConnected = await client.ConnectAsync();
if (isConnected)
{
    await client.SetCurrentProgramScene("Gaming Scene");
    Monitor[] monitors = await client.GetMonitorList();
    client.Disconnect();
}

Request Batches in Version 2:

ObsClient client = new();
bool isConnected = await client.ConnectAsync(true, "P@ssw0rd", "localhost", 4455, EventSubscriptions.Filters | EventSubscriptions.Scenes);
if (isConnected)
{
    RequestBatchMessage batchRequest = new();
    batchRequest.AddToggleVirtualCamRequest();
    batchRequest.AddSetStudioModeEnabledRequest(true);
    batchRequest.AddSleepRequest(5000, null);
    batchRequest.AddToggleVirtualCamRequest();
    batchRequest.AddSetStudioModeEnabledRequest(false);
    var result = await _client.SendRequestBatchAsync(batchRequest, 6000);
    client.Disconnect();
}

Quality Gate Status Build NuGet

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net6.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
2.1.1 157 4/11/2024
2.0.2 129 2/19/2024
2.0.2-preview.2 49 2/19/2024
2.0.1 100 2/17/2024
2.0.0 322 11/4/2023
2.0.0-preview.2 84 11/2/2023
2.0.0-preview.1 68 10/27/2023
1.3.0 143 10/23/2023
1.2.1 140 10/15/2023
1.2.0 575 1/24/2023
1.1.0 341 1/6/2023
1.0.1 384 12/8/2022
1.0.0 370 12/7/2022