Autoplay

When a queue ends, Hoshimi calls the autoplay function before emitting QueueEnd. If that function queues something, playback continues and no QueueEnd is emitted.

Enabling it

Autoplay is off by default. Turn it on globally, or per player through its storage.

const manager = createHoshimi({
  sendPayload,
  nodes: [{ host: 'localhost', port: 2333, password: 'youshallnotpass' }],
  queueOptions: {
    autoPlay: true, // every player
  },
});

// …or per guild, which the built-in function checks first
await player.data.set('enabledAutoplay', true);

The built-in function handles YouTube (mix radio from the last track) and Spotify (sprec recommendations seeded with recent history), and filters out anything already in the history so it does not loop over the same songs.

Writing your own

Replace it to support other sources or your own recommendation logic. It receives the player and the last track played, and is expected to push onto the queue.

const manager = createHoshimi({
  sendPayload,
  nodes: [{ host: 'localhost', port: 2333, password: 'youshallnotpass' }],
  queueOptions: {
    autoPlay: true,
    async autoplayFn(player, lastTrack) {
      if (!lastTrack) return;

      const { tracks } = await player.search({
        query: `${lastTrack.info.author} radio`,
        source: SearchSources.Deezer,
        requester: lastTrack.requester,
      });

      const seen = new Set(player.queue.history.map((track) => track.info.identifier));
      const next = tracks.filter((track) => !seen.has(track.info.identifier)).slice(0, 5);

      if (next.length) await player.queue.add(next);
    },
  },
});

Key Concepts

• Both switches count: the built-in function plays when queueOptions.autoPlay is on or the player has enabledAutoplay in its storage, so users can toggle it per guild.
• Runs before QueueEnd: queue something and the event never fires; queue nothing and the queue ends normally.
• History is the memory: player.queue.history is capped by queueOptions.maxHistory (25 by default), which is also what autoplay dedupes against.