XeroxDev.YTMDesktop.Companion 1.1.2

dotnet add package XeroxDev.YTMDesktop.Companion --version 1.1.2                
NuGet\Install-Package XeroxDev.YTMDesktop.Companion -Version 1.1.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="XeroxDev.YTMDesktop.Companion" Version="1.1.2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add XeroxDev.YTMDesktop.Companion --version 1.1.2                
#r "nuget: XeroxDev.YTMDesktop.Companion, 1.1.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 XeroxDev.YTMDesktop.Companion as a Cake Addin
#addin nuget:?package=XeroxDev.YTMDesktop.Companion&version=1.1.2

// Install XeroxDev.YTMDesktop.Companion as a Cake Tool
#tool nuget:?package=XeroxDev.YTMDesktop.Companion&version=1.1.2                

YTMDesktop CSharp Companion

This is a library for the YTMDesktop Companion Server which lets you easier communicate with the server and handle authorization and so on.

Table of contents


Forks Stars Watchers Contributors

Issues Issues closed

Issues-pr Issues-pr closed PRs welcome

Version Downloads

Awesome Badges


TODO: Add installation instructions


Can be easier seen in the example file Also you can look through the documentation but here's a quick rundown:

// import everything
using System.Text.Json;
using NuGet.Versioning;
using XeroxDev.YTMDesktop.Companion;
using XeroxDev.YTMDesktop.Companion.Settings;

// Set YOUR version (or fetch them from anywhere) I will use a static version for this example 
var version = "1.0.0"

// Define settings (add token if you have one, see bigger example for how this could be done)
var settings = new ConnectorSettings(
    "YTMDesktop C# Companion Example",

// Create a new connector
var connector = new CompanionConnector(settings);

// extract clients for easier access
var restClient = connector.RestClient;
var socketClient = connector.SocketClient;

// Get metadata
var metadata = await restClient.GetMetadata();
if (metadata is null)
    Console.WriteLine("Failed to get metadata. Probably the server is not running or the settings are wrong.");


// Get token
var code = await restClient.GetAuthCode();
if (code is null)
    Console.WriteLine("Failed to get auth code. Probably the server is not running or the settings are wrong.");

Console.WriteLine($"Got new code, please compare it with the code from YTMDesktop: {code}");

var token = await restClient.GetAuthToken(code);
if (string.IsNullOrWhiteSpace(token))
    Console.WriteLine("Something went wrong...");
// Get the current state and print it
var state = await restClient.GetState();

// Pause current track
await restClient.Pause();

// wait 2 seconds
await Task.Delay(2000);

// Resume current track
await restClient.Play();

How to contribute?

Just fork the repository and create PR's.

[!NOTE] We're using release-please to optimal release the library. release-please is following the conventionalcommits specification.

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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
1.1.2 100 2/28/2024
1.1.1 90 2/28/2024
1.1.0 92 2/25/2024
1.0.0 90 2/24/2024