distube 3.0.0-beta.9 → 3.0.3

package/src/DisTube.js

@@ -1,851 +0,0 @@
-const ytsr = require("@distube/ytsr"),
-  ytpl = require("@distube/ytpl"),
-  { EventEmitter } = require("events"),
-  Queue = require("./Queue"),
-  SearchResult = require("./SearchResult"),
-  Playlist = require("./Playlist"),
-  { isVoiceChannelEmpty } = require("./util"),
-  Discord = require("discord.js"),
-  DisTubeOption = require("./DisTubeOptions"),
-  DisTubeHandler = require("./DisTubeHandler"),
-  Song = require("./Song"),
-  // eslint-disable-next-line no-unused-vars
-  Plugin = require("./Plugin/Plugin"),
-  CustomPlugin = require("./Plugin/CustomPlugin"),
-  ExtractorPlugin = require("./Plugin/ExtractorPlugin");
-
-/**
- * FFmpeg Filters
- * ```
- * {
- *   "Filter Name": "Filter Value",
- *   "bassboost":   "bass=g=10,dynaudnorm=f=150:g=15"
- * }
- * ```
- * @typedef {Object.<string, string>} Filters
- * @see {@link DefaultFilters}
- */
-
-/**
- * DisTube options.
- * @typedef {Object} DisTubeOptions
- * @prop {Array<Plugin>} [plugins] DisTube plugins.
- * @prop {boolean} [emitNewSongOnly=false] If `true`, {@link DisTube#event:playSong} will not be emitted when looping a song or next song is the same as the previous one
- * @prop {boolean} [leaveOnEmpty=true] Whether or not leaving voice channel if channel is empty in 60s. (Avoid accident leaving)
- * @prop {boolean} [leaveOnFinish=false] Whether or not leaving voice channel when the queue ends.
- * @prop {boolean} [leaveOnStop=true] Whether or not leaving voice channel after using {@link DisTube#stop|stop()} function.
- * @prop {boolean} [savePreviousSongs=true] Whether or not saving the previous songs of the queue and enable {@link DisTube#previous|previous()} method
- * @prop {number} [searchSongs=0] Limit of search results emits in {@link DisTube#event:searchResult} event when {@link DisTube#play|play()} method executed. If `searchSongs <= 1`, play the first result
- * @prop {string} [youtubeCookie=null] YouTube cookies. Read how to get it in {@link https://github.com/fent/node-ytdl-core/blob/997efdd5dd9063363f6ef668bb364e83970756e7/example/cookies.js#L6-L12|YTDL's Example}
- * @prop {string} [youtubeIdentityToken=null] If not given; ytdl-core will try to find it. You can find this by going to a video's watch page; viewing the source; and searching for "ID_TOKEN".
- * @prop {boolean} [youtubeDL=true] Whether or not using youtube-dl.
- * @prop {boolean} [updateYouTubeDL=true] Whether or not updating youtube-dl automatically.
- * @prop {Filters} [customFilters] Override {@link DefaultFilters} or add more ffmpeg filters. Example=`{ "Filter name"="Filter value"; "8d"="apulsator=hz=0.075" }`
- * @prop {Object} [ytdlOptions] `ytdl-core` options
- * @prop {number} [searchCooldown=60] Built-in search cooldown in seconds (When searchSongs is bigger than 0)
- * @prop {number} [emptyCooldown=60] Built-in leave on empty cooldown in seconds (When leaveOnEmpty is true)
- * @prop {boolean} [nsfw=false] Whether or not playing age-restricted content in non-NSFW channel
- */
-
-/**
- * DisTube class
- * @extends EventEmitter
- */
-class DisTube extends EventEmitter {
-  /**
-   * DisTube's current version.
-   * @type {string}
-   */
-  get version() { return require("../package.json").version }
-  static get version() { return require("../package.json").version }
-  /**
-   * Create a new DisTube class.
-   * @param {Discord.Client} client Discord.JS client
-   * @param {DisTubeOptions} [otp] Custom DisTube options
-   * @example
-   * const Discord = require('discord.js'),
-   *     DisTube = require('distube'),
-   *     client = new Discord.Client();
-   * // Create a new DisTube
-   * const distube = new DisTube(client, { searchSongs: 10 });
-   * // client.DisTube = distube // make it access easily
-   * client.login("Your Discord Bot Token")
-   */
-  constructor(client, otp = {}) {
-    super();
-    if (!client || typeof client.user === "undefined") throw new TypeError("Invalid Discord.Client");
-
-    /**
-     * Discord.JS client
-     * @type {Discord.Client}
-     */
-    this.client = client;
-
-    /**
-     * Collection of guild queues
-     * @type {Discord.Collection<string, Queue>}
-     */
-    this.guildQueues = new Discord.Collection();
-
-    /**
-     * DisTube options
-     * @type {DisTubeOptions}
-     */
-    this.options = new DisTubeOption(otp);
-
-    /**
-     * DisTube's Handler
-     * @type {DisTubeHandler}
-     * @private
-     */
-    this.handler = new DisTubeHandler(this);
-
-    /**
-     * DisTube filters
-     * @type {Filters}
-     */
-    this.filters = require("./Filter");
-    if (typeof this.options.customFilters === "object") Object.assign(this.filters, this.options.customFilters);
-
-    if (this.options.leaveOnEmpty) {
-      client.on("voiceStateUpdate", oldState => {
-        const queue = this.guildQueues.find(gQueue => gQueue.connection && gQueue.connection.channel.id === oldState.channelID);
-        if (!queue) return;
-        if (oldState?.channel) {
-          if (queue.emptyTimeout) {
-            clearTimeout(queue.emptyTimeout);
-            queue.emptyTimeout = null;
-          }
-          if (isVoiceChannelEmpty(queue)) {
-            queue.emptyTimeout = setTimeout(() => {
-              const guildID = queue.connection.channel.guild.id;
-              if (this.guildQueues.has(guildID) && isVoiceChannelEmpty(queue)) {
-                queue.connection.channel.leave();
-                this.emit("empty", queue);
-                this._deleteQueue(queue);
-              }
-            }, this.options.emptyCooldown * 1000);
-          }
-        }
-      });
-    }
-
-    if (this.options.updateYouTubeDL) {
-      require("@distube/youtube-dl/src/download")()
-        .then(version => console.log(`[DisTube] Updated youtube-dl to ${version}!`))
-        .catch(console.error)
-        .catch(() => console.log("[DisTube] Unable to update youtube-dl, using default version."));
-    }
-
-    // Default plugin
-    const HTTPPlugin = require("./Plugin/http"),
-      HTTPSPlugin = require("./Plugin/https");
-    this.options.plugins.push(new HTTPPlugin(), new HTTPSPlugin());
-    this.options.plugins.map(p => p.init(this));
-    /**
-     * Extractor Plugins
-     * @type {Array<ExtractorPlugin>}
-     * @private
-     */
-    this.extractorPlugins = this.options.plugins.filter(p => p.type === "extractor");
-    /**
-     * Custom Plugins
-     * @type {Array<CustomPlugin>}
-     * @private
-     */
-    this.customPlugins = this.options.plugins.filter(p => p.type === "custom");
-  }
-
-  /**
-   * Play / add a song or playlist from url. Search and play a song if it is not a valid url.
-   * Emit {@link DisTube#addList}, {@link DisTube#addSong} or {@link DisTube#playSong} after executing
-   * @returns {Promise<void>}
-   * @param {Discord.Message} message A message from guild channel
-   * @param {string|Song|SearchResult|Playlist} song YouTube url | Search string | {@link Song} | {@link SearchResult} | {@link Playlist}
-   * @param {boolean} skip Whether or not skipping the playing song
-   * @example
-   * client.on('message', (message) => {
-   *     if (!message.content.startsWith(config.prefix)) return;
-   *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-   *     const command = args.shift();
-   *     if (command == "play")
-   *         distube.play(message, args.join(" "));
-   * });
-   */
-  async play(message, song, skip = false) {
-    if (!song) return;
-    if (!(message instanceof Discord.Message)) throw new TypeError("message is not a Discord.Message.");
-    if (typeof skip !== "boolean") throw new TypeError("skip is not a boolean");
-    try {
-      const voiceChannel = message.member.voice.channel;
-      if (!voiceChannel) throw new Error("User is not in any voice channel.");
-      await this.playVoiceChannel(voiceChannel, song, {
-        member: message.member,
-        textChannel: message.channel,
-        skip,
-      });
-    } catch (e) {
-      e.name = "PlayError";
-      e.message = `${song?.url || song}\n${e.message}`;
-      this.emitError(message.channel, e);
-    }
-  }
-
-  /**
-   * Play / add a song or playlist from url. Search and play a song if it is not a valid url.
-   * Emit {@link DisTube#addList}, {@link DisTube#addSong} or {@link DisTube#playSong} after executing
-   * @returns {Promise<void>}
-   * @param {Discord.VoiceChannel|Discord.StageChannel} voiceChannel The voice channel will be joined
-   * @param {string|Song|SearchResult|Playlist} song YouTube url | Search string | {@link Song} | {@link SearchResult} | {@link Playlist}
-   * @param {Object} [options] Optional options
-   * @param {Discord.GuildMember} [options.member] Requested user (default is your bot)
-   * @param {Discord.TextChannel} [options.textChannel] Default {@link Queue#textChannel} (if the queue wasn't created)
-   * @param {boolean} [options.skip] Skip the playing song (if exists)
-   */
-  async playVoiceChannel(voiceChannel, song, options = {}) {
-    if (!["voice", "stage"].includes(voiceChannel?.type)) {
-      throw new TypeError("voiceChannel is not a Discord.VoiceChannel or a Discord.StageChannel.");
-    }
-    const { textChannel, member, skip } = Object.assign({
-      member: voiceChannel.guild.me,
-      skip: false,
-    }, options);
-    try {
-      if (typeof song === "string") {
-        for (const plugin of this.customPlugins) {
-          if (await plugin.validate(song)) {
-            await plugin.play(voiceChannel, song, member, textChannel, skip);
-            return;
-          }
-        }
-      }
-      if (song instanceof SearchResult && song.type === "playlist") song = song.url;
-      if (ytpl.validateID(song)) song = await this.handler.resolvePlaylist(member, song);
-      song = await this.handler.resolveSong(member, song);
-      if (!song) return;
-      if (song instanceof Playlist) await this.handler.handlePlaylist(voiceChannel, song, textChannel, skip);
-      else if (!this.options.nsfw && song.age_restricted && !textChannel?.nsfw) {
-        throw new Error("Cannot play age-restricted content in non-NSFW channel.");
-      } else {
-        let queue = this.getQueue(voiceChannel);
-        if (queue) {
-          queue.addToQueue(song, skip);
-          if (skip) queue.skip();
-          else this.emit("addSong", queue, song);
-        } else {
-          queue = await this._newQueue(voiceChannel, song, textChannel);
-          if (queue instanceof Queue) this.emit("playSong", queue, song);
-        }
-      }
-    } catch (e) {
-      e.name = "PlayError";
-      e.message = `${song?.url || song}\n${e.message}`;
-      this.emitError(textChannel, e);
-    }
-  }
-
-  /**
-   * Skip the playing song and play a song or playlist
-   * @returns {Promise<void>}
-   * @param {Discord.Message} message A message from guild channel
-   * @param {string|Song|SearchResult|Playlist} song YouTube url | Search string | {@link Song} | {@link SearchResult} | {@link Playlist}
-   * @example
-   * client.on('message', (message) => {
-   *     if (!message.content.startsWith(config.prefix)) return;
-   *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-   *     const command = args.shift();
-   *     if (command == "playSkip")
-   *         distube.playSkip(message, args.join(" "));
-   * });
-   */
-  playSkip(message, song) {
-    return this.play(message, song, true);
-  }
-
-  /**
-   * Play or add array of video urls.
-   * {@link DisTube#event:playList} or {@link DisTube#event:addList} will be emitted
-   * with `playlist`'s properties include `properties` parameter's properties such as
-   * `user`, `songs`, `duration`, `formattedDuration`, `thumbnail` like {@link Playlist}
-   * @returns {Promise<void>}
-   * @param {Discord.Message} message A message from guild channel
-   * @param {Array<string|Song|SearchResult>} songs Array of url, Song or SearchResult
-   * @param {Object} [properties={}] Additional properties such as `name`
-   * @param {boolean} [playSkip=false] Whether or not play this playlist instantly
-   * @param {boolean} [parallel=true] Whether or not fetch the songs in parallel
-   * @example
-   *     let songs = ["https://www.youtube.com/watch?v=xxx", "https://www.youtube.com/watch?v=yyy"];
-   *     distube.playCustomPlaylist(message, songs, { name: "My playlist name" });
-   *     // Fetching custom playlist sequentially (reduce lag for low specs)
-   *     distube.playCustomPlaylist(message, songs, { name: "My playlist name" }, false, false);
-   */
-  async playCustomPlaylist(message, songs, properties = {}, playSkip = false, parallel = true) {
-    try {
-      const playlist = this.handler.createCustomPlaylist(message, songs, properties, parallel);
-      await this.handler.handlePlaylist(message, playlist, playSkip);
-    } catch (e) {
-      this.emitError(message.channel, e);
-    }
-  }
-
-  /**
-   * Search for a song.
-   * You can customize how user answers instead of send a number.
-   * Then use {@link DisTube#play|play(message, aResultFromSearch)} or {@link DisTube#playSkip|playSkip()} to play it.
-   * @param {string} string The string search for
-   * @param {Object} options Search options
-   * @param {number} [options.limit=10] Limit the results
-   * @param {'video'|'playlist'} [options.type='video'] Type of search (`video` or `playlist`).
-   * @param {boolean} [options.safeSearch=false] Type of search (`video` or `playlist`).
-   * @param {boolean} retried Retried?
-   * @throws {Error}
-   * @returns {Promise<Array<SearchResult>>} Array of results
-   */
-  async search(string, options = {}, retried = false) {
-    const opts = Object.assign({ type: "video", limit: 10, safeSearch: false }, options);
-    if (typeof opts.type !== "string" || !["video", "playlist"].includes(opts.type)) throw new Error("options.type must be 'video' or 'playlist'.");
-    if (typeof opts.limit !== "number") throw new Error("options.limit must be a number");
-    if (opts.limit < 1) throw new Error("option.limit must be bigger or equal to 1");
-    if (typeof opts.safeSearch !== "boolean") throw new TypeError("options.safeSearch must be a boolean.");
-
-    try {
-      const search = await ytsr(string, opts);
-      const results = search.items.map(i => new SearchResult(i));
-      if (results.length === 0) throw Error("No result!");
-      return results;
-    } catch (e) {
-      if (retried) throw e;
-      return this.search(string, options, true);
-    }
-  }
-
-  /**
-   * Create a new guild queue
-   * @private
-   * @param {Discord.Message|Discord.VoiceChannel|Discord.StageChannel} message A message from guild channel | a voice channel
-   * @param {Song|Array<Song>} song Song to play
-   * @param {Discord.TextChannel} textChannel A text channel of the queue
-   * @throws {Error}
-   * @returns {Promise<Queue|true>} `true` if queue is not generated
-   */
-  _newQueue(message, song, textChannel = message?.channel) {
-    const voice = message?.member?.voice?.channel || message;
-    if (!voice || voice instanceof Discord.Message) throw new Error("User is not in a voice channel.");
-    if (!["voice", "stage"].includes(voice?.type)) {
-      throw new TypeError("User is not in a Discord.VoiceChannel or a Discord.StageChannel.");
-    }
-    const queue = new Queue(this, message, song, textChannel);
-    this.emit("initQueue", queue);
-    this.guildQueues.set(message.guild.id, queue);
-    return this.handler.joinVoiceChannel(queue, voice);
-  }
-
-  /**
-   * Delete a guild queue
-   * @private
-   * @param {Discord.Snowflake|Discord.Message|Queue} queue A message from guild channel | Queue
-   */
-  _deleteQueue(queue) {
-    if (!(queue instanceof Queue)) queue = this.getQueue(queue);
-    if (!queue) return;
-    this.emit("deleteQueue", queue);
-    if (queue.dispatcher) try { queue.dispatcher.destroy() } catch { }
-    if (queue.stream) try { queue.stream.destroy() } catch { }
-    this.guildQueues.delete(queue.id);
-  }
-
-  /**
-   * Get the guild queue
-   * @param {Discord.Snowflake|Discord.Message|Discord.VoiceChannel|Discord.StageChannel} message A guild ID | a message from guild channel | a voice channel.
-   * @returns {Queue} The guild queue
-   * @throws {Error}
-   * @example
-   * client.on('message', (message) => {
-   *     if (!message.content.startsWith(config.prefix)) return;
-   *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-   *     const command = args.shift();
-   *     if (command == "queue") {
-   *         const queue = distube.getQueue(message);
-   *         message.channel.send('Current queue:\n' + queue.songs.map((song, id) =>
-   *             `**${id+1}**. [${song.name}](${song.url}) - \`${song.formattedDuration}\``
-   *         ).join("\n"));
-   *     }
-   * });
-   */
-  getQueue(message) {
-    const guildID = message?.guild?.id || message;
-    if (typeof guildID !== "string") throw TypeError("Parameter should be a Discord.Message, a Discord.VoiceChannel or a server ID!");
-    return this.guildQueues.get(guildID);
-  }
-
-  /**
-   * Pause the guild stream
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel
-   * @returns {Queue} The guild queue
-   * @throws {Error}
-   */
-  pause(message) {
-    const queue = this.getQueue(message);
-    if (!queue) throw new Error("Cannot find the playing queue.");
-    return queue.pause();
-  }
-
-  /**
-   * Resume the guild stream
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel
-   * @returns {Queue} The guild queue
-   * @throws {Error}
-   */
-  resume(message) {
-    const queue = this.getQueue(message);
-    if (!queue) throw new Error("Cannot find the playing queue.");
-    return queue.resume();
-  }
-
-  /**
-   * Stop the guild stream
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel or Queue
-   * @throws {Error}
-   * @example
-   * client.on('message', (message) => {
-   *     if (!message.content.startsWith(config.prefix)) return;
-   *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-   *     const command = args.shift();
-   *     if (command == "stop") {
-   *         distube.stop(message);
-   *         message.channel.send("Stopped the queue!");
-   *     }
-   * });
-   */
-  stop(message) {
-    const queue = this.getQueue(message);
-    if (!queue) throw new Error("Cannot find the playing queue.");
-    queue.stop();
-  }
-
-  /**
-   * Set the guild stream's volume
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel
-   * @param {number} percent The percentage of volume you want to set
-   * @returns {Queue} The guild queue
-   * @throws {Error}
-   * @example
-   * client.on('message', (message) => {
-   *     if (!message.content.startsWith(config.prefix)) return;
-   *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-   *     const command = args.shift();
-   *     if (command == "volume")
-   *         distube.setVolume(message, args[0]);
-   * });
-   */
-  setVolume(message, percent) {
-    const queue = this.getQueue(message);
-    if (!queue) throw new Error("Cannot find the playing queue.");
-    return queue.setVolume(percent);
-  }
-
-  /**
-   * Skip the playing song
-   *
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel
-   * @returns {Queue} The guild queue
-   * @throws {Error}
-   * @example
-   * client.on('message', (message) => {
-   *     if (!message.content.startsWith(config.prefix)) return;
-   *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-   *     const command = args.shift();
-   *     if (command == "skip")
-   *         distube.skip(message);
-   * });
-   */
-  skip(message) {
-    const queue = this.getQueue(message);
-    if (!queue) throw new Error("Cannot find the playing queue.");
-    return queue.skip();
-  }
-
-  /**
-   * Play the previous song
-   *
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel
-   * @returns {Queue} The guild queue
-   * @throws {Error}
-   * @example
-   * client.on('message', (message) => {
-   *     if (!message.content.startsWith(config.prefix)) return;
-   *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-   *     const command = args.shift();
-   *     if (command == "previous")
-   *         distube.previous(message);
-   * });
-   */
-  previous(message) {
-    if (!this.options.savePreviousSongs) throw new Error("Disabled");
-    const queue = this.getQueue(message);
-    if (!queue) throw new Error("Cannot find the playing queue.");
-    return queue.previous();
-  }
-
-  /**
-   * Shuffle the guild queue songs
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel
-   * @returns {Queue} The guild queue
-   * @example
-   * client.on('message', (message) => {
-   *     if (!message.content.startsWith(config.prefix)) return;
-   *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-   *     const command = args.shift();
-   *     if (command == "shuffle")
-   *         distube.shuffle(message);
-   * });
-   */
-  shuffle(message) {
-    const queue = this.getQueue(message);
-    if (!queue) throw new Error("Cannot find the playing queue.");
-    return queue.shuffle();
-  }
-
-  /**
-   * Jump to the song number in the queue.
-   * The next one is 1, 2,...
-   * The previous one is -1, -2,...
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel
-   * @param {number} num The song number to play
-   * @returns {Queue} The guild queue
-   * @throws {InvalidSong} if `num` is invalid number (0 < num < {@link Queue#songs}.length)
-   * @example
-   * client.on('message', (message) => {
-   *     if (!message.content.startsWith(config.prefix)) return;
-   *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-   *     const command = args.shift();
-   *     if (command == "jump")
-   *         distube.jump(message, parseInt(args[0]))
-   *             .catch(err => message.channel.send("Invalid song number."));
-   * });
-   */
-  jump(message, num) {
-    const queue = this.getQueue(message);
-    if (!queue) throw new Error("Cannot find the playing queue.");
-    return queue.jump(num);
-  }
-
-  /**
-   * Set the repeat mode of the guild queue.
-   * Turn off if repeat mode is the same value as new mode.
-   * Toggle mode: `mode = null` `(0 -> 1 -> 2 -> 0...)`
-   *
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel
-   * @param {number} mode The repeat modes `(0: disabled, 1: Repeat a song, 2: Repeat all the queue)`
-   * @returns {number} The new repeat mode
-   *
-   * @example
-   * client.on('message', (message) => {
-   *     if (!message.content.startsWith(config.prefix)) return;
-   *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-   *     const command = args.shift();
-   *     if (command == "repeat") {
-   *         let mode = distube.setRepeatMode(message, parseInt(args[0]));
-   *         mode = mode ? mode == 2 ? "Repeat queue" : "Repeat song" : "Off";
-   *         message.channel.send("Set repeat mode to `" + mode + "`");
-   *     }
-   * });
-   */
-  setRepeatMode(message, mode = null) {
-    const queue = this.getQueue(message);
-    if (!queue) throw new Error("Cannot find the playing queue.");
-    return queue.setRepeatMode(mode);
-  }
-
-  /**
-   * Toggle autoplay mode
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel
-   * @returns {boolean} Autoplay mode state
-   * @throws {Error}
-   * @example
-   * client.on('message', (message) => {
-   *     if (!message.content.startsWith(config.prefix)) return;
-   *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-   *     const command = args.shift();
-   *     if (command == "autoplay") {
-   *         let mode = distube.toggleAutoplay(message);
-   *         message.channel.send("Set autoplay mode to `" + (mode ? "On" : "Off") + "`");
-   *     }
-   * });
-   */
-  toggleAutoplay(message) {
-    const queue = this.getQueue(message);
-    if (!queue) throw new Error("Cannot find the playing queue.");
-    return queue.toggleAutoplay();
-  }
-
-  /**
-   * Whether or not a guild is playing music.
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel to check
-   * @returns {boolean} Whether or not the guild is playing song(s)
-   */
-  isPlaying(message) {
-    const queue = this.getQueue(message);
-    return queue ? queue.playing || !queue.paused : false;
-  }
-
-  /**
-   * Whether or not the guild queue is paused
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel to check
-   * @returns {boolean} Whether or not the guild queue is paused
-   */
-  isPaused(message) {
-    const queue = this.getQueue(message);
-    return queue ? queue.paused : false;
-  }
-
-  /**
-   * Add related song to the queue
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel
-   * @returns {Promise<Queue>} The guild queue
-   */
-  addRelatedVideo(message) {
-    const queue = this.getQueue(message);
-    if (!queue) throw new Error("Cannot find the playing queue.");
-    return queue.addRelatedVideo();
-  }
-
-  /**
-   * Enable or disable a filter of the queue.
-   * Available filters: {@link Filters}
-   *
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel
-   * @param {string|false} filter A filter name, `false` to clear all the filters
-   * @returns {Array<string>} Enabled filters.
-   * @example
-   * client.on('message', (message) => {
-   *     if (!message.content.startsWith(config.prefix)) return;
-   *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-   *     const command = args.shift();
-   *     if ([`3d`, `bassboost`, `echo`, `karaoke`, `nightcore`, `vaporwave`].includes(command)) {
-   *         let filter = distube.setFilter(message, command);
-   *         message.channel.send("Current queue filter: " + (filter.join(", ") || "Off"));
-   *     }
-   * });
-   */
-  setFilter(message, filter) {
-    const queue = this.getQueue(message);
-    if (!queue) throw new Error("Cannot find the playing queue.");
-    return queue.setFilter(filter);
-  }
-
-  /**
-   * Set the playing time to another position
-   * @param {Discord.Snowflake|Discord.Message} message A message from guild channel
-   * @param {number} time Time in seconds
-   * @returns {Queue}
-   * @example
-   * client.on('message', message => {
-   *     if (!message.content.startsWith(config.prefix)) return;
-   *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-   *     const command = args.shift();
-   *     if (command = 'seek')
-   *         distube.seek(message, Number(args[0]));
-   * });
-   */
-  seek(message, time) {
-    const queue = this.getQueue(message);
-    if (!queue) throw new Error("Cannot find the playing queue.");
-    return queue.seek(time);
-  }
-
-  /**
-   * Emit error event
-   * @param {Discord.TextChannel} channel Text channel where the error is encountered.
-   * @param {Error} error error
-   * @private
-   */
-  emitError(channel, error) {
-    if (!channel || !(channel instanceof Discord.TextChannel)) {
-      console.error(error);
-      console.warn("This is logged because <Queue>.textChannel is null");
-    } else if (this.listeners("error").length) this.emit("error", channel, error);
-    else this.emit("error", error);
-  }
-}
-
-DisTube.CustomPlugin = CustomPlugin;
-DisTube.ExtractorPlugin = ExtractorPlugin;
-DisTube.Playlist = Playlist;
-DisTube.Song = Song;
-module.exports = DisTube;
-
-/**
- * Emitted after DisTube add a new playlist to the playing {@link Queue}
- *
- * @event DisTube#addList
- * @param {Queue} queue The guild queue
- * @param {Playlist} playlist Playlist info
- * @example
- * distube.on("addList", (queue, playlist) => queue.textChannel.send(
- *     `Added \`${playlist.name}\` playlist (${playlist.songs.length} songs) to the queue!`
- * ));
- */
-
-/**
- *  Emitted after DisTube add a new song to the playing {@link Queue}
- *
- * @event DisTube#addSong
- * @param {Queue} queue The guild queue
- * @param {Song} song Added song
- * @example
- * distube.on("addSong", (queue, song) => queue.textChannel.send(
- *     `Added ${song.name} - \`${song.formattedDuration}\` to the queue by ${song.user}.`
- * ));
- */
-
-/**
- * Emitted when there is no user in VoiceChannel and {@link DisTubeOptions}.leaveOnEmpty is `true`.
- *
- * @event DisTube#empty
- * @param {Queue} queue The guild queue
- * @example
- * distube.on("empty", queue => queue.textChannel.send("Channel is empty. Leaving the channel"))
- */
-
-/**
- * Emitted when {@link DisTube} encounters an error.
- *
- * @event DisTube#error
- * @param {Discord.TextChannel} channel Text channel where the error is encountered.
- * @param {Error} error The error encountered
- * @example
- * distube.on("error", (channel, error) => channel.send(
- *     "An error encountered: " + error
- * ));
- */
-
-/**
- * Emitted when there is no more song in the queue and {@link Queue#autoplay} is `false`.
- * DisTube will leave voice channel if {@link DisTubeOptions}.leaveOnFinish is `true`
- *
- * @event DisTube#finish
- * @param {Queue} queue The guild queue
- * @example
- * distube.on("finish", queue => queue.textChannel.send("No more song in queue"));
- */
-
-/**
- * Emitted when DisTube initialize a queue to change queue default properties.
- *
- * @event DisTube#initQueue
- * @param {Queue} queue The guild queue
- * @example
- * distube.on("initQueue", queue => {
- *     queue.autoplay = false;
- *     queue.volume = 100;
- * });
- */
-
-/**
- * Emitted when {@link Queue#autoplay} is `true`, the {@link Queue#songs} is empty and
- * DisTube cannot find related songs to play
- *
- * @event DisTube#noRelated
- * @param {Queue} queue The guild queue
- * @example
- * distube.on("noRelated", queue => queue.textChannel.send("Can't find related video to play. Stop playing music."));
- */
-
-/**
- * Emitted when DisTube play a song.
- * If {@link DisTubeOptions}.emitNewSongOnly is `true`, event is not emitted when looping a song or next song is the previous one
- *
- * @event DisTube#playSong
- * @param {Queue} queue The guild queue
- * @param {Song} song Playing song
- * @example
- * const status = (queue) => `Volume: \`${queue.volume}%\` | Loop: \`${queue.repeatMode ? queue.repeatMode == 2 ? "Server Queue" : "This Song" : "Off"}\` | Autoplay: \`${queue.autoplay ? "On" : "Off"}\``;
- * distube.on("playSong", (queue, song) => queue.textChannel.send(
- *     `Playing \`${song.name}\` - \`${song.formattedDuration}\`\nRequested by: ${song.user}\n${status(queue)}`
- * ));
- */
-
-/**
- * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0
- * and DisTube cannot find any results for the query
- *
- * @event DisTube#searchNoResult
- * @param {Discord.Message} message A message called play method
- * @param {string} query The search query
- * @example
- * // DisTubeOptions.searchSongs > 0
- * distube.on("searchNoResult", (message, query) => message.channel.send(`No result found for ${query}!`));
- */
-
-/**
- * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0
- * and the search canceled due to user's next message is invalid number or timeout
- *
- * @event DisTube#searchCancel
- * @param {Discord.Message} message A message called play method
- * @param {string} query The search query
- * @example
- * // DisTubeOptions.searchSongs > 0
- * distube.on("searchCancel", (message) => message.channel.send(`Searching canceled`));
- */
-
-/**
- * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0
- * and song param of {@link DisTube#play|play()} is invalid url.
- * DisTube will wait for user's next message to choose song manually.
- *
- * @event DisTube#searchResult
- * @param {Discord.Message} message A message called play method
- * @param {Array<SearchResult>} results Searched results
- * @param {string} query The search query
- * @example
- * // DisTubeOptions.searchSongs > 0
- * distube.on("searchResult", (message, results) => {
- *     message.channel.send(`**Choose an option from below**\n${results.map((song, i) => `**${i + 1}**. ${song.name} - \`${song.formattedDuration}\``).join("\n")}\n*Enter anything else or wait 60 seconds to cancel*`);
- * });
- */
-
-/**
- * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0
- * and the user chose a search result to play
- *
- * @event DisTube#searchDone
- * @param {Discord.Message} message A message called play method
- * @param {Discord.Message} answer The answer message
- * @param {string} query The search query
- * @example
- * // DisTubeOptions.searchSongs > 0
- * distube.on("searchCancel", (message) => message.channel.send(`Searching canceled`));
- */
-
-/**
- * Emitted when the bot is connected to the voice channel
- *
- * @event DisTube#connect
- * @param {Queue} queue The guild queue
- */
-
-
-/**
- * Emitted when the bot is disconnected to the voice channel
- *
- * @event DisTube#disconnect
- * @param {Queue} queue The guild queue
- */
-
-/**
- * Emitted when a {@link Queue} is deleted with any reasons.
- *
- * @event DisTube#deleteQueue
- * @param {Queue} queue The guild queue
- */
-
-/**
- * Emitted when DisTube finished a song
- *
- * @event DisTube#finishSong
- * @param {Queue} queue The guild queue
- * @param {Song} song Finished song
- */
-