v7 extractors

player.extractors is still available so supported v7 BaseExtractor classes keep working. The adapter wraps each extractor as a source plugin, so extractors and plugins share one registry.

New code should use definePlugin().

Register an extractorCopy Anchor Link

import { BaseExtractor, Track } from 'discord-player';
import type { ExtractorSearchContext } from 'discord-player';

class DirectMediaExtractor extends BaseExtractor {
  static identifier = 'example.legacy-direct';

  async validate(query: string) {
    return /^https?:\/\//.test(query);
  }

  async handle(query: string, context: ExtractorSearchContext) {
    return this.createResponse(null, [
      new Track(this.context.player, {
        title: 'Direct media',
        url: query,
        requestedBy: context.requestedBy,
        engine: query,
      }),
    ]);
  }

  async stream(track: Track) {
    return track.raw.engine as string;
  }
}

await player.extractors.register(DirectMediaExtractor, {});

Pass the class, not an instance. register() returns the extractor instance the Player owns.

How methods mapCopy Anchor Link

Priority and protocols carry over. Tracks created by an extractor receive a portable source reference.

Supported registry methodsCopy Anchor Link

register(), unregister(), unregisterAll(), get(), isRegistered(), loadMulti(), and reconfigure(). reconfigure() replaces the owned instance, so fetch a fresh one with get().

LimitsCopy Anchor Link

The adapter reproduces the extractor API, not the v7 audio pipeline:

• No stream dispatcher, raw audio resources, or PCM and Opus format overrides.
• No access to extractor session internals.
• A local Readable cannot reach a remote Remedia node.
• Extractor state such as raw.engine, private clients, and callbacks is not portable and is not saved.
• A restored track resolves through the extractors registered now.