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

rewrite some docs and refactor some names

Browse Source
This commit is contained in:
Amish Shah
2016-09-03 23:06:53 +01:00
parent 7f9ea762ed
commit efd1d0c738
4 changed files with 27 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/client/voice/VoiceConnection.js
View File

@@ -6,7 +6,12 @@ const EventEmitter = require('events').EventEmitter;
const DefaultPlayer = require('./player/DefaultPlayer');
/**
* Represents a connection to a Voice Channel in Discord
* Represents a connection to a Voice Channel in Discord.
* ```js
* // obtained using:
* voiceChannel.join().then(connection => {
*
* });
* @extends {EventEmitter}
*/
class VoiceConnection extends EventEmitter {
@@ -220,7 +225,7 @@ class VoiceConnection extends EventEmitter {
}
/**
* Play the given stream in the voice connection
* Plays and converts an audio stream in the voice connection
* @param {ReadableStream} stream the audio stream to play
* @returns {StreamDispatcher}
* @example
@@ -238,13 +243,13 @@ class VoiceConnection extends EventEmitter {
}
/**
* Plays a stream of PCM data
* @param {ReadableStream} pcmStream the PCM stream
* Plays a stream of 16-bit signed stereo PCM at 48KHz.
* @param {ReadableStream} stream the audio stream to play.
* @returns {StreamDispatcher}
*/
playPCMStream(pcmStream) {
playConvertedStream(stream) {
this._shutdown();
const dispatcher = this.player.playPCMStream(pcmStream);
const dispatcher = this.player.playPCMStream(stream);
return dispatcher;
}