Queue
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new Queue()
Defined in
Properties
tracks
• tracks: (Track)[]
Defined in
Accessors
duration
• get duration(): number
Gets the queue duration in milliseconds.
Returns
number
Defined in
size
• get size(): number
Gets the queue size.
Returns
number
Defined in
Methods
add
▸ add(track): void
[Internal] Adds a track to the queue. External users should use Player.addTracks() method instead.
Parameters
| Name | Type | Description |
|---|---|---|
track | Track | The track to add to the queue |
Returns
void
Defined in
clear
▸ clear(): void
Clears the queue.
Returns
void
Defined in
insert
▸ insert(index, track): boolean
Inserts a track at the specified index, moving subsequent tracks back.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index at which to insert the track. |
track | Track | The track to insert. |
Returns
boolean
Throws
Throws an error if the index is out of range.
Defined in
move
▸ move(index1, index2): boolean
Moves a track from one index to another within the queue.
Parameters
| Name | Type | Description |
|---|---|---|
index1 | number | The current index of the track. |
index2 | number | The new index to which the track should be moved. |
Returns
boolean
Returns true if the track was successfully moved, false otherwise.
Defined in
poll
▸ poll(): null | Track
Polls the queue for the next track.
Returns
null | Track
The next track in the queue or null if the queue is empty.
Defined in
remove
▸ remove(): boolean
Removes the first track in the queue.
Returns
boolean
Returns true if the track was successfully removed, false otherwise
Defined in
▸ remove(index): boolean
Removes the track at the specified position.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the track to remove. |
Returns
boolean
Returns true if the track was successfully removed, false otherwise
Defined in
▸ remove(start, end): boolean
Removes the tracks in the specified range.
Parameters
| Name | Type | Description |
|---|---|---|
start | number | The start index of the range. |
end | number | The end index of the range. |
Returns
boolean
Returns true if the tracks were successfully removed, false otherwise
Defined in
shuffle
▸ shuffle(): void
Shuffles the queue
Returns
void
Defined in
skipNTracks
▸ skipNTracks(n): void
Remove the next n tracks from the queue
Parameters
| Name | Type | Description |
|---|---|---|
n | number | The number of tracks to skip |
Returns
void