Queue

The Queue manages tracks for a player.

Accessing the Queue

const player = fuelink.getPlayer(guildId);
const queue = player.queue;

Adding Tracks

Add to End

// Add single track
queue.add(track);

// Add multiple tracks
queue.add([track1, track2, track3]);

Add to Priority Queue

Priority tracks play next, before the main queue.

queue.addPriority(track);

Insert at Position

// Insert at index 2
queue.addAt(track, 2);

Removing Tracks

Remove by Index

// Remove track at index 3
const removed = queue.remove(3);

Remove Range

// Remove tracks from index 2 to 5
queue.removeRange(2, 5);

Clear Queue

// Clear all tracks
queue.clear();

Queue Navigation

Skip to Position

// Jump to track at index 5 (skips tracks 0-4)
await player.queue.jump(5);

Back to Previous

// Go back to previous track
const previous = queue.back();

Queue Manipulation

Shuffle

queue.shuffle();

Move Track

// Move track from index 2 to index 5
queue.move(2, 5);

Swap Tracks

// Swap tracks at index 1 and 4
queue.swap(1, 4);

Loop Modes

import { LoopMode } from 'fuelink';

// Set loop mode
queue.setLoop(LoopMode.OFF);     // No looping
queue.setLoop(LoopMode.TRACK);   // Repeat current track
queue.setLoop(LoopMode.QUEUE);   // Loop entire queue

// Get current mode
console.log(queue.loop);  // 'off', 'track', or 'queue'

// Cycle through modes
const newMode = queue.cycleLoop();  // off -> track -> queue -> off

Queue Properties

Property	Type	Description
current	Track	Currently playing track
previous	Track	Previously played track
tracks	Track[]	Main queue tracks
priorityTracks	Track[]	Priority queue tracks
size	number	Total tracks in queue
duration	number	Total duration (ms)
loop	string	Current loop mode
autoplay	boolean	Auto-play enabled

Accessing Tracks

Get All Upcoming

const upcoming = queue.upcoming;  // Priority + main queue

Get by Index

const track = queue.at(3);  // Get track at index 3

Find Track

const track = queue.find(t => t.title.includes('Never Gonna'));

Search Queue

const results = queue.search('rick astley');

History

Access previously played tracks:

// Get history
const history = queue.history;

// Go back
const previousTrack = queue.back();

Auto-Play

Enable automatic recommendations when queue ends:

// Enable auto-play
queue.autoplay = true;

// Set custom provider
queue.setAutoplayProvider(async (currentTrack) => {
  // Return array of recommended tracks
  const tracks = await fuelink.search(`${currentTrack.author} mix`);
  return tracks.slice(0, 5);
});

// Get auto-play tracks
const recommendations = await queue.getAutoplayTracks();

Serialization

// Export queue state
const data = queue.toJSON();

// Restore queue state
queue.fromJSON(data);

Events

Queue events are emitted on the player:

fuelink.on('queueAdd', ({ player, tracks }) => {
  console.log(`Added ${tracks.length} tracks`);
});

fuelink.on('queueRemove', ({ player, track }) => {
  console.log(`Removed: ${track.title}`);
});

fuelink.on('queueShuffle', ({ player }) => {
  console.log('Queue shuffled');
});

fuelink.on('queueEnd', ({ player }) => {
  console.log('Queue finished');
});