ume05rw / MopidySharp

JSON-Rpc Library for Mopidy Music Server.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MopidySharp - Library for Mopidy Music Server

Implemented all methods on mopidy.core.
Connect by Http-Post/JSON-RPC, or WebSocket(limitted support).

Description

Supports .NET Standard2.0

Requirement

Newtonsoft.Json ver >= 12.0.3
System.Drawing.Common ver >= 5.0.0

Usage

  1. Add NuGet-Package to your project.
  2. Write Code Like:
// using Mopidy.Core;

Mopidy.Settings.ServerAddress = "Set your Mopidy IP-Address";
var res = await Tracklist.GetTlTracks();

if (res.Succeeded)
    foreach (var tlTrack in res.Result)
        System.Diagnostics.Debug.WriteLine(tlTrack.Track.Name);

Node:
The default setting is to connect by Http-Post.
In this case, Mopidy.Core.CoreListener does not work.
It is necessary to intentionally acquire and update the state by polling or other means.

Added limitted support for WebSocket on ver 1.1.0.

Retrieving event notifications is only available over WebSocket connections.

!! Warning !! : DO NOT USE this feature when you are connecting mopidy server directly to the Internet.

This feature requires that Csrf-Protection be disabled.
This setting is officially deprecated by mopidy.

Link: Mopidy-HTTP csrf_protection:

This config should only be disabled if you understand the security implications and require the HTTP server’s old behaviour.

How to get event notifications:

  1. Make sure that your mopidy server is NOT ACCESSIBLE from the Internet.
  2. Set the http/csrf_protection value to false in your mopidy.conf.
  3. Restart mopidy server.
  4. Write Code Like:
// using Mopidy.Core;

Mopidy.Settings.ServerAddress = "Set your Mopidy IP-Address";
Mopidy.Settings.ConnectionType = Mopidy.Settings.Connection.WebSocket;

CoreListener.TrackPlaybackStarted += (sender, ev) =>
{
    System.Diagnostics.Debug.WriteLine(ev.TlTrack.Track.Name);
};

await Playback.Play();

More Info

See Namespace.md

Licence

MIT Licence

Links

Mopidy Document Top:
https://docs.mopidy.com/en/latest/

Mopidy API:
https://docs.mopidy.com/en/latest/api/core/

About

JSON-Rpc Library for Mopidy Music Server.

License:MIT License


Languages

Language:C# 100.0%