summaryrefslogtreecommitdiff
path: root/ldoc-stubs/queue.lua
diff options
context:
space:
mode:
authorjacqueline <me@jacqueline.id.au>2024-01-05 17:15:47 +1100
committerjacqueline <me@jacqueline.id.au>2024-01-05 17:15:47 +1100
commite12a68a74d9527d4becde122da4ff1ad6550564e (patch)
tree1d987e513efe693bc48817acbc0e89d7db044828 /ldoc-stubs/queue.lua
parentaa1dd3d522aa60c2e8ec31ccc49b3459b4f0f8e2 (diff)
downloadtangara-fw-e12a68a74d9527d4becde122da4ff1ad6550564e.tar.gz
split lua stubs into one set for ldoc, and one set for lua-ls
Diffstat (limited to 'ldoc-stubs/queue.lua')
-rw-r--r--ldoc-stubs/queue.lua22
1 files changed, 22 insertions, 0 deletions
diff --git a/ldoc-stubs/queue.lua b/ldoc-stubs/queue.lua
new file mode 100644
index 00000000..83849624
--- /dev/null
+++ b/ldoc-stubs/queue.lua
@@ -0,0 +1,22 @@
+--- Properties and functions for inspecting and manipulating the track playback queue
+-- @module queue
+
+local queue = {}
+
+--- The index in the queue of the currently playing track. This may be zero if the queue is empty.
+-- @see types.Property
+queue.position = types.Property
+
+--- The total number of tracks in the queue, including tracks which have already been played.
+-- @see types.Property
+queue.size = types.Property
+
+--- Determines whether or not the queue will be restarted after the final track is played.
+-- @see types.Property
+queue.replay = types.Property
+
+--- 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.
+-- @see types.Property
+queue.random = types.Property
+
+return queue