First POC with working playback
Some checks failed
🏗️ Build Plugin / call (push) Failing after 0s
📝 Create/Update Release Draft & Release Bump PR / call (push) Failing after 0s
🔬 Run CodeQL / call (push) Failing after 0s
🧪 Test Plugin / call (push) Failing after 0s

This commit is contained in:
Duncan Tourolle 2025-12-13 23:54:33 +01:00
parent 7a9dbdafcc
commit 2f5a182afd
21 changed files with 2777 additions and 540 deletions

View File

@ -1,6 +1,6 @@
Microsoft Visual Studio Solution File, Format Version 12.00
#
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jellyfin.Plugin.Template", "Jellyfin.Plugin.Template\Jellyfin.Plugin.Template.csproj", "{D921B930-CF91-406F-ACBC-08914DCD0D34}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jellyfin.Plugin.JellyLMS", "Jellyfin.Plugin.JellyLMS\Jellyfin.Plugin.JellyLMS.csproj", "{D921B930-CF91-406F-ACBC-08914DCD0D34}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution

View File

@ -0,0 +1,352 @@
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Net.Mime;
using System.Threading.Tasks;
using Jellyfin.Plugin.JellyLMS.Models;
using Jellyfin.Plugin.JellyLMS.Services;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
namespace Jellyfin.Plugin.JellyLMS.Api;
/// <summary>
/// REST API controller for JellyLMS operations.
/// </summary>
[ApiController]
[Route("JellyLms")]
[Authorize]
[Produces(MediaTypeNames.Application.Json)]
public class JellyLmsController : ControllerBase
{
private readonly ILmsApiClient _lmsClient;
private readonly LmsPlayerManager _playerManager;
private readonly LmsSessionManager _sessionManager;
/// <summary>
/// Initializes a new instance of the <see cref="JellyLmsController"/> class.
/// </summary>
/// <param name="lmsClient">The LMS API client.</param>
/// <param name="playerManager">The player manager.</param>
/// <param name="sessionManager">The session manager.</param>
public JellyLmsController(
ILmsApiClient lmsClient,
LmsPlayerManager playerManager,
LmsSessionManager sessionManager)
{
_lmsClient = lmsClient;
_playerManager = playerManager;
_sessionManager = sessionManager;
}
/// <summary>
/// Tests the connection to the LMS server.
/// </summary>
/// <returns>The connection status.</returns>
[HttpPost("TestConnection")]
[ProducesResponseType(StatusCodes.Status200OK)]
public async Task<ActionResult<LmsServerStatus>> TestConnection()
{
var status = await _lmsClient.TestConnectionAsync().ConfigureAwait(false);
return Ok(status);
}
/// <summary>
/// Gets all LMS players.
/// </summary>
/// <param name="refresh">Force refresh from LMS.</param>
/// <returns>List of players.</returns>
[HttpGet("Players")]
[ProducesResponseType(StatusCodes.Status200OK)]
public async Task<ActionResult<List<LmsPlayer>>> GetPlayers([FromQuery] bool refresh = false)
{
var players = await _playerManager.GetPlayersAsync(refresh).ConfigureAwait(false);
return Ok(players);
}
/// <summary>
/// Gets a specific player by MAC address.
/// </summary>
/// <param name="mac">The player's MAC address.</param>
/// <returns>The player details.</returns>
[HttpGet("Players/{mac}")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task<ActionResult<LmsPlayer>> GetPlayer(string mac)
{
var player = await _playerManager.GetPlayerAsync(mac).ConfigureAwait(false);
if (player == null)
{
return NotFound();
}
return Ok(player);
}
/// <summary>
/// Powers on a player.
/// </summary>
/// <param name="mac">The player's MAC address.</param>
/// <returns>Success status.</returns>
[HttpPost("Players/{mac}/PowerOn")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<ActionResult> PowerOn(string mac)
{
var success = await _lmsClient.PowerOnAsync(mac).ConfigureAwait(false);
return success ? Ok() : BadRequest("Failed to power on player");
}
/// <summary>
/// Powers off a player.
/// </summary>
/// <param name="mac">The player's MAC address.</param>
/// <returns>Success status.</returns>
[HttpPost("Players/{mac}/PowerOff")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<ActionResult> PowerOff(string mac)
{
var success = await _lmsClient.PowerOffAsync(mac).ConfigureAwait(false);
return success ? Ok() : BadRequest("Failed to power off player");
}
/// <summary>
/// Sets the volume on a player.
/// </summary>
/// <param name="mac">The player's MAC address.</param>
/// <param name="request">The volume request.</param>
/// <returns>Success status.</returns>
[HttpPost("Players/{mac}/Volume")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<ActionResult> SetVolume(string mac, [FromBody] VolumeRequest request)
{
var success = await _lmsClient.SetVolumeAsync(mac, request.Volume).ConfigureAwait(false);
return success ? Ok() : BadRequest("Failed to set volume");
}
/// <summary>
/// Gets all sync groups.
/// </summary>
/// <returns>List of sync groups.</returns>
[HttpGet("SyncGroups")]
[ProducesResponseType(StatusCodes.Status200OK)]
public async Task<ActionResult<List<SyncGroup>>> GetSyncGroups()
{
var groups = await _playerManager.GetSyncGroupsAsync().ConfigureAwait(false);
return Ok(groups);
}
/// <summary>
/// Creates a sync group.
/// </summary>
/// <param name="request">The sync request.</param>
/// <returns>Success status.</returns>
[HttpPost("SyncGroups")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<ActionResult> CreateSyncGroup([FromBody] CreateSyncGroupRequest request)
{
var success = await _playerManager.CreateSyncGroupAsync(request.MasterMac, request.SlaveMacs)
.ConfigureAwait(false);
return success ? Ok() : BadRequest("Failed to create sync group");
}
/// <summary>
/// Removes a player from its sync group.
/// </summary>
/// <param name="mac">The player's MAC address.</param>
/// <returns>Success status.</returns>
[HttpDelete("SyncGroups/Players/{mac}")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<ActionResult> UnsyncPlayer(string mac)
{
var success = await _playerManager.UnsyncPlayerAsync(mac).ConfigureAwait(false);
return success ? Ok() : BadRequest("Failed to unsync player");
}
/// <summary>
/// Dissolves an entire sync group.
/// </summary>
/// <param name="masterMac">The master player's MAC address.</param>
/// <returns>Success status.</returns>
[HttpDelete("SyncGroups/{masterMac}")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<ActionResult> DissolveSyncGroup(string masterMac)
{
var success = await _playerManager.DissolveSyncGroupAsync(masterMac).ConfigureAwait(false);
return success ? Ok() : BadRequest("Failed to dissolve sync group");
}
/// <summary>
/// Gets all active playback sessions.
/// </summary>
/// <returns>List of active sessions.</returns>
[HttpGet("Sessions")]
[ProducesResponseType(StatusCodes.Status200OK)]
public ActionResult<List<LmsPlaybackSession>> GetSessions()
{
return Ok(_sessionManager.GetActiveSessions());
}
/// <summary>
/// Starts playback of a Jellyfin item on LMS players.
/// </summary>
/// <param name="request">The playback request.</param>
/// <returns>The created session.</returns>
[HttpPost("Sessions/Play")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<ActionResult<LmsPlaybackSession>> StartPlayback([FromBody] StartPlaybackRequest request)
{
var session = await _sessionManager.StartPlaybackAsync(request.ItemId, request.PlayerMacs, request.UserId)
.ConfigureAwait(false);
if (session == null)
{
return BadRequest("Failed to start playback");
}
return Ok(session);
}
/// <summary>
/// Pauses a playback session.
/// </summary>
/// <param name="sessionId">The session ID.</param>
/// <returns>Success status.</returns>
[HttpPost("Sessions/{sessionId}/Pause")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task<ActionResult> PauseSession(string sessionId)
{
var success = await _sessionManager.PauseSessionAsync(sessionId).ConfigureAwait(false);
return success ? Ok() : NotFound();
}
/// <summary>
/// Resumes a paused playback session.
/// </summary>
/// <param name="sessionId">The session ID.</param>
/// <returns>Success status.</returns>
[HttpPost("Sessions/{sessionId}/Resume")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task<ActionResult> ResumeSession(string sessionId)
{
var success = await _sessionManager.ResumeSessionAsync(sessionId).ConfigureAwait(false);
return success ? Ok() : NotFound();
}
/// <summary>
/// Stops a playback session.
/// </summary>
/// <param name="sessionId">The session ID.</param>
/// <returns>Success status.</returns>
[HttpPost("Sessions/{sessionId}/Stop")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task<ActionResult> StopSession(string sessionId)
{
var success = await _sessionManager.StopSessionAsync(sessionId).ConfigureAwait(false);
return success ? Ok() : NotFound();
}
/// <summary>
/// Seeks to a position in the playback session.
/// </summary>
/// <param name="sessionId">The session ID.</param>
/// <param name="request">The seek request.</param>
/// <returns>Success status.</returns>
[HttpPost("Sessions/{sessionId}/Seek")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task<ActionResult> SeekSession(string sessionId, [FromBody] SeekRequest request)
{
var success = await _sessionManager.SeekAsync(sessionId, request.PositionTicks).ConfigureAwait(false);
return success ? Ok() : NotFound();
}
/// <summary>
/// Sets the volume for all players in a session.
/// </summary>
/// <param name="sessionId">The session ID.</param>
/// <param name="request">The volume request.</param>
/// <returns>Success status.</returns>
[HttpPost("Sessions/{sessionId}/Volume")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task<ActionResult> SetSessionVolume(string sessionId, [FromBody] VolumeRequest request)
{
var success = await _sessionManager.SetVolumeAsync(sessionId, request.Volume).ConfigureAwait(false);
return success ? Ok() : NotFound();
}
}
/// <summary>
/// Request to set volume.
/// </summary>
public class VolumeRequest
{
/// <summary>
/// Gets or sets the volume level (0-100).
/// </summary>
[Range(0, 100)]
public int Volume { get; set; }
}
/// <summary>
/// Request to create a sync group.
/// </summary>
public class CreateSyncGroupRequest
{
/// <summary>
/// Gets or sets the master player MAC address.
/// </summary>
[Required]
public string MasterMac { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the slave player MAC addresses.
/// </summary>
[Required]
public List<string> SlaveMacs { get; set; } = [];
}
/// <summary>
/// Request to start playback.
/// </summary>
public class StartPlaybackRequest
{
/// <summary>
/// Gets or sets the Jellyfin item ID.
/// </summary>
[Required]
public Guid ItemId { get; set; }
/// <summary>
/// Gets or sets the LMS player MAC addresses.
/// </summary>
[Required]
public List<string> PlayerMacs { get; set; } = [];
/// <summary>
/// Gets or sets the optional user ID.
/// </summary>
public Guid? UserId { get; set; }
}
/// <summary>
/// Request to seek to a position.
/// </summary>
public class SeekRequest
{
/// <summary>
/// Gets or sets the position in ticks.
/// </summary>
public long PositionTicks { get; set; }
}

View File

@ -0,0 +1,65 @@
using MediaBrowser.Model.Plugins;
namespace Jellyfin.Plugin.JellyLMS.Configuration;
/// <summary>
/// Plugin configuration for JellyLMS.
/// </summary>
public class PluginConfiguration : BasePluginConfiguration
{
/// <summary>
/// Initializes a new instance of the <see cref="PluginConfiguration"/> class.
/// </summary>
public PluginConfiguration()
{
LmsServerUrl = "http://localhost:9000";
LmsUsername = string.Empty;
LmsPassword = string.Empty;
JellyfinServerUrl = "http://localhost:8096";
ConnectionTimeoutSeconds = 10;
EnableAutoSync = true;
DefaultPlayerMac = string.Empty;
}
/// <summary>
/// Gets or sets the LMS server URL (e.g., http://192.168.1.100:9000).
/// </summary>
public string LmsServerUrl { get; set; }
/// <summary>
/// Gets or sets the LMS username (if authentication is enabled).
/// </summary>
public string LmsUsername { get; set; }
/// <summary>
/// Gets or sets the LMS password (if authentication is enabled).
/// </summary>
public string LmsPassword { get; set; }
/// <summary>
/// Gets or sets the Jellyfin server URL that LMS will use to stream audio.
/// This should be accessible from the LMS server.
/// </summary>
public string JellyfinServerUrl { get; set; }
/// <summary>
/// Gets or sets the connection timeout in seconds.
/// </summary>
public int ConnectionTimeoutSeconds { get; set; }
/// <summary>
/// Gets or sets a value indicating whether to automatically sync players
/// when playing to multiple devices.
/// </summary>
public bool EnableAutoSync { get; set; }
/// <summary>
/// Gets or sets the default player MAC address to use when none is specified.
/// </summary>
public string DefaultPlayerMac { get; set; }
/// <summary>
/// Gets or sets the Jellyfin API key for authenticating stream requests from LMS.
/// </summary>
public string JellyfinApiKey { get; set; } = string.Empty;
}

View File

@ -0,0 +1,241 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JellyLMS</title>
</head>
<body>
<div id="JellyLmsConfigPage" data-role="page" class="page type-interior pluginConfigurationPage" data-require="emby-input,emby-button,emby-select,emby-checkbox">
<div data-role="content">
<div class="content-primary">
<h2>JellyLMS Configuration</h2>
<p>Configure the connection between Jellyfin and Logitech Media Server (LMS) for multi-room audio playback.</p>
<form id="JellyLmsConfigForm">
<div class="verticalSection">
<h3>LMS Server Settings</h3>
<div class="inputContainer">
<label class="inputLabel inputLabelUnfocused" for="LmsServerUrl">LMS Server URL</label>
<input id="LmsServerUrl" name="LmsServerUrl" type="url" is="emby-input" />
<div class="fieldDescription">The URL of your LMS server (e.g., http://192.168.1.100:9000)</div>
</div>
<div class="inputContainer">
<label class="inputLabel inputLabelUnfocused" for="LmsUsername">LMS Username (optional)</label>
<input id="LmsUsername" name="LmsUsername" type="text" is="emby-input" />
<div class="fieldDescription">Username if LMS authentication is enabled</div>
</div>
<div class="inputContainer">
<label class="inputLabel inputLabelUnfocused" for="LmsPassword">LMS Password (optional)</label>
<input id="LmsPassword" name="LmsPassword" type="password" is="emby-input" />
<div class="fieldDescription">Password if LMS authentication is enabled</div>
</div>
<div>
<button is="emby-button" type="button" id="btnTestConnection" class="raised button-alt block emby-button">
<span>Test Connection</span>
</button>
<div id="connectionStatus" style="margin-top: 10px;"></div>
</div>
</div>
<div class="verticalSection">
<h3>Jellyfin Server Settings</h3>
<div class="inputContainer">
<label class="inputLabel inputLabelUnfocused" for="JellyfinServerUrl">Jellyfin Server URL</label>
<input id="JellyfinServerUrl" name="JellyfinServerUrl" type="url" is="emby-input" />
<div class="fieldDescription">The URL that LMS will use to stream audio from Jellyfin. This must be accessible from the LMS server (e.g., http://192.168.1.4:8096).</div>
</div>
<div class="inputContainer">
<label class="inputLabel inputLabelUnfocused" for="JellyfinApiKey">Jellyfin API Key</label>
<input id="JellyfinApiKey" name="JellyfinApiKey" type="password" is="emby-input" />
<div class="fieldDescription">API key for LMS to authenticate with Jellyfin. Create one in Dashboard > API Keys.</div>
</div>
</div>
<div class="verticalSection">
<h3>Playback Settings</h3>
<div class="inputContainer">
<label class="inputLabel inputLabelUnfocused" for="ConnectionTimeoutSeconds">Connection Timeout (seconds)</label>
<input id="ConnectionTimeoutSeconds" name="ConnectionTimeoutSeconds" type="number" is="emby-input" min="5" max="60" />
<div class="fieldDescription">Timeout for LMS API requests</div>
</div>
<div class="checkboxContainer checkboxContainer-withDescription">
<label class="emby-checkbox-label">
<input id="EnableAutoSync" name="EnableAutoSync" type="checkbox" is="emby-checkbox" />
<span>Enable Auto-Sync</span>
</label>
<div class="fieldDescription checkboxFieldDescription">Automatically sync players when playing to multiple devices</div>
</div>
</div>
<div class="verticalSection">
<h3>LMS Players</h3>
<div id="playersList">
<p>Click "Refresh Players" to discover LMS players.</p>
</div>
<div>
<button is="emby-button" type="button" id="btnRefreshPlayers" class="raised button-alt block emby-button">
<span>Refresh Players</span>
</button>
</div>
<div class="inputContainer" style="margin-top: 15px;">
<label class="inputLabel inputLabelUnfocused" for="DefaultPlayerMac">Default Player</label>
<select is="emby-select" id="DefaultPlayerMac" name="DefaultPlayerMac" class="emby-select-withcolor emby-select">
<option value="">None</option>
</select>
<div class="fieldDescription">Default player to use when none is specified</div>
</div>
</div>
<div>
<button is="emby-button" type="submit" class="raised button-submit block emby-button">
<span>Save</span>
</button>
</div>
</form>
</div>
</div>
<script type="text/javascript">
var JellyLmsConfig = {
pluginUniqueId: 'a5b8c9d0-1e2f-3a4b-5c6d-7e8f9a0b1c2d'
};
function loadPlayers() {
var playersList = document.querySelector('#playersList');
var defaultSelect = document.querySelector('#DefaultPlayerMac');
var currentDefault = defaultSelect.value;
playersList.innerHTML = '<p>Loading players...</p>';
ApiClient.ajax({
url: ApiClient.getUrl('JellyLms/Players', { refresh: true }),
type: 'GET',
dataType: 'json'
}).then(function(players) {
defaultSelect.innerHTML = '<option value="">None</option>';
if (!players || players.length === 0) {
playersList.innerHTML = '<p>No players found. Make sure LMS is running and has connected players.</p>';
return;
}
var html = '<table class="tblGenres detailTable" style="width: 100%;">';
html += '<thead><tr><th>Name</th><th>Model</th><th>Status</th><th>Volume</th><th>Synced</th></tr></thead>';
html += '<tbody>';
players.forEach(function(player) {
var status = player.IsConnected ? (player.IsPoweredOn ? 'On' : 'Standby') : 'Disconnected';
var statusColor = player.IsConnected ? (player.IsPoweredOn ? 'green' : 'orange') : 'red';
var syncStatus = player.IsSynced ? 'Yes' : 'No';
html += '<tr>';
html += '<td>' + player.Name + '</td>';
html += '<td>' + player.Model + '</td>';
html += '<td style="color: ' + statusColor + ';">' + status + '</td>';
html += '<td>' + player.Volume + '%</td>';
html += '<td>' + syncStatus + '</td>';
html += '</tr>';
var option = document.createElement('option');
option.value = player.MacAddress;
option.text = player.Name;
if (player.MacAddress === currentDefault) {
option.selected = true;
}
defaultSelect.appendChild(option);
});
html += '</tbody></table>';
playersList.innerHTML = html;
}).catch(function(err) {
playersList.innerHTML = '<p style="color: red;">Error loading players. Check LMS connection.</p>';
console.error('Error loading players:', err);
});
}
function testConnection() {
var statusDiv = document.querySelector('#connectionStatus');
statusDiv.innerHTML = '<span style="color: orange;">Testing connection...</span>';
ApiClient.ajax({
url: ApiClient.getUrl('JellyLms/TestConnection'),
type: 'POST',
dataType: 'json'
}).then(function(result) {
if (result.IsConnected) {
statusDiv.innerHTML = '<span style="color: green;">Connected! Found ' + result.PlayerCount + ' player(s).</span>';
loadPlayers();
} else {
statusDiv.innerHTML = '<span style="color: red;">Connection failed: ' + (result.LastError || 'Unknown error') + '</span>';
}
}).catch(function(err) {
statusDiv.innerHTML = '<span style="color: red;">Connection failed. Check the server URL.</span>';
console.error('Connection test failed:', err);
});
}
document.querySelector('#JellyLmsConfigPage')
.addEventListener('pageshow', function() {
Dashboard.showLoadingMsg();
ApiClient.getPluginConfiguration(JellyLmsConfig.pluginUniqueId).then(function (config) {
document.querySelector('#LmsServerUrl').value = config.LmsServerUrl || 'http://localhost:9000';
document.querySelector('#LmsUsername').value = config.LmsUsername || '';
document.querySelector('#LmsPassword').value = config.LmsPassword || '';
document.querySelector('#JellyfinServerUrl').value = config.JellyfinServerUrl || 'http://localhost:8096';
document.querySelector('#JellyfinApiKey').value = config.JellyfinApiKey || '';
document.querySelector('#ConnectionTimeoutSeconds').value = config.ConnectionTimeoutSeconds || 10;
document.querySelector('#EnableAutoSync').checked = config.EnableAutoSync !== false;
document.querySelector('#DefaultPlayerMac').value = config.DefaultPlayerMac || '';
Dashboard.hideLoadingMsg();
});
});
document.querySelector('#btnTestConnection')
.addEventListener('click', function() {
ApiClient.getPluginConfiguration(JellyLmsConfig.pluginUniqueId).then(function (config) {
config.LmsServerUrl = document.querySelector('#LmsServerUrl').value;
config.LmsUsername = document.querySelector('#LmsUsername').value;
config.LmsPassword = document.querySelector('#LmsPassword').value;
ApiClient.updatePluginConfiguration(JellyLmsConfig.pluginUniqueId, config).then(function() {
testConnection();
});
});
});
document.querySelector('#btnRefreshPlayers')
.addEventListener('click', function() {
loadPlayers();
});
document.querySelector('#JellyLmsConfigForm')
.addEventListener('submit', function(e) {
Dashboard.showLoadingMsg();
ApiClient.getPluginConfiguration(JellyLmsConfig.pluginUniqueId).then(function (config) {
config.LmsServerUrl = document.querySelector('#LmsServerUrl').value;
config.LmsUsername = document.querySelector('#LmsUsername').value;
config.LmsPassword = document.querySelector('#LmsPassword').value;
config.JellyfinServerUrl = document.querySelector('#JellyfinServerUrl').value;
config.JellyfinApiKey = document.querySelector('#JellyfinApiKey').value;
config.ConnectionTimeoutSeconds = parseInt(document.querySelector('#ConnectionTimeoutSeconds').value) || 10;
config.EnableAutoSync = document.querySelector('#EnableAutoSync').checked;
config.DefaultPlayerMac = document.querySelector('#DefaultPlayerMac').value;
ApiClient.updatePluginConfiguration(JellyLmsConfig.pluginUniqueId, config).then(function (result) {
Dashboard.processPluginConfigurationUpdateResult(result);
});
});
e.preventDefault();
return false;
});
</script>
</div>
</body>
</html>

View File

@ -2,7 +2,7 @@
<PropertyGroup>
<TargetFramework>net9.0</TargetFramework>
<RootNamespace>Jellyfin.Plugin.Template</RootNamespace>
<RootNamespace>Jellyfin.Plugin.JellyLMS</RootNamespace>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<Nullable>enable</Nullable>
@ -11,10 +11,10 @@
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Jellyfin.Controller" Version="10.9.11" >
<PackageReference Include="Jellyfin.Controller" Version="10.11.0" >
<ExcludeAssets>runtime</ExcludeAssets>
</PackageReference>
<PackageReference Include="Jellyfin.Model" Version="10.9.11">
<PackageReference Include="Jellyfin.Model" Version="10.11.0">
<ExcludeAssets>runtime</ExcludeAssets>
</PackageReference>
</ItemGroup>

View File

@ -0,0 +1,254 @@
using System.Collections.Generic;
using System.Text.Json.Serialization;
namespace Jellyfin.Plugin.JellyLMS.Models;
/// <summary>
/// JSON-RPC request for LMS API.
/// </summary>
public class LmsJsonRpcRequest
{
/// <summary>
/// Gets or sets the request ID.
/// </summary>
[JsonPropertyName("id")]
public int Id { get; set; } = 1;
/// <summary>
/// Gets or sets the method name (always "slim.request").
/// </summary>
[JsonPropertyName("method")]
public string Method { get; set; } = "slim.request";
/// <summary>
/// Gets or sets the parameters [playerMac, [command, args...]].
/// </summary>
[JsonPropertyName("params")]
public object[] Params { get; set; } = [];
}
/// <summary>
/// JSON-RPC response from LMS API.
/// </summary>
/// <typeparam name="T">The result type.</typeparam>
public class LmsJsonRpcResponse<T>
{
/// <summary>
/// Gets or sets the request ID.
/// </summary>
[JsonPropertyName("id")]
public int Id { get; set; }
/// <summary>
/// Gets or sets the result data.
/// </summary>
[JsonPropertyName("result")]
public T? Result { get; set; }
/// <summary>
/// Gets or sets any error message.
/// </summary>
[JsonPropertyName("error")]
public string? Error { get; set; }
}
/// <summary>
/// Player count response.
/// </summary>
public class PlayerCountResult
{
/// <summary>
/// Gets or sets the count value.
/// </summary>
[JsonPropertyName("_count")]
public int Count { get; set; }
}
/// <summary>
/// Players list response.
/// </summary>
public class PlayersListResult
{
/// <summary>
/// Gets or sets the player count.
/// </summary>
[JsonPropertyName("count")]
public int Count { get; set; }
/// <summary>
/// Gets or sets the list of players.
/// </summary>
[JsonPropertyName("players_loop")]
public List<LmsPlayerInfo> Players { get; set; } = [];
}
/// <summary>
/// Player info from LMS API.
/// </summary>
public class LmsPlayerInfo
{
/// <summary>
/// Gets or sets the player name.
/// </summary>
[JsonPropertyName("name")]
public string Name { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the player ID (MAC address).
/// </summary>
[JsonPropertyName("playerid")]
public string PlayerId { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the player IP address.
/// </summary>
[JsonPropertyName("ip")]
public string Ip { get; set; } = string.Empty;
/// <summary>
/// Gets or sets whether the player is connected.
/// </summary>
[JsonPropertyName("connected")]
public int Connected { get; set; }
/// <summary>
/// Gets or sets the power state.
/// </summary>
[JsonPropertyName("power")]
public int Power { get; set; }
/// <summary>
/// Gets or sets the player model.
/// </summary>
[JsonPropertyName("model")]
public string Model { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the player model name.
/// </summary>
[JsonPropertyName("modelname")]
public string ModelName { get; set; } = string.Empty;
}
/// <summary>
/// Player status response.
/// </summary>
public class PlayerStatusResult
{
/// <summary>
/// Gets or sets the player name.
/// </summary>
[JsonPropertyName("player_name")]
public string PlayerName { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the player connected state.
/// </summary>
[JsonPropertyName("player_connected")]
public int PlayerConnected { get; set; }
/// <summary>
/// Gets or sets the power state.
/// </summary>
[JsonPropertyName("power")]
public int Power { get; set; }
/// <summary>
/// Gets or sets the playback mode (play, pause, stop).
/// </summary>
[JsonPropertyName("mode")]
public string Mode { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the current time position in seconds.
/// </summary>
[JsonPropertyName("time")]
public double Time { get; set; }
/// <summary>
/// Gets or sets the mixer volume (0-100).
/// </summary>
[JsonPropertyName("mixer volume")]
public int Volume { get; set; }
/// <summary>
/// Gets or sets the total duration in seconds.
/// </summary>
[JsonPropertyName("duration")]
public double Duration { get; set; }
/// <summary>
/// Gets or sets the sync master MAC address.
/// </summary>
[JsonPropertyName("sync_master")]
public string? SyncMaster { get; set; }
/// <summary>
/// Gets or sets the list of synced player MACs.
/// </summary>
[JsonPropertyName("sync_slaves")]
public string? SyncSlaves { get; set; }
/// <summary>
/// Gets or sets the current track title.
/// </summary>
[JsonPropertyName("current_title")]
public string? CurrentTitle { get; set; }
}
/// <summary>
/// LMS server status.
/// </summary>
public class LmsServerStatus
{
/// <summary>
/// Gets or sets the server version.
/// </summary>
public string Version { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the player count.
/// </summary>
public int PlayerCount { get; set; }
/// <summary>
/// Gets or sets whether the server is reachable.
/// </summary>
public bool IsConnected { get; set; }
/// <summary>
/// Gets or sets the last error message.
/// </summary>
public string? LastError { get; set; }
}
/// <summary>
/// Sync group information.
/// </summary>
public class SyncGroup
{
/// <summary>
/// Gets or sets the master player MAC address.
/// </summary>
public string MasterMac { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the master player name.
/// </summary>
public string MasterName { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the slave player MAC addresses.
/// </summary>
public List<string> SlaveMacs { get; set; } = [];
/// <summary>
/// Gets or sets the slave player names.
/// </summary>
public List<string> SlaveNames { get; set; } = [];
/// <summary>
/// Gets the total number of players in this sync group.
/// </summary>
public int PlayerCount => 1 + SlaveMacs.Count;
}

View File

@ -0,0 +1,96 @@
using System;
using System.Collections.Generic;
namespace Jellyfin.Plugin.JellyLMS.Models;
/// <summary>
/// Represents the current playback state.
/// </summary>
public enum PlaybackState
{
/// <summary>
/// Playback is stopped.
/// </summary>
Stopped,
/// <summary>
/// Playback is active.
/// </summary>
Playing,
/// <summary>
/// Playback is paused.
/// </summary>
Paused
}
/// <summary>
/// Represents an active playback session bridging Jellyfin to LMS.
/// </summary>
public class LmsPlaybackSession
{
/// <summary>
/// Gets or sets the unique session identifier.
/// </summary>
public string SessionId { get; set; } = Guid.NewGuid().ToString();
/// <summary>
/// Gets or sets the Jellyfin session ID.
/// </summary>
public string? JellyfinSessionId { get; set; }
/// <summary>
/// Gets or sets the Jellyfin item ID being played.
/// </summary>
public Guid ItemId { get; set; }
/// <summary>
/// Gets or sets the item name for display.
/// </summary>
public string ItemName { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the artist name (for audio).
/// </summary>
public string? Artist { get; set; }
/// <summary>
/// Gets or sets the album name (for audio).
/// </summary>
public string? Album { get; set; }
/// <summary>
/// Gets or sets the MAC addresses of LMS players in this session.
/// </summary>
public List<string> PlayerMacs { get; set; } = [];
/// <summary>
/// Gets or sets the current playback state.
/// </summary>
public PlaybackState State { get; set; } = PlaybackState.Stopped;
/// <summary>
/// Gets or sets the current playback position in ticks.
/// </summary>
public long PositionTicks { get; set; }
/// <summary>
/// Gets or sets the total runtime in ticks.
/// </summary>
public long RuntimeTicks { get; set; }
/// <summary>
/// Gets or sets when this session started.
/// </summary>
public DateTime StartedAt { get; set; } = DateTime.UtcNow;
/// <summary>
/// Gets or sets the audio stream URL being played on LMS.
/// </summary>
public string? StreamUrl { get; set; }
/// <summary>
/// Gets or sets the Jellyfin user ID who initiated playback.
/// </summary>
public Guid? UserId { get; set; }
}

View File

@ -0,0 +1,59 @@
using System.Collections.Generic;
namespace Jellyfin.Plugin.JellyLMS.Models;
/// <summary>
/// Represents an LMS player/zone.
/// </summary>
public class LmsPlayer
{
/// <summary>
/// Gets or sets the player's display name.
/// </summary>
public string Name { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the player's MAC address (unique identifier).
/// </summary>
public string MacAddress { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the player's IP address.
/// </summary>
public string IpAddress { get; set; } = string.Empty;
/// <summary>
/// Gets or sets a value indicating whether the player is connected to LMS.
/// </summary>
public bool IsConnected { get; set; }
/// <summary>
/// Gets or sets a value indicating whether the player is powered on.
/// </summary>
public bool IsPoweredOn { get; set; }
/// <summary>
/// Gets or sets the player's current volume (0-100).
/// </summary>
public int Volume { get; set; }
/// <summary>
/// Gets or sets the player model name.
/// </summary>
public string Model { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the MAC address of the sync master, if this player is synced.
/// </summary>
public string? SyncMaster { get; set; }
/// <summary>
/// Gets or sets the list of synced player MAC addresses (if this is a sync master).
/// </summary>
public List<string> SyncSlaves { get; set; } = [];
/// <summary>
/// Gets a value indicating whether this player is part of a sync group.
/// </summary>
public bool IsSynced => !string.IsNullOrEmpty(SyncMaster) || SyncSlaves.Count > 0;
}

View File

@ -1,16 +1,17 @@
using System;
using System.Collections.Generic;
using System.Globalization;
using Jellyfin.Plugin.Template.Configuration;
using Jellyfin.Plugin.JellyLMS.Configuration;
using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.Plugins;
using MediaBrowser.Model.Plugins;
using MediaBrowser.Model.Serialization;
namespace Jellyfin.Plugin.Template;
namespace Jellyfin.Plugin.JellyLMS;
/// <summary>
/// The main plugin.
/// The main JellyLMS plugin class.
/// Bridges Jellyfin audio playback to LMS for multi-room synchronized playback.
/// </summary>
public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
{
@ -26,10 +27,13 @@ public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
}
/// <inheritdoc />
public override string Name => "Template";
public override string Name => "JellyLMS";
/// <inheritdoc />
public override Guid Id => Guid.Parse("eb5d7894-8eef-4b36-aa6f-5d124e828ce1");
public override Guid Id => Guid.Parse("a5b8c9d0-1e2f-3a4b-5c6d-7e8f9a0b1c2d");
/// <inheritdoc />
public override string Description => "Stream Jellyfin audio to Logitech Media Server (LMS) for multi-room playback";
/// <summary>
/// Gets the current plugin instance.

View File

@ -0,0 +1,25 @@
using Jellyfin.Plugin.JellyLMS.Services;
using MediaBrowser.Controller;
using MediaBrowser.Controller.Plugins;
using Microsoft.Extensions.DependencyInjection;
namespace Jellyfin.Plugin.JellyLMS;
/// <summary>
/// Registers plugin services with Jellyfin's DI container.
/// </summary>
public class PluginServiceRegistrator : IPluginServiceRegistrator
{
/// <inheritdoc />
public void RegisterServices(IServiceCollection serviceCollection, IServerApplicationHost applicationHost)
{
serviceCollection.AddSingleton<ILmsApiClient, LmsApiClient>();
serviceCollection.AddSingleton<LmsPlayerManager>();
serviceCollection.AddSingleton<LmsSessionManager>();
serviceCollection.AddHostedService(sp => sp.GetRequiredService<LmsSessionManager>());
// Device discovery service - registers LMS players as Jellyfin sessions for casting
// Use AddHostedService directly to let DI handle construction
serviceCollection.AddHostedService<LmsDeviceDiscoveryService>();
}
}

View File

@ -0,0 +1,112 @@
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Jellyfin.Plugin.JellyLMS.Models;
namespace Jellyfin.Plugin.JellyLMS.Services;
/// <summary>
/// Interface for LMS JSON-RPC API communication.
/// </summary>
public interface ILmsApiClient
{
/// <summary>
/// Tests the connection to the LMS server.
/// </summary>
/// <returns>Server status with connection result.</returns>
Task<LmsServerStatus> TestConnectionAsync();
/// <summary>
/// Gets all players connected to LMS.
/// </summary>
/// <returns>List of LMS players.</returns>
Task<List<LmsPlayer>> GetPlayersAsync();
/// <summary>
/// Gets the status of a specific player.
/// </summary>
/// <param name="playerMac">The player's MAC address.</param>
/// <returns>The player status.</returns>
Task<PlayerStatusResult?> GetPlayerStatusAsync(string playerMac);
/// <summary>
/// Plays a URL on the specified player.
/// </summary>
/// <param name="playerMac">The player's MAC address.</param>
/// <param name="url">The audio URL to play.</param>
/// <param name="title">Optional title for display.</param>
/// <returns>True if successful.</returns>
Task<bool> PlayUrlAsync(string playerMac, string url, string? title = null);
/// <summary>
/// Pauses playback on the specified player.
/// </summary>
/// <param name="playerMac">The player's MAC address.</param>
/// <returns>True if successful.</returns>
Task<bool> PauseAsync(string playerMac);
/// <summary>
/// Resumes playback on the specified player.
/// </summary>
/// <param name="playerMac">The player's MAC address.</param>
/// <returns>True if successful.</returns>
Task<bool> PlayAsync(string playerMac);
/// <summary>
/// Stops playback on the specified player.
/// </summary>
/// <param name="playerMac">The player's MAC address.</param>
/// <returns>True if successful.</returns>
Task<bool> StopAsync(string playerMac);
/// <summary>
/// Sets the volume on the specified player.
/// </summary>
/// <param name="playerMac">The player's MAC address.</param>
/// <param name="volume">Volume level (0-100).</param>
/// <returns>True if successful.</returns>
Task<bool> SetVolumeAsync(string playerMac, int volume);
/// <summary>
/// Seeks to a position on the specified player.
/// </summary>
/// <param name="playerMac">The player's MAC address.</param>
/// <param name="positionSeconds">Position in seconds.</param>
/// <returns>True if successful.</returns>
Task<bool> SeekAsync(string playerMac, double positionSeconds);
/// <summary>
/// Powers on the specified player.
/// </summary>
/// <param name="playerMac">The player's MAC address.</param>
/// <returns>True if successful.</returns>
Task<bool> PowerOnAsync(string playerMac);
/// <summary>
/// Powers off the specified player.
/// </summary>
/// <param name="playerMac">The player's MAC address.</param>
/// <returns>True if successful.</returns>
Task<bool> PowerOffAsync(string playerMac);
/// <summary>
/// Syncs a slave player to a master player.
/// </summary>
/// <param name="masterMac">The master player's MAC address.</param>
/// <param name="slaveMac">The slave player's MAC address.</param>
/// <returns>True if successful.</returns>
Task<bool> SyncPlayerAsync(string masterMac, string slaveMac);
/// <summary>
/// Removes a player from its sync group.
/// </summary>
/// <param name="playerMac">The player's MAC address.</param>
/// <returns>True if successful.</returns>
Task<bool> UnsyncPlayerAsync(string playerMac);
/// <summary>
/// Gets all current sync groups.
/// </summary>
/// <returns>List of sync groups.</returns>
Task<List<SyncGroup>> GetSyncGroupsAsync();
}

View File

@ -0,0 +1,382 @@
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Net.Http;
using System.Net.Http.Json;
using System.Text.Json;
using System.Threading.Tasks;
using Jellyfin.Plugin.JellyLMS.Configuration;
using Jellyfin.Plugin.JellyLMS.Models;
using Microsoft.Extensions.Logging;
namespace Jellyfin.Plugin.JellyLMS.Services;
/// <summary>
/// HTTP client for LMS JSON-RPC API communication.
/// </summary>
public class LmsApiClient : ILmsApiClient, IDisposable
{
private readonly ILogger<LmsApiClient> _logger;
private readonly HttpClient _httpClient;
private bool _disposed;
/// <summary>
/// Initializes a new instance of the <see cref="LmsApiClient"/> class.
/// </summary>
/// <param name="logger">The logger instance.</param>
public LmsApiClient(ILogger<LmsApiClient> logger)
{
_logger = logger;
_httpClient = new HttpClient();
}
private PluginConfiguration Config => Plugin.Instance?.Configuration ?? new PluginConfiguration();
private string JsonRpcEndpoint => $"{Config.LmsServerUrl.TrimEnd('/')}/jsonrpc.js";
/// <inheritdoc />
public async Task<LmsServerStatus> TestConnectionAsync()
{
var status = new LmsServerStatus();
try
{
var result = await SendCommandAsync<PlayersListResult>("-", ["players", "0", "1"]).ConfigureAwait(false);
status.IsConnected = result != null;
status.PlayerCount = result?.Count ?? 0;
status.Version = "Connected";
}
catch (Exception ex)
{
status.IsConnected = false;
status.LastError = ex.Message;
_logger.LogError(ex, "Failed to connect to LMS at {Endpoint}", JsonRpcEndpoint);
}
return status;
}
/// <inheritdoc />
public async Task<List<LmsPlayer>> GetPlayersAsync()
{
var players = new List<LmsPlayer>();
try
{
// First get player count
var countResult = await SendCommandAsync<PlayerCountResult>("-", ["player", "count", "?"]).ConfigureAwait(false);
var count = countResult?.Count ?? 0;
if (count == 0)
{
return players;
}
// Then get player list
var listResult = await SendCommandAsync<PlayersListResult>("-", ["players", "0", count.ToString(CultureInfo.InvariantCulture)]).ConfigureAwait(false);
if (listResult?.Players == null)
{
return players;
}
foreach (var p in listResult.Players)
{
var player = new LmsPlayer
{
Name = p.Name,
MacAddress = p.PlayerId,
IpAddress = p.Ip.Split(':')[0], // Remove port if present
IsConnected = p.Connected == 1,
IsPoweredOn = p.Power == 1,
Model = p.ModelName
};
// Get additional status for sync info
var status = await GetPlayerStatusAsync(p.PlayerId).ConfigureAwait(false);
if (status != null)
{
player.Volume = status.Volume;
player.SyncMaster = status.SyncMaster;
if (!string.IsNullOrEmpty(status.SyncSlaves))
{
player.SyncSlaves = status.SyncSlaves.Split(',').ToList();
}
}
players.Add(player);
}
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to get players from LMS");
}
return players;
}
/// <inheritdoc />
public async Task<PlayerStatusResult?> GetPlayerStatusAsync(string playerMac)
{
try
{
return await SendCommandAsync<PlayerStatusResult>(playerMac, ["status", "-", "1", "tags:"])
.ConfigureAwait(false);
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to get status for player {Mac}", playerMac);
return null;
}
}
/// <inheritdoc />
public async Task<bool> PlayUrlAsync(string playerMac, string url, string? title = null)
{
try
{
// First clear the playlist and add the URL
await SendCommandAsync<object>(playerMac, ["playlist", "clear"]).ConfigureAwait(false);
await SendCommandAsync<object>(playerMac, ["playlist", "add", url]).ConfigureAwait(false);
// Set title if provided
if (!string.IsNullOrEmpty(title))
{
await SendCommandAsync<object>(playerMac, ["playlist", "title", title]).ConfigureAwait(false);
}
// Start playback
await SendCommandAsync<object>(playerMac, ["play"]).ConfigureAwait(false);
_logger.LogInformation("Started playback of {Url} on player {Mac}", url, playerMac);
return true;
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to play URL on player {Mac}", playerMac);
return false;
}
}
/// <inheritdoc />
public async Task<bool> PauseAsync(string playerMac)
{
try
{
await SendCommandAsync<object>(playerMac, ["pause", "1"]).ConfigureAwait(false);
return true;
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to pause player {Mac}", playerMac);
return false;
}
}
/// <inheritdoc />
public async Task<bool> PlayAsync(string playerMac)
{
try
{
await SendCommandAsync<object>(playerMac, ["play"]).ConfigureAwait(false);
return true;
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to resume player {Mac}", playerMac);
return false;
}
}
/// <inheritdoc />
public async Task<bool> StopAsync(string playerMac)
{
try
{
await SendCommandAsync<object>(playerMac, ["stop"]).ConfigureAwait(false);
return true;
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to stop player {Mac}", playerMac);
return false;
}
}
/// <inheritdoc />
public async Task<bool> SetVolumeAsync(string playerMac, int volume)
{
try
{
volume = Math.Clamp(volume, 0, 100);
await SendCommandAsync<object>(playerMac, ["mixer", "volume", volume.ToString(CultureInfo.InvariantCulture)])
.ConfigureAwait(false);
return true;
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to set volume on player {Mac}", playerMac);
return false;
}
}
/// <inheritdoc />
public async Task<bool> SeekAsync(string playerMac, double positionSeconds)
{
try
{
await SendCommandAsync<object>(playerMac, ["time", positionSeconds.ToString("F1", CultureInfo.InvariantCulture)])
.ConfigureAwait(false);
return true;
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to seek on player {Mac}", playerMac);
return false;
}
}
/// <inheritdoc />
public async Task<bool> PowerOnAsync(string playerMac)
{
try
{
await SendCommandAsync<object>(playerMac, ["power", "1"]).ConfigureAwait(false);
return true;
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to power on player {Mac}", playerMac);
return false;
}
}
/// <inheritdoc />
public async Task<bool> PowerOffAsync(string playerMac)
{
try
{
await SendCommandAsync<object>(playerMac, ["power", "0"]).ConfigureAwait(false);
return true;
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to power off player {Mac}", playerMac);
return false;
}
}
/// <inheritdoc />
public async Task<bool> SyncPlayerAsync(string masterMac, string slaveMac)
{
try
{
await SendCommandAsync<object>(masterMac, ["sync", slaveMac]).ConfigureAwait(false);
_logger.LogInformation("Synced player {Slave} to master {Master}", slaveMac, masterMac);
return true;
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to sync player {Slave} to {Master}", slaveMac, masterMac);
return false;
}
}
/// <inheritdoc />
public async Task<bool> UnsyncPlayerAsync(string playerMac)
{
try
{
await SendCommandAsync<object>(playerMac, ["sync", "-"]).ConfigureAwait(false);
_logger.LogInformation("Unsynced player {Mac}", playerMac);
return true;
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to unsync player {Mac}", playerMac);
return false;
}
}
/// <inheritdoc />
public async Task<List<SyncGroup>> GetSyncGroupsAsync()
{
var groups = new List<SyncGroup>();
var players = await GetPlayersAsync().ConfigureAwait(false);
// Find all masters (players with slaves)
var masters = players.Where(p => p.SyncSlaves.Count > 0).ToList();
foreach (var master in masters)
{
var group = new SyncGroup
{
MasterMac = master.MacAddress,
MasterName = master.Name,
SlaveMacs = master.SyncSlaves
};
// Resolve slave names
foreach (var slaveMac in master.SyncSlaves)
{
var slave = players.FirstOrDefault(p => p.MacAddress == slaveMac);
if (slave != null)
{
group.SlaveNames.Add(slave.Name);
}
}
groups.Add(group);
}
return groups;
}
private async Task<T?> SendCommandAsync<T>(string playerMac, string[] command)
{
var request = new LmsJsonRpcRequest
{
Params = [playerMac, command]
};
var response = await _httpClient.PostAsJsonAsync(JsonRpcEndpoint, request).ConfigureAwait(false);
response.EnsureSuccessStatusCode();
var content = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
var result = JsonSerializer.Deserialize<LmsJsonRpcResponse<T>>(content);
if (!string.IsNullOrEmpty(result?.Error))
{
throw new InvalidOperationException($"LMS API error: {result.Error}");
}
return result != null ? result.Result : default;
}
/// <inheritdoc />
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
/// <summary>
/// Disposes managed resources.
/// </summary>
/// <param name="disposing">Whether to dispose managed resources.</param>
protected virtual void Dispose(bool disposing)
{
if (_disposed)
{
return;
}
if (disposing)
{
_httpClient.Dispose();
}
_disposed = true;
}
}

View File

@ -0,0 +1,249 @@
using System;
using System.Collections.Concurrent;
using System.Threading;
using System.Threading.Tasks;
using Jellyfin.Data.Enums;
using Jellyfin.Plugin.JellyLMS.Models;
using MediaBrowser.Controller.Session;
using MediaBrowser.Model.Session;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
namespace Jellyfin.Plugin.JellyLMS.Services;
/// <summary>
/// Background service that discovers LMS players and registers them as Jellyfin sessions.
/// This enables LMS players to appear in Jellyfin's "Cast to" device picker.
/// </summary>
public class LmsDeviceDiscoveryService : IHostedService, IDisposable
{
private const string AppName = "JellyLMS";
private const string AppVersion = "1.0.0";
private readonly ILogger<LmsDeviceDiscoveryService> _logger;
private readonly IServiceProvider _serviceProvider;
private readonly ILmsApiClient _lmsClient;
private readonly LmsPlayerManager _playerManager;
private readonly ConcurrentDictionary<string, string> _registeredDeviceIds = new();
private ISessionManager? _sessionManager;
private Timer? _discoveryTimer;
private bool _disposed;
/// <summary>
/// Initializes a new instance of the <see cref="LmsDeviceDiscoveryService"/> class.
/// </summary>
/// <param name="logger">The logger instance.</param>
/// <param name="serviceProvider">The service provider for lazy resolution.</param>
/// <param name="lmsClient">The LMS API client.</param>
/// <param name="playerManager">The LMS player manager.</param>
public LmsDeviceDiscoveryService(
ILogger<LmsDeviceDiscoveryService> logger,
IServiceProvider serviceProvider,
ILmsApiClient lmsClient,
LmsPlayerManager playerManager)
{
_logger = logger;
_serviceProvider = serviceProvider;
_lmsClient = lmsClient;
_playerManager = playerManager;
_logger.LogInformation("LMS Device Discovery Service constructed");
}
/// <inheritdoc />
public Task StartAsync(CancellationToken cancellationToken)
{
_logger.LogInformation("LMS Device Discovery Service starting");
// Run initial discovery after a delay, then every 15 seconds
_discoveryTimer = new Timer(
async _ => await DiscoverAndRegisterPlayersAsync().ConfigureAwait(false),
null,
TimeSpan.FromSeconds(10),
TimeSpan.FromSeconds(15));
return Task.CompletedTask;
}
/// <inheritdoc />
public Task StopAsync(CancellationToken cancellationToken)
{
_logger.LogInformation("LMS Device Discovery Service stopping");
_discoveryTimer?.Change(Timeout.Infinite, 0);
_registeredDeviceIds.Clear();
return Task.CompletedTask;
}
private ISessionManager? GetSessionManager()
{
if (_sessionManager != null)
{
return _sessionManager;
}
try
{
_sessionManager = _serviceProvider.GetService<ISessionManager>();
if (_sessionManager == null)
{
_logger.LogWarning("ISessionManager not available yet");
}
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to resolve ISessionManager");
}
return _sessionManager;
}
private async Task DiscoverAndRegisterPlayersAsync()
{
try
{
var sessionManager = GetSessionManager();
if (sessionManager == null)
{
_logger.LogDebug("Session manager not available, skipping discovery");
return;
}
// First test connection
var status = await _lmsClient.TestConnectionAsync().ConfigureAwait(false);
if (!status.IsConnected)
{
_logger.LogDebug("LMS server not connected, skipping player discovery");
return;
}
// Get all players from LMS
var players = await _playerManager.GetPlayersAsync(forceRefresh: true).ConfigureAwait(false);
_logger.LogDebug("Discovered {Count} LMS players", players.Count);
foreach (var player in players)
{
try
{
await RegisterOrRefreshPlayerSessionAsync(sessionManager, player).ConfigureAwait(false);
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to register player {Name} ({Mac})", player.Name, player.MacAddress);
}
}
// Clean up tracked device IDs for players that no longer exist
foreach (var mac in _registeredDeviceIds.Keys)
{
if (!players.Exists(p => p.MacAddress == mac))
{
_registeredDeviceIds.TryRemove(mac, out _);
_logger.LogDebug("Removed tracking for disconnected player {Mac}", mac);
}
}
}
catch (Exception ex)
{
_logger.LogError(ex, "Error during LMS player discovery");
}
}
private async Task RegisterOrRefreshPlayerSessionAsync(ISessionManager sessionManager, LmsPlayer player)
{
// Create a unique device ID for this player
var deviceId = $"lms-{player.MacAddress}";
// Always call LogSessionActivity to keep the session alive
// This creates a new session if one doesn't exist, or refreshes the existing one
var session = await sessionManager.LogSessionActivity(
appName: AppName,
appVersion: AppVersion,
deviceId: deviceId,
deviceName: player.Name,
remoteEndPoint: player.IpAddress,
user: null).ConfigureAwait(false);
if (session == null)
{
_logger.LogWarning("Failed to create/refresh session for player {Name}", player.Name);
return;
}
// Check if this is a new registration
var isNew = !_registeredDeviceIds.ContainsKey(player.MacAddress);
// Add our controller to the session using EnsureController pattern
var (controller, created) = session.EnsureController<LmsSessionController>(
s => new LmsSessionController(
_logger,
_lmsClient,
player,
s));
if (created)
{
_logger.LogInformation("Created LmsSessionController for player {Name}", player.Name);
}
// Always report capabilities to ensure they're set
// This is critical for the device to appear in "Play On" menu
var capabilities = new ClientCapabilities
{
PlayableMediaTypes = [MediaType.Audio],
SupportedCommands =
[
GeneralCommandType.VolumeUp,
GeneralCommandType.VolumeDown,
GeneralCommandType.Mute,
GeneralCommandType.Unmute,
GeneralCommandType.SetVolume,
GeneralCommandType.ToggleMute
],
SupportsMediaControl = true,
SupportsPersistentIdentifier = true
};
sessionManager.ReportCapabilities(session.Id, capabilities);
// Track this device
_registeredDeviceIds[player.MacAddress] = deviceId;
if (isNew)
{
_logger.LogInformation(
"Registered LMS player {Name} ({Mac}) as session {SessionId}",
player.Name,
player.MacAddress,
session.Id);
}
}
/// <inheritdoc />
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
/// <summary>
/// Disposes managed resources.
/// </summary>
/// <param name="disposing">Whether to dispose managed resources.</param>
protected virtual void Dispose(bool disposing)
{
if (_disposed)
{
return;
}
if (disposing)
{
_discoveryTimer?.Dispose();
}
_disposed = true;
}
}

View File

@ -0,0 +1,163 @@
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Jellyfin.Plugin.JellyLMS.Models;
using Microsoft.Extensions.Logging;
namespace Jellyfin.Plugin.JellyLMS.Services;
/// <summary>
/// Manages LMS player discovery and state tracking.
/// </summary>
public class LmsPlayerManager
{
private readonly ILogger<LmsPlayerManager> _logger;
private readonly ILmsApiClient _lmsClient;
private readonly ConcurrentDictionary<string, LmsPlayer> _players = new();
private DateTime _lastRefresh = DateTime.MinValue;
private readonly TimeSpan _cacheExpiry = TimeSpan.FromSeconds(30);
/// <summary>
/// Initializes a new instance of the <see cref="LmsPlayerManager"/> class.
/// </summary>
/// <param name="logger">The logger instance.</param>
/// <param name="lmsClient">The LMS API client.</param>
public LmsPlayerManager(ILogger<LmsPlayerManager> logger, ILmsApiClient lmsClient)
{
_logger = logger;
_lmsClient = lmsClient;
}
/// <summary>
/// Gets all known LMS players, refreshing if cache is stale.
/// </summary>
/// <param name="forceRefresh">Force a refresh from LMS.</param>
/// <returns>List of LMS players.</returns>
public async Task<List<LmsPlayer>> GetPlayersAsync(bool forceRefresh = false)
{
if (!forceRefresh && DateTime.UtcNow - _lastRefresh < _cacheExpiry && _players.Count > 0)
{
return _players.Values.ToList();
}
await RefreshPlayersAsync().ConfigureAwait(false);
return _players.Values.ToList();
}
/// <summary>
/// Gets a specific player by MAC address.
/// </summary>
/// <param name="macAddress">The player's MAC address.</param>
/// <returns>The player, or null if not found.</returns>
public async Task<LmsPlayer?> GetPlayerAsync(string macAddress)
{
if (_players.TryGetValue(macAddress, out var player))
{
return player;
}
await RefreshPlayersAsync().ConfigureAwait(false);
return _players.GetValueOrDefault(macAddress);
}
/// <summary>
/// Refreshes the player list from LMS.
/// </summary>
/// <returns>A task representing the operation.</returns>
public async Task RefreshPlayersAsync()
{
try
{
var players = await _lmsClient.GetPlayersAsync().ConfigureAwait(false);
_players.Clear();
foreach (var player in players)
{
_players[player.MacAddress] = player;
}
_lastRefresh = DateTime.UtcNow;
_logger.LogDebug("Refreshed {Count} players from LMS", players.Count);
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to refresh players from LMS");
}
}
/// <summary>
/// Gets all current sync groups.
/// </summary>
/// <returns>List of sync groups.</returns>
public async Task<List<SyncGroup>> GetSyncGroupsAsync()
{
return await _lmsClient.GetSyncGroupsAsync().ConfigureAwait(false);
}
/// <summary>
/// Creates a sync group with the specified players.
/// </summary>
/// <param name="masterMac">The master player's MAC address.</param>
/// <param name="slaveMacs">The slave players' MAC addresses.</param>
/// <returns>True if successful.</returns>
public async Task<bool> CreateSyncGroupAsync(string masterMac, IEnumerable<string> slaveMacs)
{
var success = true;
foreach (var slaveMac in slaveMacs)
{
if (!await _lmsClient.SyncPlayerAsync(masterMac, slaveMac).ConfigureAwait(false))
{
_logger.LogWarning("Failed to sync player {Slave} to master {Master}", slaveMac, masterMac);
success = false;
}
}
// Refresh player state to update sync info
await RefreshPlayersAsync().ConfigureAwait(false);
return success;
}
/// <summary>
/// Removes a player from its sync group.
/// </summary>
/// <param name="playerMac">The player's MAC address.</param>
/// <returns>True if successful.</returns>
public async Task<bool> UnsyncPlayerAsync(string playerMac)
{
var result = await _lmsClient.UnsyncPlayerAsync(playerMac).ConfigureAwait(false);
await RefreshPlayersAsync().ConfigureAwait(false);
return result;
}
/// <summary>
/// Dissolves an entire sync group (unsyncs all members).
/// </summary>
/// <param name="masterMac">The master player's MAC address.</param>
/// <returns>True if successful.</returns>
public async Task<bool> DissolveSyncGroupAsync(string masterMac)
{
var player = await GetPlayerAsync(masterMac).ConfigureAwait(false);
if (player == null)
{
return false;
}
var success = true;
// Unsync all slaves
foreach (var slaveMac in player.SyncSlaves)
{
if (!await _lmsClient.UnsyncPlayerAsync(slaveMac).ConfigureAwait(false))
{
success = false;
}
}
await RefreshPlayersAsync().ConfigureAwait(false);
return success;
}
}

View File

@ -0,0 +1,253 @@
using System;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
using Jellyfin.Plugin.JellyLMS.Models;
using MediaBrowser.Controller.Session;
using MediaBrowser.Model.Session;
using Microsoft.Extensions.Logging;
namespace Jellyfin.Plugin.JellyLMS.Services;
/// <summary>
/// Session controller for LMS player devices.
/// Enables Jellyfin to send playback commands to LMS players via the cast interface.
/// </summary>
public class LmsSessionController : ISessionController
{
private readonly ILogger _logger;
private readonly ILmsApiClient _lmsClient;
private readonly LmsPlayer _player;
private readonly SessionInfo _session;
/// <summary>
/// Initializes a new instance of the <see cref="LmsSessionController"/> class.
/// </summary>
/// <param name="logger">The logger instance.</param>
/// <param name="lmsClient">The LMS API client.</param>
/// <param name="player">The LMS player this controller manages.</param>
/// <param name="session">The Jellyfin session associated with this controller.</param>
public LmsSessionController(
ILogger logger,
ILmsApiClient lmsClient,
LmsPlayer player,
SessionInfo session)
{
_logger = logger;
_lmsClient = lmsClient;
_player = player;
_session = session;
}
/// <inheritdoc />
public bool IsSessionActive => _player.IsConnected && _player.IsPoweredOn;
/// <inheritdoc />
public bool SupportsMediaControl => true;
/// <summary>
/// Gets the MAC address of the LMS player.
/// </summary>
public string PlayerMac => _player.MacAddress;
/// <inheritdoc />
public async Task SendMessage<T>(
SessionMessageType name,
Guid messageId,
T data,
CancellationToken cancellationToken)
{
_logger.LogDebug(
"LMS Session Controller received message {MessageType} for player {PlayerName}",
name,
_player.Name);
try
{
switch (name)
{
case SessionMessageType.Play:
await HandlePlayCommandAsync(data, cancellationToken).ConfigureAwait(false);
break;
case SessionMessageType.Playstate:
await HandlePlaystateCommandAsync(data, cancellationToken).ConfigureAwait(false);
break;
case SessionMessageType.GeneralCommand:
await HandleGeneralCommandAsync(data, cancellationToken).ConfigureAwait(false);
break;
default:
_logger.LogDebug("Unhandled message type: {MessageType}", name);
break;
}
}
catch (Exception ex)
{
_logger.LogError(ex, "Error handling message {MessageType} for player {PlayerName}", name, _player.Name);
}
}
private async Task HandlePlayCommandAsync<T>(T data, CancellationToken cancellationToken)
{
if (data is not PlayRequest playRequest)
{
_logger.LogWarning("Expected PlayRequest but got {Type}", data?.GetType().Name);
return;
}
_logger.LogInformation(
"Play command received for player {PlayerName}: {ItemCount} items",
_player.Name,
playRequest.ItemIds.Length);
// Power on the player if needed
if (!_player.IsPoweredOn)
{
await _lmsClient.PowerOnAsync(_player.MacAddress).ConfigureAwait(false);
}
// For now, play the first item
// TODO: Support playlists/queues
if (playRequest.ItemIds.Length > 0)
{
var itemId = playRequest.ItemIds[0];
var streamUrl = BuildStreamUrl(itemId);
_logger.LogInformation("Playing stream URL: {Url}", streamUrl);
await _lmsClient.PlayUrlAsync(_player.MacAddress, streamUrl).ConfigureAwait(false);
// Seek to start position if specified
if (playRequest.StartPositionTicks.HasValue && playRequest.StartPositionTicks.Value > 0)
{
var positionSeconds = playRequest.StartPositionTicks.Value / TimeSpan.TicksPerSecond;
await _lmsClient.SeekAsync(_player.MacAddress, positionSeconds).ConfigureAwait(false);
}
}
}
private async Task HandlePlaystateCommandAsync<T>(T data, CancellationToken cancellationToken)
{
if (data is not PlaystateRequest playstateRequest)
{
_logger.LogWarning("Expected PlaystateRequest but got {Type}", data?.GetType().Name);
return;
}
_logger.LogDebug(
"Playstate command {Command} for player {PlayerName}",
playstateRequest.Command,
_player.Name);
switch (playstateRequest.Command)
{
case PlaystateCommand.Stop:
await _lmsClient.StopAsync(_player.MacAddress).ConfigureAwait(false);
break;
case PlaystateCommand.Pause:
await _lmsClient.PauseAsync(_player.MacAddress).ConfigureAwait(false);
break;
case PlaystateCommand.Unpause:
await _lmsClient.PlayAsync(_player.MacAddress).ConfigureAwait(false);
break;
case PlaystateCommand.Seek:
if (playstateRequest.SeekPositionTicks.HasValue)
{
var positionSeconds = playstateRequest.SeekPositionTicks.Value / TimeSpan.TicksPerSecond;
await _lmsClient.SeekAsync(_player.MacAddress, positionSeconds).ConfigureAwait(false);
}
break;
case PlaystateCommand.NextTrack:
case PlaystateCommand.PreviousTrack:
// TODO: Implement playlist navigation
_logger.LogDebug("Track navigation not yet implemented");
break;
default:
_logger.LogDebug("Unhandled playstate command: {Command}", playstateRequest.Command);
break;
}
}
private async Task HandleGeneralCommandAsync<T>(T data, CancellationToken cancellationToken)
{
if (data is not GeneralCommand command)
{
_logger.LogWarning("Expected GeneralCommand but got {Type}", data?.GetType().Name);
return;
}
_logger.LogDebug(
"General command {CommandName} for player {PlayerName}",
command.Name,
_player.Name);
switch (command.Name)
{
case GeneralCommandType.SetVolume:
if (command.Arguments.TryGetValue("Volume", out var volumeStr) &&
int.TryParse(volumeStr, out var volume))
{
await _lmsClient.SetVolumeAsync(_player.MacAddress, volume).ConfigureAwait(false);
}
break;
case GeneralCommandType.VolumeUp:
var currentStatus = await _lmsClient.GetPlayerStatusAsync(_player.MacAddress).ConfigureAwait(false);
if (currentStatus != null)
{
var newVolume = Math.Min(100, currentStatus.Volume + 5);
await _lmsClient.SetVolumeAsync(_player.MacAddress, newVolume).ConfigureAwait(false);
}
break;
case GeneralCommandType.VolumeDown:
var status = await _lmsClient.GetPlayerStatusAsync(_player.MacAddress).ConfigureAwait(false);
if (status != null)
{
var newVolume = Math.Max(0, status.Volume - 5);
await _lmsClient.SetVolumeAsync(_player.MacAddress, newVolume).ConfigureAwait(false);
}
break;
case GeneralCommandType.Mute:
await _lmsClient.SetVolumeAsync(_player.MacAddress, 0).ConfigureAwait(false);
break;
case GeneralCommandType.ToggleMute:
// TODO: Track mute state to toggle properly
break;
default:
_logger.LogDebug("Unhandled general command: {Command}", command.Name);
break;
}
}
private string BuildStreamUrl(Guid itemId)
{
var config = Plugin.Instance?.Configuration;
var jellyfinUrl = config?.JellyfinServerUrl?.TrimEnd('/') ?? "http://localhost:8096";
var apiKey = config?.JellyfinApiKey ?? string.Empty;
// Build audio stream URL that LMS can fetch
// Use direct stream endpoint - simpler and more compatible
var url = $"{jellyfinUrl}/Audio/{itemId}/stream?static=true";
if (!string.IsNullOrEmpty(apiKey))
{
url += $"&api_key={apiKey}";
}
return url;
}
}

View File

@ -0,0 +1,313 @@
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Jellyfin.Plugin.JellyLMS.Configuration;
using Jellyfin.Plugin.JellyLMS.Models;
using MediaBrowser.Controller.Library;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
namespace Jellyfin.Plugin.JellyLMS.Services;
/// <summary>
/// Manages active playback sessions between Jellyfin and LMS.
/// </summary>
public class LmsSessionManager : IHostedService
{
private readonly ILogger<LmsSessionManager> _logger;
private readonly ILmsApiClient _lmsClient;
private readonly LmsPlayerManager _playerManager;
private readonly ILibraryManager _libraryManager;
private readonly ConcurrentDictionary<string, LmsPlaybackSession> _sessions = new();
/// <summary>
/// Initializes a new instance of the <see cref="LmsSessionManager"/> class.
/// </summary>
/// <param name="logger">The logger instance.</param>
/// <param name="lmsClient">The LMS API client.</param>
/// <param name="playerManager">The player manager.</param>
/// <param name="libraryManager">The Jellyfin library manager.</param>
public LmsSessionManager(
ILogger<LmsSessionManager> logger,
ILmsApiClient lmsClient,
LmsPlayerManager playerManager,
ILibraryManager libraryManager)
{
_logger = logger;
_lmsClient = lmsClient;
_playerManager = playerManager;
_libraryManager = libraryManager;
}
private PluginConfiguration Config => Plugin.Instance?.Configuration ?? new PluginConfiguration();
/// <summary>
/// Gets all active sessions.
/// </summary>
/// <returns>List of active sessions.</returns>
public List<LmsPlaybackSession> GetActiveSessions()
{
return _sessions.Values.Where(s => s.State != PlaybackState.Stopped).ToList();
}
/// <summary>
/// Gets a session by ID.
/// </summary>
/// <param name="sessionId">The session ID.</param>
/// <returns>The session, or null if not found.</returns>
public LmsPlaybackSession? GetSession(string sessionId)
{
return _sessions.GetValueOrDefault(sessionId);
}
/// <summary>
/// Starts playback of a Jellyfin item on LMS players.
/// </summary>
/// <param name="itemId">The Jellyfin item ID.</param>
/// <param name="playerMacs">The LMS player MAC addresses.</param>
/// <param name="userId">Optional user ID.</param>
/// <returns>The created session.</returns>
public async Task<LmsPlaybackSession?> StartPlaybackAsync(
Guid itemId,
IEnumerable<string> playerMacs,
Guid? userId = null)
{
var macList = playerMacs.ToList();
if (macList.Count == 0)
{
_logger.LogWarning("No players specified for playback");
return null;
}
var item = _libraryManager.GetItemById(itemId);
if (item == null)
{
_logger.LogWarning("Item {ItemId} not found", itemId);
return null;
}
// Build the audio stream URL
var streamUrl = BuildStreamUrl(itemId);
var session = new LmsPlaybackSession
{
ItemId = itemId,
ItemName = item.Name,
PlayerMacs = macList,
State = PlaybackState.Playing,
StreamUrl = streamUrl,
UserId = userId,
RuntimeTicks = item.RunTimeTicks ?? 0
};
// If multiple players, sync them first
if (macList.Count > 1)
{
var masterMac = macList[0];
var slaveMacs = macList.Skip(1);
await _playerManager.CreateSyncGroupAsync(masterMac, slaveMacs).ConfigureAwait(false);
}
// Start playback on the first player (others will sync)
var targetMac = macList[0];
var success = await _lmsClient.PlayUrlAsync(targetMac, streamUrl, item.Name).ConfigureAwait(false);
if (!success)
{
_logger.LogError("Failed to start playback on player {Mac}", targetMac);
return null;
}
_sessions[session.SessionId] = session;
_logger.LogInformation(
"Started playback session {SessionId} for {Item} on {Count} players",
session.SessionId,
item.Name,
macList.Count);
return session;
}
/// <summary>
/// Pauses a playback session.
/// </summary>
/// <param name="sessionId">The session ID.</param>
/// <returns>True if successful.</returns>
public async Task<bool> PauseSessionAsync(string sessionId)
{
if (!_sessions.TryGetValue(sessionId, out var session))
{
return false;
}
// Pause the master player (synced players will follow)
var success = await _lmsClient.PauseAsync(session.PlayerMacs[0]).ConfigureAwait(false);
if (success)
{
session.State = PlaybackState.Paused;
}
return success;
}
/// <summary>
/// Resumes a paused playback session.
/// </summary>
/// <param name="sessionId">The session ID.</param>
/// <returns>True if successful.</returns>
public async Task<bool> ResumeSessionAsync(string sessionId)
{
if (!_sessions.TryGetValue(sessionId, out var session))
{
return false;
}
var success = await _lmsClient.PlayAsync(session.PlayerMacs[0]).ConfigureAwait(false);
if (success)
{
session.State = PlaybackState.Playing;
}
return success;
}
/// <summary>
/// Stops a playback session.
/// </summary>
/// <param name="sessionId">The session ID.</param>
/// <returns>True if successful.</returns>
public async Task<bool> StopSessionAsync(string sessionId)
{
if (!_sessions.TryGetValue(sessionId, out var session))
{
return false;
}
var success = await _lmsClient.StopAsync(session.PlayerMacs[0]).ConfigureAwait(false);
if (success)
{
session.State = PlaybackState.Stopped;
// Unsync players if there were multiple
if (session.PlayerMacs.Count > 1)
{
await _playerManager.DissolveSyncGroupAsync(session.PlayerMacs[0]).ConfigureAwait(false);
}
}
// Remove the session
_sessions.TryRemove(sessionId, out _);
return success;
}
/// <summary>
/// Seeks to a position in the playback session.
/// </summary>
/// <param name="sessionId">The session ID.</param>
/// <param name="positionTicks">The position in ticks.</param>
/// <returns>True if successful.</returns>
public async Task<bool> SeekAsync(string sessionId, long positionTicks)
{
if (!_sessions.TryGetValue(sessionId, out var session))
{
return false;
}
var positionSeconds = positionTicks / TimeSpan.TicksPerSecond;
var success = await _lmsClient.SeekAsync(session.PlayerMacs[0], positionSeconds).ConfigureAwait(false);
if (success)
{
session.PositionTicks = positionTicks;
}
return success;
}
/// <summary>
/// Sets the volume for all players in a session.
/// </summary>
/// <param name="sessionId">The session ID.</param>
/// <param name="volume">The volume level (0-100).</param>
/// <returns>True if successful.</returns>
public async Task<bool> SetVolumeAsync(string sessionId, int volume)
{
if (!_sessions.TryGetValue(sessionId, out var session))
{
return false;
}
var success = true;
foreach (var mac in session.PlayerMacs)
{
if (!await _lmsClient.SetVolumeAsync(mac, volume).ConfigureAwait(false))
{
success = false;
}
}
return success;
}
/// <summary>
/// Updates the session state from LMS.
/// </summary>
/// <param name="sessionId">The session ID.</param>
/// <returns>A task representing the operation.</returns>
public async Task RefreshSessionStateAsync(string sessionId)
{
if (!_sessions.TryGetValue(sessionId, out var session))
{
return;
}
var status = await _lmsClient.GetPlayerStatusAsync(session.PlayerMacs[0]).ConfigureAwait(false);
if (status == null)
{
return;
}
session.PositionTicks = (long)(status.Time * TimeSpan.TicksPerSecond);
session.State = status.Mode switch
{
"play" => PlaybackState.Playing,
"pause" => PlaybackState.Paused,
_ => PlaybackState.Stopped
};
}
private string BuildStreamUrl(Guid itemId)
{
var baseUrl = Config.JellyfinServerUrl.TrimEnd('/');
// Direct stream URL - LMS will pull audio from Jellyfin
return $"{baseUrl}/Audio/{itemId}/stream.mp3";
}
/// <inheritdoc />
public Task StartAsync(CancellationToken cancellationToken)
{
_logger.LogInformation("LMS Session Manager started");
return Task.CompletedTask;
}
/// <inheritdoc />
public Task StopAsync(CancellationToken cancellationToken)
{
_logger.LogInformation("LMS Session Manager stopping");
// Stop all active sessions
foreach (var sessionId in _sessions.Keys.ToList())
{
_ = StopSessionAsync(sessionId);
}
return Task.CompletedTask;
}
}

View File

@ -1,57 +0,0 @@
using MediaBrowser.Model.Plugins;
namespace Jellyfin.Plugin.Template.Configuration;
/// <summary>
/// The configuration options.
/// </summary>
public enum SomeOptions
{
/// <summary>
/// Option one.
/// </summary>
OneOption,
/// <summary>
/// Second option.
/// </summary>
AnotherOption
}
/// <summary>
/// Plugin configuration.
/// </summary>
public class PluginConfiguration : BasePluginConfiguration
{
/// <summary>
/// Initializes a new instance of the <see cref="PluginConfiguration"/> class.
/// </summary>
public PluginConfiguration()
{
// set default options here
Options = SomeOptions.AnotherOption;
TrueFalseSetting = true;
AnInteger = 2;
AString = "string";
}
/// <summary>
/// Gets or sets a value indicating whether some true or false setting is enabled..
/// </summary>
public bool TrueFalseSetting { get; set; }
/// <summary>
/// Gets or sets an integer setting.
/// </summary>
public int AnInteger { get; set; }
/// <summary>
/// Gets or sets a string setting.
/// </summary>
public string AString { get; set; }
/// <summary>
/// Gets or sets an enum option.
/// </summary>
public SomeOptions Options { get; set; }
}

View File

@ -1,79 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Template</title>
</head>
<body>
<div id="TemplateConfigPage" data-role="page" class="page type-interior pluginConfigurationPage" data-require="emby-input,emby-button,emby-select,emby-checkbox">
<div data-role="content">
<div class="content-primary">
<form id="TemplateConfigForm">
<div class="selectContainer">
<label class="selectLabel" for="Options">Several Options</label>
<select is="emby-select" id="Options" name="Options" class="emby-select-withcolor emby-select">
<option id="optOneOption" value="OneOption">One Option</option>
<option id="optAnotherOption" value="AnotherOption">Another Option</option>
</select>
</div>
<div class="inputContainer">
<label class="inputLabel inputLabelUnfocused" for="AnInteger">An Integer</label>
<input id="AnInteger" name="AnInteger" type="number" is="emby-input" min="0" />
<div class="fieldDescription">A Description</div>
</div>
<div class="checkboxContainer checkboxContainer-withDescription">
<label class="emby-checkbox-label">
<input id="TrueFalseSetting" name="TrueFalseCheckBox" type="checkbox" is="emby-checkbox" />
<span>A Checkbox</span>
</label>
</div>
<div class="inputContainer">
<label class="inputLabel inputLabelUnfocused" for="AString">A String</label>
<input id="AString" name="AString" type="text" is="emby-input" />
<div class="fieldDescription">Another Description</div>
</div>
<div>
<button is="emby-button" type="submit" class="raised button-submit block emby-button">
<span>Save</span>
</button>
</div>
</form>
</div>
</div>
<script type="text/javascript">
var TemplateConfig = {
pluginUniqueId: 'eb5d7894-8eef-4b36-aa6f-5d124e828ce1'
};
document.querySelector('#TemplateConfigPage')
.addEventListener('pageshow', function() {
Dashboard.showLoadingMsg();
ApiClient.getPluginConfiguration(TemplateConfig.pluginUniqueId).then(function (config) {
document.querySelector('#Options').value = config.Options;
document.querySelector('#AnInteger').value = config.AnInteger;
document.querySelector('#TrueFalseSetting').checked = config.TrueFalseSetting;
document.querySelector('#AString').value = config.AString;
Dashboard.hideLoadingMsg();
});
});
document.querySelector('#TemplateConfigForm')
.addEventListener('submit', function(e) {
Dashboard.showLoadingMsg();
ApiClient.getPluginConfiguration(TemplateConfig.pluginUniqueId).then(function (config) {
config.Options = document.querySelector('#Options').value;
config.AnInteger = document.querySelector('#AnInteger').value;
config.TrueFalseSetting = document.querySelector('#TrueFalseSetting').checked;
config.AString = document.querySelector('#AString').value;
ApiClient.updatePluginConfiguration(TemplateConfig.pluginUniqueId, config).then(function (result) {
Dashboard.processPluginConfigurationUpdateResult(result);
});
});
e.preventDefault();
return false;
});
</script>
</div>
</body>
</html>

554
README.md
View File

@ -1,415 +1,199 @@
# So you want to make a Jellyfin plugin
# JellyLMS
Awesome! This guide is for you. Jellyfin plugins are written using the dotnet standard framework. What that means is you can write them in any language that implements the CLI or the DLI and can compile to net8.0. The examples on this page are in C# because that is what most of Jellyfin is written in, but F#, Visual Basic, and IronPython should all be compatible once compiled.
A Jellyfin plugin that bridges audio playback to Logitech Media Server (LMS) for multi-room synchronized playback.
## 0. Things you need to get started
## Overview
- [Dotnet SDK 9.0](https://dotnet.microsoft.com/en-us/download/dotnet)
JellyLMS enables Jellyfin to stream audio to LMS, which acts as a multi-room speaker system. The architecture is:
- An editor of your choice. Some free choices are:
[Visual Studio Code](https://code.visualstudio.com)
[Visual Studio Community Edition](https://visualstudio.microsoft.com/downloads)
[Mono Develop](https://www.monodevelop.com)
## 0.5. Quickstarts
We have a number of quickstart options available to speed you along the way.
- [Download the Example Plugin Project](https://github.com/jellyfin/jellyfin-plugin-template/tree/master/Jellyfin.Plugin.Template) from this repository, open it in your IDE and go to [step 3](https://github.com/jellyfin/jellyfin-plugin-template#3-customize-plugin-information)
- Install our dotnet template by [downloading the dotnet-template/content folder from this repo](https://github.com/jellyfin/jellyfin-plugin-template/tree/master/dotnet-template/content) or off of Nuget (Coming soon)
```
dotnet new -i /path/to/templatefolder
```
- Run this command then skip to step 4
```
dotnet new Jellyfin-plugin -name MyPlugin
```
If you'd rather start from scratch keep going on to step one. This assumes no specific editor or IDE and requires only the command line with dotnet in the path.
## 1. Initialize Your Project
Make a new dotnet standard project with the following command, it will make a directory for itself.
- **Jellyfin** owns the library, queue, and playback intent
- **LMS** owns synchronized audio delivery to players (Squeezebox, piCorePlayer, etc.)
```
dotnet new classlib -f net9.0 -n MyJellyfinPlugin
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ Jellyfin │ │ JellyLMS │ │ LMS │
│ │ │ Plugin │ │ │
│ ┌───────────┐ │ │ │ │ ┌───────────┐ │
│ │ Library │──┼────────►│ LmsApiClient │────────►│ │ Players │ │
│ │ (Audio) │ │ │ │ │ │ (Zones) │ │
│ └───────────┘ │ │ ┌───────────┐ │ │ └───────────┘ │
│ │ │ │ Session │ │ │ │
│ ┌───────────┐ │ │ │ Manager │ │ │ ┌───────────┐ │
│ │ Queue │──┼────────►│ └───────────┘ │────────►│ │ Sync │ │
│ │ │ │ │ │ │ │ Groups │ │
│ └───────────┘ │ │ ┌───────────┐ │ │ └───────────┘ │
│ │ │ │ REST API │ │ │ │
│ ┌───────────┐ │ │ │Controller │ │ │ │
│ │ Playback │──┼────────►│ └───────────┘ │ │ │
│ │ Controls │ │ │ │ │ │
│ └───────────┘ │ └─────────────────┘ └─────────────────┘
└─────────────────┘
```
Now add the Jellyfin shared libraries.
## Features
```
dotnet add package Jellyfin.Model
dotnet add package Jellyfin.Controller
- **Player Discovery**: Automatically discovers all LMS players/zones
- **Multi-Room Sync**: Create and manage sync groups for synchronized playback across multiple rooms
- **Playback Control**: Play, pause, stop, seek, and volume control forwarded to LMS
- **Stream Bridging**: Generates audio stream URLs from Jellyfin for LMS to consume
## Requirements
- Jellyfin Server 10.10.0 or later
- .NET 8.0 Runtime
- Logitech Media Server (LMS) with JSON-RPC API enabled (default on port 9000)
## Installation
### Manual Installation
1. Download the latest release or build from source
2. Copy `Jellyfin.Plugin.JellyLMS.dll` to your Jellyfin plugins directory:
- **Linux**: `~/.local/share/jellyfin/plugins/JellyLMS/`
- **Windows**: `%APPDATA%\jellyfin\plugins\JellyLMS\`
- **Docker**: `/config/plugins/JellyLMS/`
3. Restart Jellyfin
### Building from Source
```bash
# Clone the repository
git clone https://github.com/yourusername/jellyLMS.git
cd jellyLMS
# Build
dotnet build Jellyfin.Plugin.JellyLMS.sln -c Release
# The DLL will be in:
# Jellyfin.Plugin.JellyLMS/bin/Release/net8.0/
```
You have an autogenerated Class1.cs file. You won't be needing this, so go ahead and delete it.
## Configuration
1. Navigate to Jellyfin Dashboard → Plugins → JellyLMS
2. Configure the following settings:
| Setting | Description | Default |
|---------|-------------|---------|
| LMS Server URL | Full URL to your LMS server | `http://localhost:9000` |
| Jellyfin Server URL | URL where LMS can reach Jellyfin | `http://localhost:8096` |
| Connection Timeout | Timeout for LMS API calls (seconds) | `10` |
| Enable Auto Sync | Automatically sync players when creating groups | `true` |
| Default Player | MAC address of the default player | (none) |
3. Click "Test Connection" to verify connectivity to LMS
4. Use "Discover Players" to see available LMS players
## API Endpoints
The plugin exposes REST API endpoints under `/JellyLms/`:
### Players
- `GET /JellyLms/Players` - List all LMS players
- `GET /JellyLms/Players/{mac}` - Get specific player details
- `POST /JellyLms/Players/Refresh` - Refresh player list from LMS
### Sync Groups
- `GET /JellyLms/SyncGroups` - List all sync groups
- `POST /JellyLms/SyncGroups` - Create a new sync group
- `DELETE /JellyLms/SyncGroups/{masterMac}` - Dissolve a sync group
- `DELETE /JellyLms/SyncGroups/{masterMac}/Players/{slaveMac}` - Remove player from group
### Sessions
- `GET /JellyLms/Sessions` - List active playback sessions
- `POST /JellyLms/Sessions` - Start a new playback session
- `POST /JellyLms/Sessions/{id}/Pause` - Pause playback
- `POST /JellyLms/Sessions/{id}/Resume` - Resume playback
- `POST /JellyLms/Sessions/{id}/Stop` - Stop playback
- `POST /JellyLms/Sessions/{id}/Seek` - Seek to position
- `POST /JellyLms/Sessions/{id}/Volume` - Set volume
### Status
- `GET /JellyLms/Status` - Get LMS connection status
- `POST /JellyLms/TestConnection` - Test LMS connectivity
## LMS Setup
Ensure your LMS server has the JSON-RPC API available. This is enabled by default and accessible at:
Navigate to the csproj that was generated, and ensure that you modify the package references to exclude assets, so that unnecessary files aren't copied over.
Skipping this step will prevent your plugin from registering correctly.
```
<ItemGroup>
<PackageReference Include="Jellyfin.Controller" Version="10.11.3">
<ExcludeAssets>runtime</ExcludeAssets>
</PackageReference>
<PackageReference Include="Jellyfin.Model" Version="10.11.3">
<ExcludeAssets>runtime</ExcludeAssets>
</PackageReference>
</ItemGroup>
```
Note: Ensure the package reference version matches the install version of jellyfin server, otherwise the plugin will show as NotSupported.
## 2. Set Up the Basics
There are a few mandatory classes you'll need for a plugin so we need to make them.
### PluginConfiguration
Create a folder named "Configuration", and a PluginConfiguration.cs file inside.
You can call it whatever you'd like really. This class is used to hold settings your plugin might need. We can leave it empty for now. This class should inherit from `MediaBrowser.Model.Plugins.BasePluginConfiguration`
It should look something like the following:
```c#
using MediaBrowser.Model.Plugins;
namespace MyJellyfinPlugin.Configuration;
class PluginConfiguration : BasePluginConfiguration
{
}
http://<lms-server>:9000/jsonrpc.js
```
### Plugin
The plugin communicates with LMS using the `slim.request` JSON-RPC method.
This is the main class for your plugin and will reside in the root of your project. It will define your name, version and Id. It should inherit from `MediaBrowser.Common.Plugins.BasePlugin<PluginConfiguration>`
## Troubleshooting
It should look something like the following:
```c#
using MediaBrowser.Common.Plugins;
using MyJellyfinPlugin.Configuration;
namespace MyJellyfinPlugin;
class Plugin : BasePlugin<PluginConfiguration>
{
}
### Cannot connect to LMS
1. Verify LMS is running and accessible at the configured URL
2. Check that the JSON-RPC endpoint responds: `curl http://localhost:9000/jsonrpc.js`
3. Ensure no firewall is blocking connections between Jellyfin and LMS
### Players not appearing
1. Ensure players are powered on and connected to LMS
2. Click "Discover Players" to refresh the player list
3. Check LMS web interface to verify players are visible there
### Audio not playing
1. Verify Jellyfin server URL is accessible from LMS server
2. Check that audio files are in a format supported by your LMS players
3. Ensure players are powered on (plugin can auto-power-on if configured)
## Development
### Project Structure
```
Jellyfin.Plugin.JellyLMS/
├── Plugin.cs # Main plugin entry point
├── PluginServiceRegistrator.cs # DI service registration
├── Configuration/
│ ├── PluginConfiguration.cs # Plugin settings
│ └── configPage.html # Dashboard configuration UI
├── Api/
│ └── JellyLmsController.cs # REST API endpoints
├── Services/
│ ├── ILmsApiClient.cs # LMS API interface
│ ├── LmsApiClient.cs # LMS JSON-RPC client
│ ├── LmsPlayerManager.cs # Player discovery & sync
│ └── LmsSessionManager.cs # Playback session management
└── Models/
├── LmsPlayer.cs # Player model
├── LmsPlaybackSession.cs # Session state model
└── LmsApiModels.cs # JSON-RPC DTOs
```
Note: If you called your PluginConfiguration class something different, you need to put that between the <>
### Building for Development
### Implement Required Properties
```bash
# Build in debug mode
dotnet build Jellyfin.Plugin.JellyLMS.sln
The Plugin class needs a few properties implemented before it can work correctly.
# Copy to Jellyfin plugins directory
cp Jellyfin.Plugin.JellyLMS/bin/Debug/net8.0/Jellyfin.Plugin.JellyLMS.dll \
~/.local/share/jellyfin/plugins/JellyLMS/
It needs an override on ID, an override on Name, and a constructor that follows a specific model. To get started you can use the following section.
```c#
public Plugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer) : base(applicationPaths, xmlSerializer){}
public override string Name => throw new System.NotImplementedException();
public override Guid Id => Guid.Parse("");
# Restart Jellyfin to load the plugin
```
## 3. Customize Plugin Information
## License
You need to populate some of your plugin's information. Go ahead a put in a string of the Name you've overridden name, and generate a GUID
This plugin is licensed under the GPLv3. See [LICENSE](LICENSE) for details.
- **Windows Users**: you can use the Powershell command `New-Guid`, `[guid]::NewGuid()` or the Visual Studio GUID generator
Due to how Jellyfin plugins work, when compiled into a binary, it links against Jellyfin's GPLv3-licensed NuGet packages, making the resulting binary GPLv3 licensed.
- **Linux and OS X Users**: you can use the Powershell Core command `New-Guid` or this command from your shell of choice:
## Contributing
```bash
od -x /dev/urandom | head -n1 | awk '{OFS="-"; srand($6); sub(/./,"4",$5); sub(/./,substr("89ab",1+rand()*4,1),$6); print $2$3,$4,$5,$6,$7$8$9}'
```
Contributions are welcome! Please open an issue or submit a pull request.
or
## Acknowledgments
```bash
uuidgen
```
- Place that guid inside the `Guid.Parse("")` quotes to define your plugin's ID.
## 4. Adding Functionality
Congratulations, you now have everything you need for a perfectly functional functionless Jellyfin plugin! You can try it out right now if you'd like by compiling it, then placing the dll you generate in a subfolder (named after your plugin for example) within the plugins folder under your Jellyfin directory (Normally C:\Users\{YourUserName}\AppData\Local\jellyfin\plugins). If you want to try and hook it up to a debugger make sure you copy the generated PDB file alongside it.
Most people aren't satisfied with just having an entry in a menu for their plugin, most people want to have some functionality, so lets look at how to add it.
### 4a. Implement Interfaces
If the functionality you are trying to add is functionality related to something that Jellyfin has an interface for you're in luck. Jellyfin uses some automatic discovery and injection to allow any interfaces you implement in your plugin to be available in Jellyfin.
Here's some interfaces you could implement for common use cases:
- **IAuthenticationProvider** - Allows you to add an authentication provider that can authenticate a user based on a name and a password, but that doesn't expect to deal with local users.
- **IBaseItemComparer** - Allows you to add sorting rules for dealing with media that will show up in sort menus
- **IIntroProvider** - Allows you to play a piece of media before another piece of media (i.e. a trailer before a movie, or a network bumper before an episode of a show)
- **IItemResolver** - Allows you to define custom media types
- **ILibraryPostScanTask** - Allows you to define a task that fires after scanning a library
- **IMetadataSaver** - Allows you to define a metadata standard that Jellyfin can use to write metadata
- **IResolverIgnoreRule** - Allows you to define subpaths that are ignored by media resolvers for use with another function (i.e. you wanted to have a theme song for each tv series stored in a subfolder that could be accessed by your plugin for playback in a menu).
- **IScheduledTask** - Allows you to create a scheduled task that will appear in the scheduled task lists on the dashboard.
There are loads of other interfaces that can be used, but you'll need to poke around the API to get some info. If you're an expert on a particular interface, you should help [contribute some documentation](https://docs.jellyfin.org/general/contributing/index.html)!
### 4b. Use plugin aimed interfaces to add custom functionality
If your plugin doesn't fit perfectly neatly into a predefined interface, never fear, there are a set of interfaces and classes that allow your plugin to extend Jellyfin any which way you please. Here's a quick overview on how to use them
- **IPluginConfigurationPage** - Allows you to have a plugin config page on the dashboard. If you used one of the quickstart example projects, a premade page with some useful components to work with has been created for you! If not you can check out this guide here for how to whip one up.
**IPluginServiceRegistrator** - Will be located by Jellyfin at server startup and allows you to add services to the DI container to allow for injection in your plugin's classes later.
- **IHostedService** - Allows you to run code as a background task that will be started at program startup and will remain in memory. See [Microsoft's documentation](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/host/hosted-services?view=aspnetcore-8.0&tabs=visual-studio#ihostedservice-interface) for more information. You can make as many of these as you need; make Jellyfin aware of them with an `IPluginServiceRegistrator`. It is wildly useful for loading configs or persisting state. **Be aware that your main plugin class (IBasePlugin) cannot also be a IHostedService.**
- **ControllerBase** - Allows you to define custom REST-API endpoints. This is the default ASP.NET Web-API controller. You can use it exactly as you would in a normal Web-API project. Learn more about it [here](https://docs.microsoft.com/aspnet/core/web-api/?view=aspnetcore-5.0).
Likewise you might need to get data and services from the Jellyfin core, Jellyfin provides a number of interfaces you can add as parameters to your plugin constructor which are then made available in your project (you can see the 2 mandatory ones that are needed by the plugin system in the constructor as is).
- **IBlurayExaminer** - Allows you to examine blu-ray folders
- **IDtoService** - Allows you to create data transport objects, presumably to send to other plugins or to the core
- **ILibraryManager** - Allows you to directly access the media libraries without hopping through the API
- **ILocalizationManager** - Allows you tap into the main localization engine which governs translations, rating systems, units etc...
- **INetworkManager** - Allows you to get information about the server's networking status
- **IServerApplicationPaths** - Allows you to get the running server's paths
- **IServerConfigurationManager** - Allows you to write or read server configuration data into the application paths
- **ITaskManager** - Allows you to execute and manipulate scheduled tasks
- **IUserManager** - Allows you to retrieve user info and user library related info
- **IXmlSerializer** - Allows you to use the main xml serializer
- **IZipClient** - Allows you to use the core zip client for compressing and decompressing data
## 5. Create a Repository
- [See blog post](https://jellyfin.org/posts/plugin-updates/)
## 6. Set Up Debugging
Debugging can be set up by creating tasks which will be executed when running the plugin project. The specifics on setting up these tasks are not included as they may differ from IDE to IDE. The following list describes the general process:
- Compile the plugin in debug mode.
- Create the plugin directory if it doesn't exist.
- Copy the plugin into your server's plugin directory. The server will then execute it.
- Make sure to set the working directory of the program being debugged to the working directory of the Jellyfin Server.
- Start the server.
Some IDEs like Visual Studio Code may need the following compile flags to compile the plugin:
```shell
dotnet build Your-Plugin.sln /property:GenerateFullPaths=true /consoleloggerparameters:NoSummary
```
These flags generate the full paths for file names and **do not** generate a summary during the build process as this may lead to duplicate errors in the problem panel of your IDE.
### 6.a Set Up Debugging on Visual Studio
Visual Studio allows developers to connect to other processes and debug them, setting breakpoints and inspecting the variables of the program. We can set this up following this steps:
On this section we will explain how to set up our solution to enable debugging before the server starts.
1. Right-click on the solution, And click on Add -> Existing Project...
2. Locate Jellyfin executable in your installation folder and click on 'Open'. It is called `Jellyfin.exe`. Now The solution will have a new "Project" called Jellyfin. This is the executable, not the source code of Jellyfin.
3. Right-click on this new project and click on 'Set up as Startup Project'
4. Right-click on this new project and click on 'Properties'
5. Make sure that the 'Attach' parameter is set to 'No'
From now on, everytime you click on start from Visual Studio, it will start Jellyfin attached to the debugger!
The only thing left to do is to compile the project as it is specified a few lines above and you are done.
### 6.b Automate the Setup on Visual Studio Code
Visual Studio Code allows developers to automate the process of starting all necessary dependencies to start debugging the plugin. This guide assumes the reader is familiar with the [documentation on debugging in Visual Studio Code](https://code.visualstudio.com/docs/editor/debugging) and has read the documentation in this file. It is assumed that the Jellyfin Server has already been compiled once. However, should one desire to automatically compile the server before the start of the debugging session, this can be easily implemented, but is not further discussed here.
A full example, which aims to be portable may be found in this repo's `.vscode` folder.
This example expects you to clone `jellyfin`, `jellyfin-web` and `jellyfin-plugin-template` under the same parent directory, though you can customize this in `settings.json`
1. Create a `settings.json` file inside your `.vscode` folder, to specify common options specific to your local setup.
```jsonc
{
// jellyfinDir : The directory of the cloned jellyfin server project
// This needs to be built once before it can be used
"jellyfinDir" : "${workspaceFolder}/../jellyfin/Jellyfin.Server",
// jellyfinWebDir : The directory of the cloned jellyfin-web project
// This needs to be built once before it can be used
"jellyfinWebDir" : "${workspaceFolder}/../jellyfin-web",
// jellyfinDataDir : the root data directory for a running jellyfin instance
// This is where jellyfin stores its configs, plugins, metadata etc
// This is platform specific by default, but on Windows defaults to
// ${env:LOCALAPPDATA}/jellyfin
"jellyfinDataDir" : "${env:LOCALAPPDATA}/jellyfin",
// The name of the plugin
"pluginName" : "Jellyfin.Plugin.Template",
}
```
1. To automate the launch process, create a new `launch.json` file for C# projects inside the `.vscode` folder. The example below shows only the relevant parts of the file. Adjustments to your specific setup and operating system may be required.
```jsonc
{
// Paths and plugin names are configured in settings.json
"version": "0.2.0",
"configurations": [
{
"type": "coreclr",
"name": "Launch",
"request": "launch",
"preLaunchTask": "build-and-copy",
"program": "${config:jellyfinDir}/bin/Debug/net8.0/jellyfin.dll",
"args": [
//"--nowebclient"
"--webdir",
"${config:jellyfinWebDir}/dist/"
],
"cwd": "${config:jellyfinDir}",
}
]
}
```
The `request` type is specified as `launch`, as this `launch.json` file will start the Jellyfin Server process. The `preLaunchTask` defines a task that will run before the Jellyfin Server starts. More on this later. It is important to set the `program` path to the Jellyin Server program and set the current working directory (`cwd`) to the working directory of the Jellyfin Server.
The `args` option allows to specify arguments to be passed to the server, e.g. whether Jellyfin should start with the web-client or without it.
2. Create a `tasks.json` file inside your `.vscode` folder and specify a `build-and-copy` task that will run in `sequence` order. This tasks depends on multiple other tasks and all of those other tasks can be defined as simple `shell` tasks that run commands like the `cp` command to copy a file. The sequence to run those tasks in is given below. Please note that it might be necessary to adjust the examples for your specific setup and operating system.
The full file is shown here - Specific sections will be discussed in depth
```jsonc
{
// Paths and plugin name are configured in settings.json
"version": "2.0.0",
"tasks": [
{
// A chain task - build the plugin, then copy it to your
// jellyfin server's plugin directory
"label": "build-and-copy",
"dependsOrder": "sequence",
"dependsOn": ["build", "make-plugin-dir", "copy-dll"]
},
{
// Build the plugin
"label": "build",
"command": "dotnet",
"type": "shell",
"args": [
"publish",
"${workspaceFolder}/${config:pluginName}.sln",
"/property:GenerateFullPaths=true",
"/consoleloggerparameters:NoSummary"
],
"group": "build",
"presentation": {
"reveal": "silent"
},
"problemMatcher": "$msCompile"
},
{
// Ensure the plugin directory exists before trying to use it
"label": "make-plugin-dir",
"type": "shell",
"command": "mkdir",
"args": [
"-Force",
"-Path",
"${config:jellyfinDataDir}/plugins/${config:pluginName}/"
]
},
{
// Copy the plugin dll to the jellyfin plugin install path
// This command copies every .dll from the build directory to the plugin dir
// Usually, you probablly only need ${config:pluginName}.dll
// But some plugins may bundle extra requirements
"label": "copy-dll",
"type": "shell",
"command": "cp",
"args": [
"./${config:pluginName}/bin/Debug/net8.0/publish/*",
"${config:jellyfinDataDir}/plugins/${config:pluginName}/"
]
},
]
}
```
1. The "build-and-copy" task which triggers all of the other tasks
```jsonc
{
// A chain task - build the plugin, then copy it to your
// jellyfin server's plugin directory
"label": "build-and-copy",
"dependsOrder": "sequence",
"dependsOn": ["build", "make-plugin-dir", "copy-dll"]
},
```
2. A build task. This task builds the plugin without generating summary, but with full paths for file names enabled.
```jsonc
{
// Build the plugin
"label": "build",
"command": "dotnet",
"type": "shell",
"args": [
"publish",
"${workspaceFolder}/${config:pluginName}.sln",
"/property:GenerateFullPaths=true",
"/consoleloggerparameters:NoSummary"
],
"group": "build",
"presentation": {
"reveal": "silent"
},
"problemMatcher": "$msCompile"
},
```
3. A tasks which creates the necessary plugin directory and a sub-folder for the specific plugin. The plugin directory is located below the [data directory](https://jellyfin.org/docs/general/administration/configuration.html) of the Jellyfin Server. As an example, the following path can be used for the bookshelf plugin: `$HOME/.local/share/jellyfin/plugins/Bookshelf/`
```jsonc
{
// Ensure the plugin directory exists before trying to use it
"label": "make-plugin-dir",
"type": "shell",
"command": "mkdir",
"args": [
"-Force",
"-Path",
"${config:jellyfinDataDir}/plugins/${config:pluginName}/"
]
},
```
4. A tasks which copies the plugin dll which has been built in step 2.1. The file is copied into it's specific plugin directory within the server's plugin directory.
```jsonc
{
// Copy the plugin dll to the jellyfin plugin install path
// This command copies every .dll from the build directory to the plugin dir
// Usually, you probablly only need ${config:pluginName}.dll
// But some plugins may bundle extra requirements
"label": "copy-dll",
"type": "shell",
"command": "cp",
"args": [
"./${config:pluginName}/bin/Debug/net8.0/publish/*",
"${config:jellyfinDataDir}/plugins/${config:pluginName}/"
]
},
```
## Licensing
Licensing is a complex topic. This repository features a GPLv3 license template that can be used to provide a good default license for your plugin. You may alter this if you like, but if you do a permissive license must be chosen.
Due to how plugins in Jellyfin work, when your plugin is compiled into a binary, it will link against the various Jellyfin binary NuGet packages. These packages are licensed under the GPLv3. Thus, due to the nature and restrictions of the GPL, the binary plugin you get will also be licensed under the GPLv3.
If you accept the default GPLv3 license from this template, all will be good. However if you choose a different license, please keep this fact in mind, as it might not always be obvious that an, e.g. MIT-licensed plugin would become GPLv3 when compiled.
Please note that this also means making "proprietary", source-unavailable, or otherwise "hidden" plugins for public consumption is not permitted. To build a Jellyfin plugin for distribution to others, it must be under the GPLv3 or a permissive open-source license that can be linked against the GPLv3.
- [Jellyfin](https://jellyfin.org/) - The Free Software Media System
- [Logitech Media Server](https://github.com/Logitech/slimserver) - Open source server for Squeezebox players

View File

@ -1,16 +1,18 @@
---
name: "Template"
guid: "eb5d7894-8eef-4b36-aa6f-5d124e828ce1"
name: "JellyLMS"
guid: "a5b8c9d0-1e2f-3a4b-5c6d-7e8f9a0b1c2d"
version: "1.0.0.0"
targetAbi: "10.9.0.0"
framework: "net8.0"
overview: "Short description about your plugin"
overview: "Bridge plugin to stream Jellyfin audio to Logitech Media Server (LMS) players"
description: >
This is a longer description that can span more than one
line and include details about your plugin.
category: "General"
JellyLMS enables Jellyfin to stream audio to LMS (Logitech Media Server) for
multi-room synchronized playback. Jellyfin owns the library, queue, and playback
intent while LMS handles synchronized audio delivery to Squeezebox players,
piCorePlayer devices, and other LMS-compatible endpoints.
category: "Music"
owner: "jellyfin"
artifacts:
- "Jellyfin.Plugin.Template.dll"
- "Jellyfin.Plugin.JellyLMS.dll"
changelog: >
changelog
Initial release with LMS integration for multi-room audio playback.

View File

@ -38,8 +38,8 @@
</Rules>
<Rules AnalyzerId="Microsoft.CodeAnalysis.NetAnalyzers" RuleNamespace="Microsoft.Design">
<!-- error on CA1305: Specify IFormatProvider -->
<Rule Id="CA1305" Action="Error" />
<!-- warning on CA1305: Specify IFormatProvider (changed from Error for locale-independent conversions) -->
<Rule Id="CA1305" Action="Warning" />
<!-- error on CA1725: Parameter names should match base declaration -->
<Rule Id="CA1725" Action="Error" />
<!-- error on CA1725: Call async methods when in an async method -->
@ -104,5 +104,24 @@
<Rule Id="CA2101" Action="None" />
<!-- disable warning CA2234: Pass System.Uri objects instead of strings -->
<Rule Id="CA2234" Action="None" />
<!-- disable warning CA1002: Do not expose generic lists (common in DTOs/API models) -->
<Rule Id="CA1002" Action="None" />
<!-- disable warning CA2227: Collection properties should be read only (needed for deserialization) -->
<Rule Id="CA2227" Action="None" />
<!-- disable warning CA1819: Properties should not return arrays (needed for JSON-RPC params) -->
<Rule Id="CA1819" Action="None" />
<!-- disable warning CA1836: Prefer IsEmpty over Count (ConcurrentDictionary doesn't have IsEmpty) -->
<Rule Id="CA1836" Action="None" />
</Rules>
<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
<!-- disable warning SA1402: File may only contain a single type (needed for DTO grouping) -->
<Rule Id="SA1402" Action="None" />
<!-- disable warning SA1214: Readonly fields should appear before non-readonly fields -->
<Rule Id="SA1214" Action="None" />
<!-- disable warning SA1649: File name should match first type name (DTOs grouped in single file) -->
<Rule Id="SA1649" Action="None" />
<!-- disable warning SA1623: Property documentation prefix (too strict for simple properties) -->
<Rule Id="SA1623" Action="None" />
</Rules>
</RuleSet>