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

Various documentation adjustments (#2001)

Browse Source 
* docs(various): Add "at" to createdAt description

* docs(Client): Adjust to fit with guilds property

* docs(various): Adjust phrasing & fix typos

* docs(various): Clarifications

* docs(Permissions): fix numerus

* docs(DataStore): capitalize DataStore

* docs(various): Formatting changes

* docs(Presence): Expand RichPresenceAssets docs

* Add space
This commit is contained in:
Robin B
2017-10-07 01:56:17 +02:00
committed by Crawl
parent 8fbae13040
commit 97823bc376
39 changed files with 149 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/client/voice/VoiceBroadcast.js
View File

@@ -154,7 +154,7 @@ class VoiceBroadcast extends VolumeInterface {
}
/**
* Play the given file in the voice connection.
* Plays the given file in the voice connection.
* @param {string} file The absolute path to the file
* @param {StreamOptions} [options] Options for playing the stream
* @returns {StreamDispatcher}
@@ -236,7 +236,7 @@ class VoiceBroadcast extends VolumeInterface {
}
/**
* Play an arbitrary input that can be [handled by ffmpeg](https://ffmpeg.org/ffmpeg-protocols.html#Description)
* Plays an arbitrary input that can be [handled by ffmpeg](https://ffmpeg.org/ffmpeg-protocols.html#Description)
* @param {string} input The arbitrary input
* @param {StreamOptions} [options] Options for playing the stream
* @returns {VoiceBroadcast}
@@ -248,7 +248,7 @@ class VoiceBroadcast extends VolumeInterface {
}
/**
* Pauses the entire broadcast - all dispatchers also pause.
* Pauses the entire broadcast - all dispatchers are also paused.
*/
pause() {
this.paused = true;
@@ -260,7 +260,7 @@ class VoiceBroadcast extends VolumeInterface {
}
/**
* Resumes the entire broadcast - all dispatchers also resume.
* Resumes the entire broadcast - all dispatchers are also resumed.
*/
resume() {
this.paused = false;
@@ -349,14 +349,14 @@ class VoiceBroadcast extends VolumeInterface {
}
/**
* Stop the current stream from playing without unsubscribing dispatchers.
* Stops the current stream from playing without unsubscribing dispatchers.
*/
end() {
this.killCurrentTranscoder();
}
/**
* End the current broadcast, all subscribed dispatchers will also end.
* Ends the current broadcast, all subscribed dispatchers will also end.
*/
destroy() {
this.end();