augmenta.client.sdk 2.0.1

.NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package augmenta.client.sdk --version 2.0.1
                    


                    

                
NuGet\Install-Package augmenta.client.sdk -Version 2.0.1
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="augmenta.client.sdk" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="augmenta.client.sdk" Version="2.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="augmenta.client.sdk" />
                    


                            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 augmenta.client.sdk --version 2.0.1
                    


                    

                
#r "nuget: augmenta.client.sdk, 2.0.1"
#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 augmenta.client.sdk@2.0.1
#: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=augmenta.client.sdk&version=2.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=augmenta.client.sdk&version=2.0.1
                    


                            Install as a Cake Tool

Augmenta Client C# SDK

The goal of this SDK is to make consuming the stream output of an Augmenta server as easy as possible. As of right now this only refers to the data emitted through websocket by the Websocket Output.

Include the SDK in your project

As a NuGet package

The SDK is available as a NuGet package.
You can also use it locally by downloading the latest .nupkg file from the release page, and setting it up in your NuGet local feed.

As a submodule

You can alternatively add this repository as a submodule into your project directly. Note that in that case you should also manually download and add the ZstdNet assemblies to your project.

How to use

  • Specialize Augmenta generic object classes with your own type for 3-floats vectors. You can also override some of their behavior by inheriting them.
  • You'll need to provide your own websocket implementation. Maybe your environment already provides one ?
  • Instanciate your Client class.
  • Use its method to parse incoming websocket messages.
  • Use the received data to update whatever you need for your use-case.

For a full example usage, see the Augmenta Unity Websocket Package.

Dependencies

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  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. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETStandard 2.1

NuGet packages (1)

Showing the top 1 NuGet packages that depend on augmenta.client.sdk:

Package Downloads
VL.Augmenta

Provides support for Augmenta tracking in vvvv

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.0.3 218 4/15/2025
2.0.2 150 3/31/2025
2.0.1 116 2/19/2025