Skip to content

JasperVanEsveld/discordeno-audio-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Discordeno Audio Plugin

This plugin enables your bot to send and receive audio. Play either local files or stream straight from YouTube using yt_download. Or create your own audio sources!

No external plugins like FFMPEG required!

IMPORTANT: The --unstable flag is required as the unstable datagram implementation is used.

Enable Audio usage

Enabling the plugin is similar to the cache plugin.

After that just connect to a channel and play your songs!

import { createBot, startBot, Intents } from "https://deno.land/x/discordeno/mod.ts";
import { enableAudioPlugin } from "https://deno.land/x/discordeno_audio_plugin/mod.ts";
 
 // Create your bot
const baseBot = createBot({
    token: your-token,
    botId: your-botid,
    intents: Intents.GuildVoiceStates, // Required to connect!
  });
  
// Enable the plugin
const bot = enableAudioPlugin(baseBot); 

// Start your bot
await startBot(bot);

// Connect to a channel
bot.helpers.connectToVoiceChannel(
  your-guildid,
  your-channelid
);

// Play music :)
const player = bot.helpers.getPlayer(your-guildid);
player.pushQuery("Obi-Wan - Hello there.");

Playing sound

Sound can be enqueued using the helper functions that have been added by enableAudioPlugin. Sounds are managed using a QueuePlayer, allowing for multiple to be queued, shuffled, etc.

const player = bot.helpers.getPlayer("your-guildid");

// Pushes a song to the end of the queue
// In this case it will stream directly from youtube
player.pushQuery("Obi-Wan - Hello there.");

// Local files have to be raw pcm files with data in the following format:
// 2 channel, 16bit Little Endian @48kHz
player.pushQuery("./hello/world.pcm"); 

// Interrupts the current sound, resumes when done
player.interruptQuery("rEq1Z0bjdwc"); 

Playing your own source

Given that you have an audio source in the correct format you can play from any source that you want.

IMPORTANT: The data needs to be Opus encoded 2 channel 16bit Little Endian @48kHz. You can use encodePCMAudio to encode PCM as Opus.

// Create and play your own source!
const source = createAudioSource("Title", () => AsyncIterableIterator<Uint8Array>)
player.push(source); 

Or pass in your own loadSource function when enabling the plugin:

const loadSource = (query: string) => {
  return createAudioSource("Title", () => AsyncIterableIterator<Uint8Array>);
}
const bot = enableAudioPlugin(baseBot, loadSource);
player.pushQuery("Query to pass to loadSource");

Listening

While receiving audio is not officially supported by Discord, it does work for now.

// Audio received is not a single stream!
// Each user is received separately
// Decoded audio is again 2 channel 16bit LE 48kHz pcm data
for await (const { user, decoded } from bot.helpers.onAudio("guildId")) {
  ...
}

// You can also filter out one or more users
for await (const { decoded } from bot.helpers.onAudio("guildId", "userid")) {
  ...
}

About

Enables audio to be played and received by a Discordeno bot

Resources

License

Stars

Watchers

Forks

Packages

No packages published