From ca5d7b867c381b7886a660ce744df0b74f38b2e6 Mon Sep 17 00:00:00 2001 From: jacqueline Date: Fri, 8 Dec 2023 11:11:57 +1100 Subject: Add shuffle and repeat options for the playback queue --- src/lua/stubs/queue.lua | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 src/lua/stubs/queue.lua (limited to 'src/lua/stubs/queue.lua') diff --git a/src/lua/stubs/queue.lua b/src/lua/stubs/queue.lua new file mode 100644 index 00000000..000c35d3 --- /dev/null +++ b/src/lua/stubs/queue.lua @@ -0,0 +1,22 @@ +--- Properties and functions for inspecting and manipulating the track playback queue +-- @module queue + +local queue = {} + +--- queue.position returns the index in the queue of the currently playing track. This may be zero if the queue is empty. +-- @treturn types.Property a positive integer property, which is a 1-based index +function queue.position() end + +--- queue.size returns the total number of tracks in the queue, including tracks which have already been played. +-- @treturn types.Property a positive integer property +function queue.size() end + +--- queue.replay determines whether or not the queue will be restarted after the final track is played. +-- @treturn types.Property a writeable boolean property +function queue.replay() end + +--- queue.random determines whether, when progressing to the next track in the queue, the next track will be chosen randomly. The random selection algorithm used is a Miller Shuffle, which guarantees that no repeat selections will be made until every item in the queue has been played. +-- @treturn types.Property a writeable boolean property +function queue.random() end + +return queue \ No newline at end of file -- cgit v1.2.3