diff options
Diffstat (limited to 'luals-stubs/queue.lua')
| -rw-r--r-- | luals-stubs/queue.lua | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/luals-stubs/queue.lua b/luals-stubs/queue.lua new file mode 100644 index 00000000..0c63b8c1 --- /dev/null +++ b/luals-stubs/queue.lua @@ -0,0 +1,11 @@ +--- @meta + +--- Properties and functions for inspecting and manipulating the track playback queue +--- @class queue +--- @field position Property The index in the queue of the currently playing track. This may be zero if the queue is empty. Writeable. +--- @field size Property The total number of tracks in the queue, including tracks which have already been played. +--- @field replay Property Whether or not the queue will be restarted after the final track is played. Writeable. +--- @field random 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. Writeable. +local queue = {} + +return queue |