dan/discord.js
1
0
Fork 0
mirror of https://github.com/danbulant/discord.js synced 2026-06-07 16:52:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix documentation for VoiceBroadcast (play methods return BroadcastDispatcher not StreamDispatcher)

Browse source
This commit is contained in:
Amish Shah 2018-01-19 14:40:58 +00:00
parent 3b1c5d3494
commit 580bda46ea
No known key found for this signature in database
GPG key ID: 904349C1207D7967
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/client/voice/VoiceBroadcast.js
View file

@ -40,7 +40,7 @@ class VoiceBroadcast extends EventEmitter {
* Plays 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 {string} file The absolute path to the file
* @param {StreamOptions} [options] Options for playing the stream * @param {StreamOptions} [options] Options for playing the stream
* @returns {StreamDispatcher} * @returns {BroadcastDispatcher}
* @example * @example
* // Play files natively * // Play files natively
* voiceChannel.join() * voiceChannel.join()
@ -57,7 +57,7 @@ class VoiceBroadcast extends EventEmitter {
* Plays 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 {string} input the arbitrary input
* @param {StreamOptions} [options] Options for playing the stream * @param {StreamOptions} [options] Options for playing the stream
* @returns {StreamDispatcher} * @returns {BroadcastDispatcher}
*/ */
playArbitraryInput(input, options) { playArbitraryInput(input, options) {
return this.player.playUnknown(input, options); return this.player.playUnknown(input, options);
@ -67,7 +67,7 @@ class VoiceBroadcast extends EventEmitter {
* Plays and converts an audio stream in the voice connection. * Plays and converts an audio stream in the voice connection.
* @param {ReadableStream} stream The audio stream to play * @param {ReadableStream} stream The audio stream to play
* @param {StreamOptions} [options] Options for playing the stream * @param {StreamOptions} [options] Options for playing the stream
* @returns {StreamDispatcher} * @returns {BroadcastDispatcher}
* @example * @example
* // Play streams using ytdl-core * // Play streams using ytdl-core
* const ytdl = require('ytdl-core'); * const ytdl = require('ytdl-core');
@ -87,7 +87,7 @@ class VoiceBroadcast extends EventEmitter {
* Plays a stream of 16-bit signed stereo PCM. * Plays a stream of 16-bit signed stereo PCM.
* @param {ReadableStream} stream The audio stream to play * @param {ReadableStream} stream The audio stream to play
* @param {StreamOptions} [options] Options for playing the stream * @param {StreamOptions} [options] Options for playing the stream
* @returns {StreamDispatcher} * @returns {BroadcastDispatcher}
*/ */
playConvertedStream(stream, options) { playConvertedStream(stream, options) {
return this.player.playPCMStream(stream, options); return this.player.playPCMStream(stream, options);
@ -98,7 +98,7 @@ class VoiceBroadcast extends EventEmitter {
* <warn>Note that inline volume is not compatible with this method.</warn> * <warn>Note that inline volume is not compatible with this method.</warn>
* @param {ReadableStream} stream The Opus audio stream to play * @param {ReadableStream} stream The Opus audio stream to play
* @param {StreamOptions} [options] Options for playing the stream * @param {StreamOptions} [options] Options for playing the stream
* @returns {StreamDispatcher} * @returns {BroadcastDispatcher}
*/ */
playOpusStream(stream, options) { playOpusStream(stream, options) {
return this.player.playOpusStream(stream, options); return this.player.playOpusStream(stream, options);