Client: play queue support

Author: hyperblast

src/Client/IPlayerClient.cs

@@ -153,6 +153,53 @@ ValueTask<PlayerState> GetPlayerState(
     /// <returns>Request task.</returns>
     ValueTask SeekRelative(TimeSpan offset, CancellationToken cancellationToken = default);
 
+    // Playback queue API
+
+    /// <summary>
+    /// Gets play queue with optional columns.
+    /// </summary>
+    /// <param name="columns">Play queue item columns.</param>
+    /// <param name="cancellationToken">Cancellation token.</param>
+    /// <returns>Request task.</returns>
+    ValueTask<IList<PlayQueueItemInfo>> GetPlayQueue(
+        IReadOnlyList<string>? columns = null, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Add specified item to play queue.
+    /// By default items are added at the end of the queue.
+    /// </summary>
+    /// <param name="playlist">Playlist to use.</param>
+    /// <param name="itemIndex">Index of item to add.</param>
+    /// <param name="queueIndex">Queue index to insert item at (DeaDBeeF only).</param>
+    /// <param name="cancellationToken">Cancellation token.</param>
+    /// <returns>Request task.</returns>
+    ValueTask AddToPlayQueue(PlaylistRef playlist, int itemIndex, int? queueIndex = null,
+        CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Removes specified item from play queue.
+    /// </summary>
+    /// <param name="queueIndex">Item index in queue.</param>
+    /// <param name="cancellationToken">Cancellation token.</param>
+    /// <returns>Request task.</returns>
+    ValueTask RemoveFromPlayQueue(int queueIndex, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Removes specified item from play queue.
+    /// </summary>
+    /// <param name="playlist">Playlist to use.</param>
+    /// <param name="itemIndex">Item index to remove.</param>
+    /// <param name="cancellationToken">Cancellation token.</param>
+    /// <returns>Request task.</returns>
+    ValueTask RemoveFromPlayQueue(PlaylistRef playlist, int itemIndex, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Removes all items from play queue.
+    /// </summary>
+    /// <param name="cancellationToken">Cancellation token.</param>
+    /// <returns>Request task.</returns>
+    ValueTask ClearPlayQueue(CancellationToken cancellationToken = default);
+
     // Playlists API
 
     /// <summary>

src/Client/IPlayerQuery.cs

@@ -32,6 +32,13 @@ public interface IPlayerQuery
     IPlayerQuery IncludePlaylistItems(
         PlaylistRef playlist, PlaylistItemRange itemRange, IReadOnlyList<string> itemColumns);
 
+    /// <summary>
+    /// Configures query to include play queue.
+    /// </summary>
+    /// <param name="columns">List of columns of queued items to return.</param>
+    /// <returns>Configured query.</returns>
+    IPlayerQuery IncludePlayQueue(IReadOnlyList<string>? columns = null);
+
     /// <summary>
     /// Executes this query and returns player information.
     /// </summary>

src/Client/PlayQueueItemInfo.cs

@@ -0,0 +1,29 @@
+using System.Collections.Generic;
+
+namespace Beefweb.Client;
+
+/// <summary>
+/// Play queue item information.
+/// </summary>
+public sealed class PlayQueueItemInfo
+{
+    /// <summary>
+    /// Playlist index.
+    /// </summary>
+    public int PlaylistIndex { get; set; }
+
+    /// <summary>
+    /// Playlist id.
+    /// </summary>
+    public string PlaylistId { get; set; } = null!;
+
+    /// <summary>
+    /// Item index in playlist.
+    /// </summary>
+    public int ItemIndex { get; set; }
+
+    /// <summary>
+    /// Requested item columns.
+    /// </summary>
+    public IList<string> Columns { get; set; } = null!;
+}

src/Client/PlayerClient.cs

@@ -51,7 +51,7 @@ public async ValueTask<PlayerState> GetPlayerState(
         IReadOnlyList<string>? activeItemColumns = null,
         CancellationToken cancellationToken = default)
     {
-        var queryParams = activeItemColumns?.Count > 0
+        var queryParams = activeItemColumns is { Count: > 0 }
             ? new QueryParameterCollection { ["columns"] = activeItemColumns }
             : null;
 
@@ -174,6 +174,55 @@ await SetPlayerState(new SetPlayerStateRequest { RelativePosition = offset }, ca
             .ConfigureAwait(false);
     }
 
+    // Playback queue API
+
+    /// <inheritdoc />
+    public async ValueTask<IList<PlayQueueItemInfo>> GetPlayQueue(
+        IReadOnlyList<string>? columns = null, CancellationToken cancellationToken = default)
+    {
+        var queryParams = columns is { Count: > 0 }
+            ? new QueryParameterCollection { ["columns"] = columns }
+            : null;
+
+        var result = await _handler
+            .Get<PlayerQueryResult>("api/playqueue", queryParams, cancellationToken)
+            .ConfigureAwait(false);
+
+        return result.PlayQueue ?? throw PropertyIsNull("playlistItems");
+    }
+
+    /// <inheritdoc />
+    public async ValueTask AddToPlayQueue(PlaylistRef playlist, int itemIndex, int? queueIndex = null,
+        CancellationToken cancellationToken = default)
+    {
+        var body = queueIndex != null
+            ? new { plref = playlist.GetValue(), itemIndex, queueIndex }
+            : (object) new { plref = playlist.GetValue(), itemIndex };
+
+        await _handler.Post("api/playqueue/add", body, cancellationToken).ConfigureAwait(false);
+    }
+
+    /// <inheritdoc />
+    public async ValueTask RemoveFromPlayQueue(int queueIndex, CancellationToken cancellationToken = default)
+    {
+        await _handler.Post("api/playqueue/remove", new { queueIndex }, cancellationToken).ConfigureAwait(false);
+    }
+
+    /// <inheritdoc />
+    public async ValueTask RemoveFromPlayQueue(
+        PlaylistRef playlist, int itemIndex, CancellationToken cancellationToken = default)
+    {
+        await _handler
+            .Post("api/playqueue/remove", new { plref = playlist.GetValue(), itemIndex }, cancellationToken)
+            .ConfigureAwait(false);
+    }
+
+    /// <inheritdoc />
+    public async ValueTask ClearPlayQueue(CancellationToken cancellationToken = default)
+    {
+        await _handler.Post("api/playqueue/clear", null, cancellationToken).ConfigureAwait(false);
+    }
+
     // Playlists API
 
     /// <inheritdoc />

src/Client/PlayerQuery.cs

@@ -11,9 +11,11 @@ internal sealed class PlayerQuery : IPlayerQuery
     private readonly IRequestHandler _handler;
 
     private bool _includePlayer;
+    private bool _includePlayQueue;
     private bool _includePlaylists;
     private bool _includePlaylistItems;
     private IReadOnlyList<string>? _activeItemColumns;
+    private IReadOnlyList<string>? _playQueueColumns;
     private IReadOnlyList<string>? _playlistItemColumns;
     private PlaylistRef _playlist;
     private PlaylistItemRange _playlistItemRange;
@@ -46,6 +48,13 @@ public IPlayerQuery IncludePlaylistItems(
         return this;
     }
 
+    public IPlayerQuery IncludePlayQueue(IReadOnlyList<string>? columns = null)
+    {
+        _includePlayQueue = true;
+        _playQueueColumns = columns;
+        return this;
+    }
+
     public ValueTask<PlayerQueryResult> Execute(CancellationToken cancellationToken = default)
     {
         return _handler.Get<PlayerQueryResult>("api/query", BuildQuery(), cancellationToken);
@@ -69,10 +78,18 @@ private QueryParameterCollection BuildQuery()
         {
             query["player"] = true;
 
-            if (_activeItemColumns?.Count > 0)
+            if (_activeItemColumns is { Count: > 0 })
                 query["trcolumns"] = _activeItemColumns;
         }
 
+        if (_includePlayQueue)
+        {
+            query["playQueue"] = true;
+
+            if (_playQueueColumns is { Count: > 0 })
+                query["qcolumns"] = _playQueueColumns;
+        }
+
         if (_includePlaylists)
         {
             query["playlists"] = true;
@@ -84,7 +101,7 @@ private QueryParameterCollection BuildQuery()
             query["plref"] = _playlist;
             query["plrange"] = _playlistItemRange;
 
-            if (_playlistItemColumns?.Count > 0)
+            if (_playlistItemColumns is { Count: > 0 })
                 query["plcolumns"] = _playlistItemColumns;
         }
 

src/Client/PlayerQueryResult.cs

@@ -1,3 +1,4 @@
+using System.Collections;
 using System.Collections.Generic;
 
 namespace Beefweb.Client;
@@ -21,4 +22,9 @@ public sealed class PlayerQueryResult
     /// Requested playlist items.
     /// </summary>
     public PlaylistItemsResult? PlaylistItems { get; set; }
-}
+
+    /// <summary>
+    /// Play queue contents.
+    /// </summary>
+    public IList<PlayQueueItemInfo>? PlayQueue { get; set; }
+}