Custom operations

You can add operations to the registry. This is rarely needed. Source plugins normally use the built-in operations.

Define an operationCopy Anchor Link

Declare the operation's types, then register its policy on the Player:

import type { Operation } from 'discord-player';

declare module '@discord-player/plugin-host' {
  interface OperationMap {
    'track.audit': Operation<{ sourceId: string }, { accepted: boolean }, 'first'>;
  }
}

player.plugins.defineOperation('track.audit', 'first');

Plugins can then handle it, and you can run it:

ctx.on('track.audit', ({ sourceId }) => ({ accepted: sourceId.length > 0 }));

const result = await player.plugins.execute('track.audit', { sourceId: 'abc' });

Define the operation before any plugin registers a handler for it.

Choose a policyCopy Anchor Link

Keep data portableCopy Anchor Link

Use JSON-compatible data for inputs and outputs if the result might be saved or sent to another process.

LimitsCopy Anchor Link

Custom operations run inside the bot process. They are not sent to a remote Remedia server. A source that must work with a remote audio node should return a server-accessible URL from track.stream, or run on a source host.