ytdl-core-discord

by amishshah

GitHub Readme.md

ytdl-core-discord

Build Status dependencies npm Patreon

A ytdl-core wrapper focused on efficiency for use in Discord music bots.

You can pass the exact same arguments as you would with the ytdl-core module, with the exception that you must await the function call.

What does it do?

For compatible videos, this module uses prism-media to extract Opus audio from a stream without having to pipe it through FFmpeg first. This greatly reduces the processing power required, making playback smoother and allowing you to play over more connections simultaneously.

For videos where the required codec (webm + opus) isn't available, the module will fallback to using FFmpeg to encode the stream in Opus. Many new videos on YouTube are available in this codec so hopefully this isn't frequent.

Put simply, this module finds the most efficient way to extract a stream of Opus audio from a YouTube video.

Usage in Discord.js 11.4.x

const ytdl = require('ytdl-core-discord');

async function play(connection, url) {
  connection.playOpusStream(await ytdl(url));
}

Usage in Discord.js 12.x

const ytdl = require('ytdl-core-discord');

async function play(connection, url) {
  connection.play(await ytdl(url), { type: 'opus' });
}

Patreon