output config API & command line

src/Client/ActiveOutputInfo.cs

@@ -0,0 +1,17 @@
+namespace Beefweb.Client;
+
+/// <summary>
+/// Information about active output device.
+/// </summary>
+public sealed class ActiveOutputInfo
+{
+    /// <summary>
+    /// Output type type id.
+    /// </summary>
+    public string TypeId { get; set; } = null!;
+
+    /// <summary>
+    /// Output device id.
+    /// </summary>
+    public string DeviceId { get; set; } = null!;
+}

src/Client/IPlayerClient.cs

@@ -369,6 +369,22 @@ ValueTask SortPlaylist(
     /// <returns>Request task.</returns>
     ValueTask SortPlaylistRandomly(PlaylistRef playlist, CancellationToken cancellationToken = default);
 
+    /// <summary>
+    /// Gets information about output devices.
+    /// </summary>
+    /// <param name="cancellationToken">Cancellation token.</param>
+    /// <returns>Request task.</returns>
+    ValueTask<OutputsInfo> GetOutputs(CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Sets output device.
+    /// </summary>
+    /// <param name="typeId">Output type id. If this value is null, current output type is not changed.</param>
+    /// <param name="deviceId">Output device id.</param>
+    /// <param name="cancellationToken">Cancellation token.</param>
+    /// <returns>Request task.</returns>
+    ValueTask SetOutputDevice(string? typeId, string deviceId, CancellationToken cancellationToken = default);
+
     // File browser API
 
     /// <summary>

src/Client/IPlayerQuery.cs

@@ -46,6 +46,12 @@ IPlayerQuery IncludePlaylistItems(
     /// <returns>Configured query.</returns>
     IPlayerQuery IncludePlayQueue(IReadOnlyList<string>? columns = null);
 
+    /// <summary>
+    /// Configures query to include outputs configuration.
+    /// </summary>
+    /// <returns>Configured query.</returns>
+    IPlayerQuery IncludeOutputs();
+
     /// <summary>
     /// Executes this query and returns player information.
     /// </summary>

src/Client/OutputDeviceInfo.cs

@@ -0,0 +1,17 @@
+namespace Beefweb.Client;
+
+/// <summary>
+/// Information about output device.
+/// </summary>
+public sealed class OutputDeviceInfo
+{
+    /// <summary>
+    /// Output device id.
+    /// </summary>
+    public string Id { get; set; } = null!;
+
+    /// <summary>
+    /// Output device name.
+    /// </summary>
+    public string Name { get; set; } = null!;
+}

src/Client/OutputTypeInfo.cs

@@ -0,0 +1,24 @@
+using System.Collections.Generic;
+
+namespace Beefweb.Client;
+
+/// <summary>
+/// Information about output device type.
+/// </summary>
+public sealed class OutputTypeInfo
+{
+    /// <summary>
+    /// Output type id.
+    /// </summary>
+    public string Id { get; set; } = null!;
+
+    /// <summary>
+    /// Output type name.
+    /// </summary>
+    public string Name { get; set; } = null!;
+
+    /// <summary>
+    /// Available output devices.
+    /// </summary>
+    public IList<OutputDeviceInfo> Devices { get; set; } = null!;
+}

src/Client/OutputsInfo.cs

@@ -0,0 +1,24 @@
+using System.Collections.Generic;
+
+namespace Beefweb.Client;
+
+/// <summary>
+/// Information about audio outputs.
+/// </summary>
+public sealed class OutputsInfo
+{
+    /// <summary>
+    /// Information about active output device.
+    /// </summary>
+    public ActiveOutputInfo Active { get; set; } = null!;
+
+    /// <summary>
+    /// Available output device types.
+    /// </summary>
+    public IList<OutputTypeInfo> Types { get; set; } = null!;
+
+    /// <summary>
+    /// If true player supports multiple output types.
+    /// </summary>
+    public bool SupportsMultipleOutputTypes { get; set; }
+}

src/Client/PlayerClient.cs

@@ -394,6 +394,20 @@ await _handler
             .ConfigureAwait(false);
     }
 
+    /// <inheritdoc />
+    public async ValueTask<OutputsInfo> GetOutputs(CancellationToken cancellationToken = default)
+    {
+        var result = await _handler.Get<PlayerQueryResult>("api/outputs", null, cancellationToken).ConfigureAwait(false);
+        return result.Outputs ?? throw PropertyIsNull("outputs");
+    }
+
+    /// <inheritdoc />
+    public async ValueTask SetOutputDevice(string? typeId, string deviceId,
+        CancellationToken cancellationToken = default)
+    {
+        await _handler.Post("api/outputs/active", new { typeId, deviceId }, cancellationToken).ConfigureAwait(false);
+    }
+
     // File browser API
 
     /// <inheritdoc />

src/Client/PlayerQuery.cs

@@ -14,6 +14,7 @@ internal sealed class PlayerQuery : IPlayerQuery
     private bool _includePlayQueue;
     private bool _includePlaylists;
     private bool _includePlaylistItems;
+    private bool _includeOutputs;
     private bool _hasPlaylistItemsParameters;
     private IReadOnlyList<string>? _activeItemColumns;
     private IReadOnlyList<string>? _playQueueColumns;
@@ -63,6 +64,12 @@ public IPlayerQuery IncludePlayQueue(IReadOnlyList<string>? columns = null)
         return this;
     }
 
+    public IPlayerQuery IncludeOutputs()
+    {
+        _includeOutputs = true;
+        return this;
+    }
+
     public async ValueTask<PlayerQueryResult> Execute(CancellationToken cancellationToken = default)
     {
         return await _handler
@@ -123,6 +130,11 @@ private QueryParameterCollection BuildQuery(bool wantPlaylistItemsParameters)
             }
         }
 
+        if (_includeOutputs)
+        {
+            query["outputs"] = true;
+        }
+
         if (query.Count == 0)
         {
             throw new InvalidOperationException(

src/Client/PlayerQueryResult.cs

@@ -27,4 +27,9 @@ public sealed class PlayerQueryResult
     /// Play queue contents.
     /// </summary>
     public IList<PlayQueueItemInfo>? PlayQueue { get; set; }
+
+    /// <summary>
+    /// Outputs configuration.
+    /// </summary>
+    public OutputsInfo? Outputs { get; set; }
 }

src/CommandLineTool/Commands/OutputCommand.cs

@@ -0,0 +1,100 @@
+using System;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Beefweb.Client;
+using Beefweb.CommandLineTool.Services;
+using McMaster.Extensions.CommandLineUtils;
+
+namespace Beefweb.CommandLineTool.Commands;
+
+[Command("outputs", "out", Description = "Show information about output devices or change output device")]
+public class OutputCommand(IClientProvider clientProvider, IConsole console, ITabularWriter writer)
+    : ServerCommandBase(clientProvider)
+{
+    [Option("-a|--all", Description = "Print all available output devices")]
+    public bool All { get; set; }
+
+    [Option("-t|--set-type", Description = "Set new output type")]
+    public string? TypeId { get; set; }
+
+    [Option("-d|--set-device", Description = "Set new output device")]
+    public string? DeviceId { get; set; }
+
+    public override async Task OnExecuteAsync(CancellationToken ct)
+    {
+        await base.OnExecuteAsync(ct);
+
+        var outputs = await Client.GetOutputs(ct);
+
+        if (DeviceId != null)
+        {
+            await SetOutputDevice(outputs, ct);
+            return;
+        }
+
+        if (TypeId != null)
+        {
+            throw new InvalidRequestException("Invalid option combination: --set-type requires --set-device.");
+        }
+
+        if (All)
+            PrintAll(outputs);
+        else
+            PrintCurrent(outputs);
+    }
+
+    private void PrintAll(OutputsInfo outputs)
+    {
+        foreach (var type in outputs.Types)
+        {
+            var isCurrentType = type.Id == outputs.Active.TypeId;
+            var rows = Enumerable.Empty<string[]>();
+
+            if (outputs.SupportsMultipleOutputTypes)
+            {
+                rows = rows.Concat([
+                    [" ", type.Id, type.Name],
+                    [" ", "---", "---"]
+                ]);
+            }
+
+            rows = rows.Concat(type.Devices.Select(d => (string[]) [
+                isCurrentType && d.Id == outputs.Active.DeviceId ? "*" : " ",
+                d.Id,
+                d.FormatDeviceName()
+            ]));
+
+            writer.WriteTable(rows.ToList());
+            console.WriteLine();
+        }
+    }
+
+    private void PrintCurrent(OutputsInfo outputs)
+    {
+        var currentType = outputs.Types.First(c => c.Id == outputs.Active.TypeId);
+        var currentDevice = currentType.Devices.First(c => c.Id == outputs.Active.DeviceId);
+
+        var rows = Enumerable.Empty<string[]>();
+
+        if (outputs.SupportsMultipleOutputTypes)
+            rows = rows.Append([currentType.Id, currentType.Name]);
+
+        rows = rows.Append([currentDevice.Id, currentDevice.FormatDeviceName()]);
+
+        writer.WriteTable(rows.ToList());
+    }
+
+    private async ValueTask SetOutputDevice(OutputsInfo outputs, CancellationToken ct)
+    {
+        var type = TypeId != null
+            ? outputs.Types.FirstOrDefault(c => string.Equals(c.Id, TypeId, StringComparison.OrdinalIgnoreCase))
+              ?? throw new InvalidRequestException($"Unknown output type: {TypeId}.")
+            : outputs.Types.First(c => c.Id == outputs.Active.TypeId);
+
+        var device = type.Devices.FirstOrDefault(c => string.Equals(c.Id, DeviceId, StringComparison.OrdinalIgnoreCase))
+                     ?? throw new InvalidRequestException($"Unknown output device: {DeviceId}.");
+
+        await Client.SetOutputDevice(type.Id, device.Id, ct);
+    }
+}

src/CommandLineTool/Program.cs

@@ -26,6 +26,7 @@ namespace Beefweb.CommandLineTool;
 [Subcommand(typeof(SortCommand))]
 [Subcommand(typeof(ServersCommand))]
 [Subcommand(typeof(PlaylistsCommand))]
+[Subcommand(typeof(OutputCommand))]
 [Subcommand(typeof(QueueCommand))]
 [Subcommand(typeof(StatusCommand))]
 [Subcommand(typeof(NowPlayingCommand))]

src/CommandLineTool/Services/ValueFormatter.cs

@@ -66,6 +66,11 @@ public static string Format(this VolumeInfo volumeInfo)
         };
     }
 
+    public static string FormatDeviceName(this OutputDeviceInfo device)
+    {
+        return device.Name.Replace("\n", " ");
+    }
+
     public static string FormatAsTrackTime(this TimeSpan time)
     {
         return time.Ticks switch