XeroxDev.YTMDesktop.Companion
1.1.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package XeroxDev.YTMDesktop.Companion --version 1.1.0
NuGet\Install-Package XeroxDev.YTMDesktop.Companion -Version 1.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="XeroxDev.YTMDesktop.Companion" Version="1.1.0" />
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.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: XeroxDev.YTMDesktop.Companion, 1.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.
// Install XeroxDev.YTMDesktop.Companion as a Cake Addin
#addin nuget:?package=XeroxDev.YTMDesktop.Companion&version=1.1.0
// Install XeroxDev.YTMDesktop.Companion as a Cake Tool
#tool nuget:?package=XeroxDev.YTMDesktop.Companion&version=1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
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
Badges
Installation
TODO: Add installation instructions
Usage
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 = SemanticVersion.Parse("1.0.0");
// Define settings (add token if you have one, see bigger example for how this could be done)
var settings = new ConnectorSettings(
"127.0.0.1",
9863,
"ytmdesktop-cs-companion-example",
"YTMDesktop C# Companion Example",
version
);
// 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.");
return;
}
Console.WriteLine(JsonSerializer.Serialize(metadata));
// 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.");
return;
}
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...");
return;
}
// Get the current state and print it
var state = await restClient.GetState();
Console.WriteLine(JsonSerializer.Serialize(state));
// 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 | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. 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. net6.0-windows7.0 is compatible. net7.0 is compatible. 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. net7.0-windows7.0 is compatible. 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. net8.0-windows7.0 is compatible. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 is compatible. net48 is compatible. net481 is compatible. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. 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.
-
.NETFramework 4.7.2
- NuGet.Versioning (>= 6.9.1)
- SocketIOClient (>= 3.1.1)
- SocketIOClient.Windows7 (>= 3.1.1)
- System.Net.Http (>= 4.3.4)
- System.Net.Http.Json (>= 8.0.0)
-
.NETFramework 4.8
- NuGet.Versioning (>= 6.9.1)
- SocketIOClient (>= 3.1.1)
- SocketIOClient.Windows7 (>= 3.1.1)
- System.Net.Http (>= 4.3.4)
- System.Net.Http.Json (>= 8.0.0)
-
.NETFramework 4.8.1
- NuGet.Versioning (>= 6.9.1)
- SocketIOClient (>= 3.1.1)
- SocketIOClient.Windows7 (>= 3.1.1)
- System.Net.Http (>= 4.3.4)
- System.Net.Http.Json (>= 8.0.0)
-
.NETStandard 2.0
- NuGet.Versioning (>= 6.9.1)
- SocketIOClient (>= 3.1.1)
- SocketIOClient.Windows7 (>= 3.1.1)
- System.Net.Http (>= 4.3.4)
- System.Net.Http.Json (>= 8.0.0)
-
.NETStandard 2.1
- NuGet.Versioning (>= 6.9.1)
- SocketIOClient (>= 3.1.1)
- SocketIOClient.Windows7 (>= 3.1.1)
- System.Net.Http (>= 4.3.4)
- System.Net.Http.Json (>= 8.0.0)
-
net6.0
- NuGet.Versioning (>= 6.9.1)
- SocketIOClient (>= 3.1.1)
- SocketIOClient.Windows7 (>= 3.1.1)
- System.Net.Http (>= 4.3.4)
- System.Net.Http.Json (>= 8.0.0)
-
net6.0-windows7.0
- NuGet.Versioning (>= 6.9.1)
- SocketIOClient (>= 3.1.1)
- SocketIOClient.Windows7 (>= 3.1.1)
- System.Net.Http (>= 4.3.4)
- System.Net.Http.Json (>= 8.0.0)
-
net7.0
- NuGet.Versioning (>= 6.9.1)
- SocketIOClient (>= 3.1.1)
- SocketIOClient.Windows7 (>= 3.1.1)
- System.Net.Http (>= 4.3.4)
- System.Net.Http.Json (>= 8.0.0)
-
net7.0-windows7.0
- NuGet.Versioning (>= 6.9.1)
- SocketIOClient (>= 3.1.1)
- SocketIOClient.Windows7 (>= 3.1.1)
- System.Net.Http (>= 4.3.4)
- System.Net.Http.Json (>= 8.0.0)
-
net8.0
- NuGet.Versioning (>= 6.9.1)
- SocketIOClient (>= 3.1.1)
- SocketIOClient.Windows7 (>= 3.1.1)
- System.Net.Http (>= 4.3.4)
- System.Net.Http.Json (>= 8.0.0)
-
net8.0-windows7.0
- NuGet.Versioning (>= 6.9.1)
- SocketIOClient (>= 3.1.1)
- SocketIOClient.Windows7 (>= 3.1.1)
- System.Net.Http (>= 4.3.4)
- System.Net.Http.Json (>= 8.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.