Improve docs

This commit is contained in:
Crawl
2017-04-24 16:29:29 +02:00
parent 401822a094
commit 53eda09f72
16 changed files with 34 additions and 25 deletions

View File

@@ -32,7 +32,7 @@ class VoiceBroadcast extends VolumeInterface {
this.prism = new Prism();
/**
* The current audio transcoder that is being used
* @type {object}
* @type {Object}
*/
this.currentTranscoder = null;
this.tickInterval = null;
@@ -120,14 +120,14 @@ class VoiceBroadcast extends VolumeInterface {
* @param {StreamOptions} [options] Options for playing the stream
* @returns {VoiceBroadcast}
* @example
* // play streams using ytdl-core
* // Play streams using ytdl-core
* const ytdl = require('ytdl-core');
* const streamOptions = { seek: 0, volume: 1 };
* const broadcast = client.createVoiceBroadcast();
*
* voiceChannel.join()
* .then(connection => {
* const stream = ytdl('https://www.youtube.com/watch?v=XAWgeLF9EVQ', {filter : 'audioonly'});
* const stream = ytdl('https://www.youtube.com/watch?v=XAWgeLF9EVQ', { filter : 'audioonly' });
* broadcast.playStream(stream);
* const dispatcher = connection.playBroadcast(broadcast);
* })
@@ -144,7 +144,7 @@ class VoiceBroadcast extends VolumeInterface {
* @param {StreamOptions} [options] Options for playing the stream
* @returns {StreamDispatcher}
* @example
* // play files natively
* // Play files natively
* const broadcast = client.createVoiceBroadcast();
*
* voiceChannel.join()