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

Clean up PR a bit

Browse Source
This commit is contained in:
Schuyler Cebulskie
2016-09-08 22:59:10 -04:00
parent f7a542f12b
commit 9682adb9fe
3 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -200,10 +200,21 @@ class VoiceConnection extends EventEmitter {
});
}
/**
* Options that can be passed to stream-playing methods:
* ```js
* {
* seek: 0,
* volume: 1
* };
* ```
* @typedef {Object} StreamOptions
*/
/**
* Play the given file in the voice connection
* @param {string} file The path to the file
* @param {Object} [options] Optional streamOptions object. Currently accepts seek and volume properties.
* @param {StreamOptions} [options] Options for playing the stream
* @returns {StreamDispatcher}
* @example
* // play files natively
@@ -221,7 +232,7 @@ class VoiceConnection extends EventEmitter {
/**
* Plays and converts an audio stream in the voice connection
* @param {ReadableStream} stream The audio stream to play
* @param {Object} [options] Optional streamOptions object. Currently accepts seek and volume properties.
* @param {StreamOptions} [options] Options for playing the stream
* @returns {StreamDispatcher}
* @example
* // play streams using ytdl-core
@@ -242,7 +253,7 @@ class VoiceConnection extends EventEmitter {
/**
* Plays a stream of 16-bit signed stereo PCM at 48KHz.
* @param {ReadableStream} stream The audio stream to play.
* @param {Object} [options] Optional streamOptions object. Currently accepts seek and volume properties.
* @param {StreamOptions} [options] Options for playing the stream
* @returns {StreamDispatcher}
*/
playConvertedStream(stream, { seek = 0, volume = 1 }) {