Media sources

track.stream returns the audio for a track. The Player passes it to Remedia as a media source.

Return shapesCopy Anchor Link

// A URL
ctx.on('track.stream', ({ track }) => ({ url: track.url }));

// A file on the machine that runs the audio engine
ctx.on('track.stream', ({ track }) => ({ file: track.url }));

// An encoded Node.js Readable (embedded nodes only)
ctx.on('track.stream', async ({ track }) => ({ stream: createEncodedReadable(track) }));

createEncodedReadable is your own function. These are alternatives, so a handler returns one of them. A plain HTTP(S) string, a file path string, a Uint8Array, or a Readable is also accepted.

What each node can openCopy Anchor Link

A remote node runs on another machine and cannot read your bot's memory, files, or streams. For remote nodes, return a URL the server can open, or use a remote source host.

Do not assume a private local file is available on another server.

Encoded audio onlyCopy Anchor Link

A Readable carries encoded audio such as MP3, Ogg, or M4A. Remedia decodes it. A Readable is not a place to push raw PCM or Opus frames.

To modify the encoded bytes before decoding, add a stream.transform handler. It runs only for local streams, must stop when the signal aborts, and should not keep unbounded chunks in memory.

Remote-safe URLsCopy Anchor Link

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

  return { url: await createAccessibleUrl(track, { signal }) };
});

createAccessibleUrl is your function. It should check access rights and return a URL that expires.