blob: 000c35d3367ca6975a7b2937376e441d9b5a8dc9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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
|
