LithiumX / LithiumXQueue
Class: LithiumXQueue
Defined in: src/Structures/Queue.ts:7
The player's queue, the current property is the currently playing track, think of the rest as the up-coming tracks.
Extends
Array<Track|UnresolvedTrack>
Indexable
[n: number]: Track | UnresolvedTrack
Constructors
new LithiumXQueue()
new LithiumXQueue(
arrayLength):LithiumXQueue
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1508
Parameters
arrayLength
number
Returns
LithiumXQueue
Inherited from
Array<Track | UnresolvedTrack>.constructor
new LithiumXQueue()
new LithiumXQueue(...
items):LithiumXQueue
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1509
Parameters
items
...(Track | UnresolvedTrack)[]
Returns
LithiumXQueue
Inherited from
Array<Track | UnresolvedTrack>.constructor
Properties
current
current:
Track|UnresolvedTrack=null
Defined in: src/Structures/Queue.ts:25
The current track
previous
previous:
Track|UnresolvedTrack=null
Defined in: src/Structures/Queue.ts:28
The previous track
Accessors
duration
Get Signature
get duration():
number
Defined in: src/Structures/Queue.ts:9
The total duration of the queue.
Returns
number
size
Get Signature
get size():
number
Defined in: src/Structures/Queue.ts:20
The size of tracks in the queue.
Returns
number
totalSize
Get Signature
get totalSize():
number
Defined in: src/Structures/Queue.ts:15
The total size of tracks in the queue including the current track.
Returns
number
Methods
add()
add(
track,offset?):void
Defined in: src/Structures/Queue.ts:35
Adds a track to the queue.
Parameters
track
Track | UnresolvedTrack | (Track | UnresolvedTrack)[]
offset?
number
Returns
void
clear()
clear():
void
Defined in: src/Structures/Queue.ts:88
Clears the queue.
Returns
void
equalizedShuffle()
equalizedShuffle():
void
Defined in: src/Structures/Queue.ts:100
Returns
void
remove()
Call Signature
remove(
position?): (Track|UnresolvedTrack)[]
Defined in: src/Structures/Queue.ts:69
Removes a track from the queue. Defaults to the first track, returning the removed track, EXCLUDING THE current TRACK.
Parameters
position?
number
Returns
(Track | UnresolvedTrack)[]
Call Signature
remove(
start,end): (Track|UnresolvedTrack)[]
Defined in: src/Structures/Queue.ts:76
Removes an amount of tracks using a exclusive start and end exclusive index, returning the removed tracks, EXCLUDING THE current TRACK.
Parameters
start
number
end
number
Returns
(Track | UnresolvedTrack)[]
shuffle()
shuffle():
void
Defined in: src/Structures/Queue.ts:93
Shuffles the queue.
Returns
void