WateryTart.MusicAssistant 4.1.0

.NET 8.0

dotnet add package WateryTart.MusicAssistant --version 4.1.0

NuGet\Install-Package WateryTart.MusicAssistant -Version 4.1.0

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="WateryTart.MusicAssistant" Version="4.1.0" />

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

<PackageVersion Include="WateryTart.MusicAssistant" Version="4.1.0" />
                    

                            Directory.Packages.props

<PackageReference Include="WateryTart.MusicAssistant" />
                    

                            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 WateryTart.MusicAssistant --version 4.1.0

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

#r "nuget: WateryTart.MusicAssistant, 4.1.0"

#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 WateryTart.MusicAssistant@4.1.0

#: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=WateryTart.MusicAssistant&version=4.1.0
                    

                            Install as a Cake Addin

#tool nuget:?package=WateryTart.MusicAssistant&version=4.1.0
                    

                            Install as a Cake Tool

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

WateryTart.MusicAssistant

Disclaimer: This is an unofficial project and is not affiliated with, endorsed by, or associated with the Music Assistant project.

A .NET8/10 client library for accesseing Music Assistant's API

This library does not contain a Sendspin client for playback, for that I recommend Sendspin.SDK.

Changelog

Getting Started

Install

Clone or install from nuget
dotnet add package WateryTart.MusicAssistant

Prereqs

.NET 8.0/10.0 SDK
Music Assistant already installed.

If you need to check the Music Assistant API docs, they can be found at

http://<Your Install>/api-docs/

Overview

Music Assistant features two API's, a websocket and "RPC-like" interface. The recommended (by Music Assistant) API is the websocket API which (in their words)

The WebSocket API provides real-time bidirectional communication and automatic event notifications. Perfect for applications that need live updates.

While the RPC API

The HTTP API provides a simple RPC-like interface for executing commands. This allows you to call the same commands available via WebSocket over a simple HTTP POST endpoint. Perfect for one-off commands without needing real-time updates.

Initialisation

using WateryTart.MusicAssistant;
using WateryTart.MusicAssistant.RpcExtensions;
using WateryTart.MusicAssistant.WsExtensions;

var client = new MusicAssistantClient("10.0.1.20:8095");

The url can also be set with client.SetUrl("10.0.1.20:8095");

Calls to each API are structured the same client.WithRpc() or client.WithWs() followed by the method you want to call. ie, client.WithRpc().GetAuthMe(); or client.WithWs().GetAuthMe().

Note, because the two APIs from Music Assistant return different results - the web socket results are in a wrapper - each WateryTart.Music Assistant call will return different objects

Get Auth

AuthUser result = await client.WithRpc().GetAuthToken(username, password);
or
LoginResults result2 = await client.WithWs().GetAuthToken(username, password);

Then set the token (or skip straight to the token if you have one saved)

client.SetToken(result2.Credentials.Token);

Making a call

Once you've set a token, you can make calls to either API. API calls are all async and return a Task<T> where T is the expected result.

All calls are added via extensions methods, so adding further API coverage will require changes to the core client.

//TODO ADD MORE DOCUMENTATION

Events

Only the websocket client has events as its pushed from the server to the client, and its presented as an IObservable<BaseEventResponse>

_wsClient.WithWs().Events
	.ObserveOn(RxApp.MainThreadScheduler)
	.SelectMany(e => Observable.FromAsync(() => OnEvents(e)))
	.Subscribe());



public async Task OnEvents(BaseEventResponse e)
{
    switch (e.EventName)
    {
        case EventType.MediaItemPlayed:
        case EventType.QueueTimeUpdated:
        case EventType.PlayerAdded:
        case EventType.PlayerUpdated:
        case EventType.PlayerRemoved:
        case EventType.QueueUpdated:
        default:
            break;
    }
}

See the Media Assistant API docs for the full list of events.

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. 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 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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- Microsoft.Extensions.Logging (>= 10.0.2)
- Microsoft.Extensions.Logging.Console (>= 10.0.2)
- Websocket.Client (>= 5.3.0)
net8.0
- Microsoft.Extensions.Logging (>= 10.0.2)
- Microsoft.Extensions.Logging.Console (>= 10.0.2)
- Websocket.Client (>= 5.3.0)

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
4.1.0	47	2/26/2026
4.0.1	45	2/25/2026
4.0.0	68	2/24/2026
3.1.0	89	2/19/2026
3.0.1	99	2/16/2026
3.0.0	92	2/15/2026
2.2.9	91	2/15/2026
2.2.8	88	2/14/2026
2.2.1	95	2/13/2026
2.2.0	87	2/13/2026
2.1.1	87	2/12/2026
2.1.0	124	2/12/2026
2.0.0	89	2/10/2026
1.0.4	96	2/9/2026
1.0.3	85	2/8/2026
1.0.2	89	2/8/2026