Registration and lifetime

Each Player has its own plugin registry. A registration owns its handlers, its cleanup callbacks, and an abort signal.

import { definePlugin } from 'discord-player';

const mySource = definePlugin({
  id: 'example.network-source',

  async setup(ctx) {
    const resource = await acquireResource();

    ctx.onCleanup(() => resource.close());

    ctx.on('track.stream', async ({ track }, { signal }) => {
      signal.throwIfAborted();

      return resolveMedia(track, { signal, resource });
    });
  },
});

acquireResource and resolveMedia are your functions.

Register and removeCopy Anchor Link

await player.plugins.register(mySource());

console.log(player.plugins.has('example.network-source'));

await player.plugins.unregister('example.network-source');

Plugins passed in the plugins constructor option use the same registry. They finish setup before player.initialize() completes.

Do not register the same ID twice.

What happens on removalCopy Anchor Link

1. New requests stop using the plugin.
2. The registration's signal aborts.
3. Running handlers finish.
4. destroy() and the cleanup callbacks run.

Do not wait for your own plugin's removal from inside one of its handlers. The registry waits for running handlers, so that would never finish.

If setup() throws, the registry removes the handlers and runs cleanup. The ID can be registered again afterward.

StreamsCopy Anchor Link

When a handler returns a Readable, the Player owns it from then on. It may destroy the stream when playback is cancelled, the plugin is removed, or the queue ends. Do not share one active stream between sessions.