Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-14 02:23:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

CRLF to LF

Browse Source
This commit is contained in:
Amish Shah
2017-04-25 18:08:27 +01:00
parent 10138dfad2
commit eb9c280d5f
1 changed files with 109 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

218
docs/topics/voice.md
View File

@@ -1,109 +1,109 @@
# Introduction to Voice # Introduction to Voice
Voice in discord.js can be used for many things, such as music bots, recording or relaying audio. Voice in discord.js can be used for many things, such as music bots, recording or relaying audio.
In discord.js, you can use voice by connecting to a `VoiceChannel` to obtain a `VoiceConnection`, where you can start streaming and receiving audio. In discord.js, you can use voice by connecting to a `VoiceChannel` to obtain a `VoiceConnection`, where you can start streaming and receiving audio.
To get started, make sure you have: To get started, make sure you have:
* ffmpeg - `npm install --global ffmpeg-binaries` * ffmpeg - `npm install --global ffmpeg-binaries`
* an opus encoder, choose one from below: * an opus encoder, choose one from below:
* `npm install opusscript` * `npm install opusscript`
* `npm install node-opus` * `npm install node-opus`
* a good network connection * a good network connection
## Joining a voice channel ## Joining a voice channel
The example below reacts to a message and joins the sender's voice channel, catching any errors. This is important The example below reacts to a message and joins the sender's voice channel, catching any errors. This is important
as it allows us to obtain a `VoiceConnection` that we can start to stream audio with. as it allows us to obtain a `VoiceConnection` that we can start to stream audio with.
```js ```js
const Discord = require('discord.js'); const Discord = require('discord.js');
const client = new Discord.Client(); const client = new Discord.Client();
client.login('token here'); client.login('token here');
client.on('message', message => { client.on('message', message => {
// Voice only works in guilds, if the message does not come from a guild, // Voice only works in guilds, if the message does not come from a guild,
// we ignore it // we ignore it
if (!message.guild) return; if (!message.guild) return;
if (message.content === '/join') { if (message.content === '/join') {
// Only try to join the sender's voice channel if they are in one themselves // Only try to join the sender's voice channel if they are in one themselves
if (message.member.voiceChannel) { if (message.member.voiceChannel) {
message.member.voiceChannel.join() message.member.voiceChannel.join()
.then(connection => { // Connection is an instance of VoiceConnection .then(connection => { // Connection is an instance of VoiceConnection
message.reply('I have successfully connected to the channel!'); message.reply('I have successfully connected to the channel!');
}) })
.catch(console.log); .catch(console.log);
} else { } else {
message.reply('You need to join a voice channel first!'); message.reply('You need to join a voice channel first!');
} }
} }
}); });
``` ```
## Streaming to a Voice Channel ## Streaming to a Voice Channel
In the previous example, we looked at how to join a voice channel in order to obtain a `VoiceConnection`. Now that we In the previous example, we looked at how to join a voice channel in order to obtain a `VoiceConnection`. Now that we
have obtained a voice connection, we can start streaming audio to it. The following example shows how to stream an mp3 have obtained a voice connection, we can start streaming audio to it. The following example shows how to stream an mp3
file: file:
**Playing a file:** **Playing a file:**
```js ```js
// To play a file, we need to give an absolute path to it // To play a file, we need to give an absolute path to it
const dispatcher = connection.playFile('C:/Users/Discord/Desktop/myfile.mp3'); const dispatcher = connection.playFile('C:/Users/Discord/Desktop/myfile.mp3');
``` ```
Your file doesn't have to be just an mp3; ffmpeg can convert videos and audios of many formats. Your file doesn't have to be just an mp3; ffmpeg can convert videos and audios of many formats.
The `dispatcher` variable is an instance of a `StreamDispatcher`, which manages streaming a specific resource to a voice The `dispatcher` variable is an instance of a `StreamDispatcher`, which manages streaming a specific resource to a voice
channel. We can do many things with the dispatcher, such as finding out when the stream ends or changing the volume: channel. We can do many things with the dispatcher, such as finding out when the stream ends or changing the volume:
```js ```js
dispatcher.on('end', () => { dispatcher.on('end', () => {
// The song has finished // The song has finished
}); });
dispatcher.on('error', e => { dispatcher.on('error', e => {
// Catch any errors that may arise // Catch any errors that may arise
console.log(e); console.log(e);
}); });
dispatcher.setVolume(0.5); // Set the volume to 50% dispatcher.setVolume(0.5); // Set the volume to 50%
dispatcher.setVolume(1); // Set the volume back to 100% dispatcher.setVolume(1); // Set the volume back to 100%
console.log(dispatcher.time); // The time in milliseconds that the stream dispatcher has been playing for console.log(dispatcher.time); // The time in milliseconds that the stream dispatcher has been playing for
dispatcher.pause(); // Pause the stream dispatcher.pause(); // Pause the stream
dispatcher.resume(); // Carry on playing dispatcher.resume(); // Carry on playing
dispatcher.end(); // End the dispatcher, emits 'end' event dispatcher.end(); // End the dispatcher, emits 'end' event
``` ```
If you have an existing [ReadableStream](https://nodejs.org/api/stream.html#stream_readable_streams), If you have an existing [ReadableStream](https://nodejs.org/api/stream.html#stream_readable_streams),
this can also be used: this can also be used:
**Playing a ReadableStream:** **Playing a ReadableStream:**
```js ```js
connection.playStream(myReadableStream); connection.playStream(myReadableStream);
// If you don't want to use absolute paths, you can use // If you don't want to use absolute paths, you can use
// fs.createReadStream to circumvent it // fs.createReadStream to circumvent it
const fs = require('fs'); const fs = require('fs');
const stream = fs.createReadStream('./test.mp3'); const stream = fs.createReadStream('./test.mp3');
connection.playStream(stream); connection.playStream(stream);
``` ```
It's important to note that creating a readable stream to a file is less efficient than simply using `connection.playFile()`. It's important to note that creating a readable stream to a file is less efficient than simply using `connection.playFile()`.
**Playing anything else:** **Playing anything else:**
For anything else, such as a URL to a file, you can use `connection.playArbitraryInput()`. You should consult the [ffmpeg protocol documentation](https://ffmpeg.org/ffmpeg-protocols.html) to see what you can use this for. For anything else, such as a URL to a file, you can use `connection.playArbitraryInput()`. You should consult the [ffmpeg protocol documentation](https://ffmpeg.org/ffmpeg-protocols.html) to see what you can use this for.
```js ```js
// Play an mp3 from a URL // Play an mp3 from a URL
connection.playArbitraryInput('http://mysite.com/sound.mp3'); connection.playArbitraryInput('http://mysite.com/sound.mp3');
``` ```
Again, playing a file from a URL like this is more performant than creating a ReadableStream to the file. Again, playing a file from a URL like this is more performant than creating a ReadableStream to the file.
## Advanced Topics ## Advanced Topics
soon:tm: soon:tm: