DisTube

To control playback (skip, pause, stop, etc.), you should first retrieve the Queue object for a specific guild using distube.getQueue(guildId).

Important: Always use methods directly on the queue instance. Shortcut methods on the distube instance are deprecated and will be removed in v6.0.

Available queue methods:

• queue.stop(): Stops the player.
• queue.skip(): Skips the current song.
• queue.pause(): Pauses playback.
• queue.resume(): Resumes playback.
• queue.setVolume(number): Sets volume (0-100).
• queue.shuffle(): Shuffles the queue.
• queue.setRepeatMode(): Sets repeat mode (returns mode index).
• queue.songs: An array of song objects in the queue.

Example:

const queue = distube.getQueue(message.guildId);
if (!queue) return message.channel.send("Nothing is playing!");

await queue.skip();

// Get the queue for the guild
const queue = distube.getQueue(message.guildId);

if (command === "stop") {
  if (!queue) return message.channel.send("Nothing is playing!");
  await queue.stop();
  message.channel.send("Stopped the player!");
}

if (command === "skip") {
  if (!queue) return message.channel.send("Nothing is playing!");
  await queue.skip();
  message.channel.send("Skipped the song!");
}

if (command === "pause") {
  if (!queue) return message.channel.send("Nothing is playing!");
  queue.pause();
  message.channel.send("Paused the song!");
}

if (command === "resume") {
  if (!queue) return message.channel.send("Nothing is playing!");
  queue.resume();
  message.channel.send("Resumed the song!");
}

if (command === "volume") {
  if (!queue) return message.channel.send("Nothing is playing!");
  const volume = parseInt(args[0]);
  if (isNaN(volume) || volume < 0 || volume > 100) {
    return message.channel.send("Please provide a valid volume (0-100)!");
  }
  queue.setVolume(volume);
  message.channel.send(`Volume set to ${volume}%`);
}

if (command === "shuffle") {
  if (!queue) return message.channel.send("Nothing is playing!");
  queue.shuffle();
  message.channel.send("Shuffled the queue!");
}

if (command === "repeat") {
  if (!queue) return message.channel.send("Nothing is playing!");
  const mode = queue.setRepeatMode();
  const modeText = ["Off", "Song", "Queue"][mode];
  message.channel.send(`Repeat mode: ${modeText}`);
}

if (command === "queue") {
  if (!queue) return message.channel.send("Nothing is playing!");
  const songs = queue.songs
    .map((song, i) => `${i === 0 ? "Playing:" : `${i}.`} ${song.name} - \`${song.formattedDuration}\``)
    .join("\n");
  message.channel.send(songs.slice(0, 1990));
}

if (command === "nowplaying" || command === "np") {
  if (!queue) return message.channel.send("Nothing is playing!");
  const song = queue.songs[0];
  message.channel.send(
    `Now playing: ${song.name}\n` +
    `Duration: ${queue.formattedCurrentTime} / ${song.formattedDuration}`
  );
}

To get started with DisTube, install the core library along with the necessary voice dependencies. You must initialize a DisTube instance by passing your discord.js client and an options object.

Note that when using DisTube, your Discord client must have the following GatewayIntentBits enabled:

• Guilds
• GuildVoiceStates
• GuildMessages
• MessageContent

You can listen to events like playSong to interact with the queue and use distube.play() to start music playback in a voice channel.

const { DisTube } = require('distube');
const { Client, GatewayIntentBits } = require('discord.js');

const client = new Client({
  intents: [
    GatewayIntentBits.Guilds,
    GatewayIntentBits.GuildVoiceStates,
    GatewayIntentBits.GuildMessages,
    GatewayIntentBits.MessageContent,
  ],
});

const distube = new DisTube(client, {
  emitNewSongOnly: true,
});

distube.on('playSong', (queue, song) =>
  queue.textChannel.send(`Playing \`${song.name}\` - \`${song.formatDuration()}\``)
);

client.on('messageCreate', message => {
  if (message.content.startsWith('!play')) {
    distube.play(message.member.voice.channel, message.content.slice(6), {
      message,
      textChannel: message.channel,
      member: message.member,
    });
  }
});

client.login('TOKEN');

You can implement an inactivity timer to automatically leave a voice channel after a song finishes. This involves tracking timers in a Map keyed by the queue.id and responding to DisTube events:

1. Events.FINISH: Start a setTimeout that calls queue.voice.leave() after your desired duration.
2. Events.PLAY_SONG: Clear the existing timer for that queue to prevent premature leaving when new music starts.
3. Events.DELETE_QUEUE: Clear the timer to clean up resources when the queue is destroyed.

import { Events } from "distube";

const inactivityTimers = new Map();

// Start timer when queue finishes
distube.on(Events.FINISH, queue => {
  const timer = setTimeout(() => {
    queue.voice.leave();
    inactivityTimers.delete(queue.id);
  }, 5 * 60 * 1000); // 5 minutes

  inactivityTimers.set(queue.id, timer);
});

// Clear timer when new song plays
distube.on(Events.PLAY_SONG, queue => {
  const timer = inactivityTimers.get(queue.id);
  if (timer) {
    clearTimeout(timer);
    inactivityTimers.delete(queue.id);
  }
});

// Clear timer when queue is deleted
distube.on(Events.DELETE_QUEUE, queue => {
  const timer = inactivityTimers.get(queue.id);
  if (timer) {
    clearTimeout(timer);
    inactivityTimers.delete(queue.id);
  }
});