4d3351d81e4aab1b1d2423c8d4df1364a7b127c7
Discord Audio Stream
This module is designed to work with discord.js/voice v0.18. This package doesn't support older versions!
👋 Support
Please create an issue on github or write
fraujulian on discord!
📝 Usage
Install package
npm install discord-audio-stream
yarn add discord-audio-stream
pnpm add discord-audio-stream
bun add discord-audio-stream
Encryption Libraries (npm install):
You only need to install one of these libraries if your system does not support
aes-256-gcm(verify by runningrequire('node:crypto').getCiphers().includes('aes-256-gcm')).
sodium-nativesodium@stablelib/xchacha20poly1305@noble/cipherslibsodium-wrappers
Opus Libraries (npm install):
@discordjs/opusopusscript
FFmpeg:
FFmpeg(installed and added to environment)ffmpeg-static
Create Instance
let audioManager = new AudioManager();
or (with parameters)
let audioManager = new AudioManager({
VoiceChannelId: 0, //voice channel id where to play music
GuildId: 0, //guild id
VoiceAdapter: 0 //guild VoiceAdapter
},
{
ResourceType: "", //resource type like link or file
Resource: "" //auto play link or file name
});
Properties of the AudioManager
Properties
| Callable with | Type | Description |
|---|---|---|
VoiceConnection |
VoiceConnection | VoiceConnection instance from discord.js/voice. |
AudioPlayer |
AudioPlayer | AudioPlayer instance from discord.js/voice. |
AudioResource |
AudioResource | AudioResource instance from discord.js/voice. |
ConnectionData |
VoiceConnectionDataModel | Global variable for connection data. |
AudioData |
AudioDataModel | Global variable for audio data. |
Methods
| Callable with | Parameters | Return type | Description |
|---|---|---|---|
OverrideOptions |
connectionData (type of VoiceConnectionDataModel), audioData (type of VoiceAudioDataModel) |
void | Method to override global variables, connectionData and audioData. |
CreateConnection |
isRenew (type of boolean, default value is false) |
void | Method to join the voice connection. |
PlayAudioOnConnection |
void | Method to play audio on the existing voice connection. | |
PauseAudio |
void | Method to pause the audio. | |
ResumeAudio |
void | Method to resume the audio. | |
StopAudioOnConnection |
void | Method to stop the audio without destroying voice connection. | |
CreateConnectionAndPlayAudio |
void | Method to join the voice connection and play audio. | |
DestroyConnection |
void | Method to destroy the voice connection. | |
Dispose |
void | Dispose all data in object. | |
SetVolume |
volume (type of number, 0 - 100 percent) |
void | Method to set the audio volume. |
SetMaxListeners |
maxListeners (type of number) |
void | Method to set the max listeners of the audio stream. |
Types History
- VoiceConnection by discord.js/voice
- AudioPlayer by discord.js/voice
- AudioResource by discord.js/voice
- VoiceConnectionDataModel (custom type)
- VoiceAudioDataModel (custom type)
📋 Credits:
~ FrauJulian.
🤝 Enjoy the package?
Give it a star ⭐ on github!
Greetings from Austria! ⛰️
Languages
TypeScript
86.9%
JavaScript
13%