Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amishshah/ytdl-core-discord
A ytdl-core wrapper focused on efficiency for use in Discord music bots
https://github.com/amishshah/ytdl-core-discord
audio discord opus youtube
Last synced: about 21 hours ago
JSON representation
A ytdl-core wrapper focused on efficiency for use in Discord music bots
- Host: GitHub
- URL: https://github.com/amishshah/ytdl-core-discord
- Owner: amishshah
- License: apache-2.0
- Created: 2019-02-17T19:54:08.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T20:46:19.000Z (over 1 year ago)
- Last Synced: 2024-05-29T17:51:26.892Z (7 months ago)
- Topics: audio, discord, opus, youtube
- Language: JavaScript
- Size: 196 KB
- Stars: 63
- Watchers: 3
- Forks: 24
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ytdl-core-discord
[](https://travis-ci.org/amishshah/ytdl-core-discord)
[](https://david-dm.org/amishshah/ytdl-core-discord)
[](https://www.npmjs.com/package/ytdl-core-discord)
[](https://www.patreon.com/discordjs)
A [ytdl-core](https://github.com/fent/node-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](https://github.com/amishshah/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. Even in the worst case, it should still give better performance than `ytdl-core`.
## Usage in Discord.js 12.x
```js
const ytdl = require('ytdl-core-discord');
async function play(connection, url) {
connection.play(await ytdl(url), { type: 'opus' });
}
```
## Usage in Discord.js 11.4.x
```js
const ytdl = require('ytdl-core-discord');
async function play(connection, url) {
connection.playOpusStream(await ytdl(url));
}
```
[](https://www.patreon.com/discordjs)