From 6d4fe89212dca33dcbd22f79993a90e2656b8e40 Mon Sep 17 00:00:00 2001 From: aemino Date: Mon, 10 Apr 2017 03:50:33 -0700 Subject: [PATCH] Volume stuff docs fixes (#1354) * Volume stuff docs fixes * 10/10 for spelling --- src/client/voice/VoiceBroadcast.js | 2 +- src/client/voice/dispatcher/StreamDispatcher.js | 2 +- src/client/voice/util/VolumeInterface.js | 4 ++++ 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/client/voice/VoiceBroadcast.js b/src/client/voice/VoiceBroadcast.js index cd1609955..1256d7cb8 100644 --- a/src/client/voice/VoiceBroadcast.js +++ b/src/client/voice/VoiceBroadcast.js @@ -13,7 +13,7 @@ const ffmpegArguments = [ /** * A voice broadcast can be played across multiple voice connections for improved shared-stream efficiency. - * @extends {EventEmitter} + * @implements {VolumeInterface} */ class VoiceBroadcast extends VolumeInterface { constructor(client) { diff --git a/src/client/voice/dispatcher/StreamDispatcher.js b/src/client/voice/dispatcher/StreamDispatcher.js index 5c3cacddb..42d6efa8d 100644 --- a/src/client/voice/dispatcher/StreamDispatcher.js +++ b/src/client/voice/dispatcher/StreamDispatcher.js @@ -15,7 +15,7 @@ nonce.fill(0); * const dispatcher = connection.playFile('./file.mp3'); * }); * ``` - * @extends {EventEmitter} + * @implements {VolumeInterface} */ class StreamDispatcher extends VolumeInterface { constructor(player, stream, streamOptions) { diff --git a/src/client/voice/util/VolumeInterface.js b/src/client/voice/util/VolumeInterface.js index b12f1e4bc..730b141a8 100644 --- a/src/client/voice/util/VolumeInterface.js +++ b/src/client/voice/util/VolumeInterface.js @@ -1,5 +1,9 @@ const EventEmitter = require('events'); +/** + * An interface class for volume transformation. + * @extends {EventEmitter} + */ class VolumeInterface extends EventEmitter { constructor({ volume = 0 } = {}) { super();