rewrite some docs and refactor some names

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

View File

@@ -6,6 +6,15 @@ nonce.fill(0);
/**
* The class that sends voice packet data to the voice connection.
* ```js
* // obtained using:
* voiceChannel.join().then(connection => {
* // you can play a file or a stream here:
* connection.playFile('./file.mp3').then(dispatcher => {
*
* });
* });
* ```
* @extends {EventEmitter}
*/
class StreamDispatcher extends EventEmitter {