From dd110f482499139360add88eee0e28609b38f247 Mon Sep 17 00:00:00 2001 From: Amish Shah Date: Sun, 30 Apr 2017 11:04:41 +0100 Subject: [PATCH] Add example for creating VoiceBroadcasts --- src/client/voice/VoiceBroadcast.js | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/client/voice/VoiceBroadcast.js b/src/client/voice/VoiceBroadcast.js index e9b9e63cb..b80efaf4a 100644 --- a/src/client/voice/VoiceBroadcast.js +++ b/src/client/voice/VoiceBroadcast.js @@ -13,6 +13,16 @@ const ffmpegArguments = [ /** * A voice broadcast can be played across multiple voice connections for improved shared-stream efficiency. + * + * Example usage: + * ```js + * const broadcast = client.createVoiceBroadcast(); + * broadcast.playFile('./music.mp3'); + * // play "music.mp3" in all voice connections that the client is in + * for (const connection of client.voiceConnections.values()) { + * connection.playBroadcast(broadcast); + * } + * ``` * @implements {VolumeInterface} */ class VoiceBroadcast extends VolumeInterface {