fix: use minami Androz's fork

This commit is contained in:
Androz2091 2020-04-20 20:50:15 +02:00
parent ef7c90777b
commit 53578d7c97
6 changed files with 127 additions and 7 deletions

View file

@ -56,6 +56,7 @@
<h4 class="name" id="Player"><span class="type-signature"></span>new Player<span class="signature">(client, youtubeToken, options)</span><span class="type-signature"></span></h4>
@ -66,6 +67,7 @@
<dl class="details">
@ -227,6 +229,10 @@
</div>
</div>
@ -601,12 +607,14 @@
<h4 class="name" id="addToQueue"><span class="type-signature"></span>addToQueue<span class="signature">(guildID, songName)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Song.html">Song</a>>}</span></h4>
<div class="description">
<p>Adds a song to the guild queue.</p>
</div>
@ -748,6 +756,8 @@
<div class="section-returns">
<h5>Returns:</h5>
@ -771,6 +781,8 @@
</div>
@ -778,12 +790,14 @@
<h4 class="name" id="clearQueue"><span class="type-signature"></span>clearQueue<span class="signature">(guildID)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Queue.html">Queue</a>>}</span></h4>
<div class="description">
<p>Clears the guild queue, but not the current song.</p>
</div>
@ -899,6 +913,8 @@
<div class="section-returns">
<h5>Returns:</h5>
@ -922,6 +938,8 @@
</div>
@ -929,12 +947,14 @@
<h4 class="name" id="getQueue"><span class="type-signature"></span>getQueue<span class="signature">(guildID)</span><span class="type-signature"> &rarr; (nullable) {<a href="Queue.html">Queue</a>}</span></h4>
<div class="description">
<p>Gets the guild queue.</p>
</div>
@ -1050,6 +1070,8 @@
<div class="section-returns">
<h5>Returns:</h5>
@ -1073,6 +1095,8 @@
</div>
@ -1080,12 +1104,14 @@
<h4 class="name" id="isPlaying"><span class="type-signature"></span>isPlaying<span class="signature">(guildID)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
<div class="description">
<p>Whether a guild is currently playing songs</p>
</div>
@ -1201,6 +1227,8 @@
<div class="section-returns">
<h5>Returns:</h5>
@ -1228,6 +1256,8 @@
</div>
@ -1235,12 +1265,14 @@
<h4 class="name" id="nowPlaying"><span class="type-signature"></span>nowPlaying<span class="signature">(guildID)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Song.html">Song</a>>}</span></h4>
<div class="description">
<p>Gets the currently playing song.</p>
</div>
@ -1356,6 +1388,8 @@
<div class="section-returns">
<h5>Returns:</h5>
@ -1379,6 +1413,8 @@
</div>
@ -1386,12 +1422,14 @@
<h4 class="name" id="pause"><span class="type-signature"></span>pause<span class="signature">(guildID)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Song.html">Song</a>>}</span></h4>
<div class="description">
<p>Pauses the current song.</p>
</div>
@ -1507,6 +1545,8 @@
<div class="section-returns">
<h5>Returns:</h5>
@ -1530,6 +1570,8 @@
</div>
@ -1537,12 +1579,14 @@
<h4 class="name" id="play"><span class="type-signature"></span>play<span class="signature">(voiceChannel, songName)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Song.html">Song</a>>}</span></h4>
<div class="description">
<p>Plays a song in a voice channel.</p>
</div>
@ -1684,6 +1728,8 @@
<div class="section-returns">
<h5>Returns:</h5>
@ -1707,6 +1753,8 @@
</div>
@ -1714,12 +1762,14 @@
<h4 class="name" id="resume"><span class="type-signature"></span>resume<span class="signature">(guildID)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Song.html">Song</a>>}</span></h4>
<div class="description">
<p>Resumes the current song.</p>
</div>
@ -1835,6 +1885,8 @@
<div class="section-returns">
<h5>Returns:</h5>
@ -1858,6 +1910,8 @@
</div>
@ -1865,12 +1919,14 @@
<h4 class="name" id="setQueue"><span class="type-signature"></span>setQueue<span class="signature">(guildID, songs)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Queue.html">Queue</a>>}</span></h4>
<div class="description">
<p>Sets the queue for a guild.</p>
</div>
@ -2012,6 +2068,8 @@
<div class="section-returns">
<h5>Returns:</h5>
@ -2035,6 +2093,8 @@
</div>
@ -2042,12 +2102,14 @@
<h4 class="name" id="setRepeatMode"><span class="type-signature"></span>setRepeatMode<span class="signature">(guildID, enabled)</span><span class="type-signature"> &rarr; {Promise.&lt;Void>}</span></h4>
<div class="description">
<p>Enable or disable the repeat mode</p>
</div>
@ -2189,6 +2251,8 @@
<div class="section-returns">
<h5>Returns:</h5>
@ -2212,6 +2276,8 @@
</div>
@ -2219,12 +2285,14 @@
<h4 class="name" id="setVolume"><span class="type-signature"></span>setVolume<span class="signature">(guildID, percent)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
<div class="description">
<p>Updates the volume.</p>
</div>
@ -2366,6 +2434,8 @@
<div class="section-returns">
<h5>Returns:</h5>
@ -2389,6 +2459,8 @@
</div>
@ -2396,12 +2468,14 @@
<h4 class="name" id="skip"><span class="type-signature"></span>skip<span class="signature">(guildID)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Song.html">Song</a>>}</span></h4>
<div class="description">
<p>Skips a song.</p>
</div>
@ -2517,6 +2591,8 @@
<div class="section-returns">
<h5>Returns:</h5>
@ -2540,6 +2616,8 @@
</div>
@ -2547,12 +2625,14 @@
<h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">(guildID)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
<div class="description">
<p>Stops playing music.</p>
</div>
@ -2668,6 +2748,8 @@
<div class="section-returns">
<h5>Returns:</h5>
@ -2691,6 +2773,8 @@
</div>
@ -2710,7 +2794,7 @@
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> using the Minami theme.
</footer>
<script>prettyPrint();</script>

View file

@ -60,12 +60,14 @@
<h2>Constructor</h2>
<h4 class="name" id="Queue"><span class="type-signature"></span>new Queue<span class="signature">(guildID)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Represents a guild queue.</p>
</div>
@ -183,6 +185,10 @@
</div>
</div>
@ -837,12 +843,14 @@
<h4 class="name" id="event:channelEmpty">channelEmpty</h4>
<div class="description">
<p>Emitted when the voice channel is empty.</p>
</div>
@ -903,6 +911,10 @@
@ -915,12 +927,14 @@
<h4 class="name" id="event:end">end</h4>
<div class="description">
<p>Emitted when the queue is empty.</p>
</div>
@ -981,6 +995,10 @@
@ -993,12 +1011,14 @@
<h4 class="name" id="event:songChanged">songChanged</h4>
<div class="description">
<p>Emitted when the song changes.</p>
</div>
@ -1168,6 +1188,10 @@
</div>
@ -1183,7 +1207,7 @@
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> using the Minami theme.
</footer>
<script>prettyPrint();</script>

View file

@ -60,6 +60,7 @@
<h2>Constructor</h2>
<h4 class="name" id="Song"><span class="type-signature"></span>new Song<span class="signature">(video, queue)</span><span class="type-signature"></span></h4>
@ -70,6 +71,7 @@
<dl class="details">
@ -205,6 +207,10 @@
</div>
</div>
@ -794,7 +800,7 @@
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> using the Minami theme.
</footer>
<script>prettyPrint();</script>

View file

@ -302,7 +302,7 @@
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> using the Minami theme.
</footer>
<script>prettyPrint();</script>

View file

@ -413,7 +413,13 @@ client.player.setRepeatMode(guildID, false);
}
});
</code></pre></article>
</code></pre>
<h2>Examples of bots made with discord-player</h2>
<p>These bots are made by the community, they can help you build your own!</p>
<ul>
<li><a href="https://github.com/hydraindia/discord-music">Discord-Music</a> by <a href="https://github.com/hydraindia">hydraindia</a></li>
<li><a href="https://github.com/ZerioDev/Music-bot">Music-bot</a> by <a href="https://github.com/ZerioDev">ZerioDev</a></li>
</ul></article>
</section>
@ -426,7 +432,7 @@ client.player.setRepeatMode(guildID, false);
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> using the Minami theme.
</footer>
<script>prettyPrint();</script>

View file

@ -36,6 +36,6 @@
"devDependencies": {
"discord.js": "discordjs/discord.js",
"jsdoc": "^3.6.3",
"minami": "^1.2.3"
"minami": "Androz2091/minami"
}
}