From d13c48bafaf1145b1a88756a9daa1f267575bd8f Mon Sep 17 00:00:00 2001 From: Amish Shah Date: Fri, 30 Dec 2016 18:10:48 +0000 Subject: [PATCH] more tiny voice docs --- src/client/Client.js | 4 ++++ src/client/voice/VoiceBroadcast.js | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/client/Client.js b/src/client/Client.js index 2e7d18157..4a68f7735 100644 --- a/src/client/Client.js +++ b/src/client/Client.js @@ -226,6 +226,10 @@ class Client extends EventEmitter { return typeof window !== 'undefined'; } + /** + * Creates a new voice broadcast + * @returns {VoiceBroadcast} the created broadcast + */ createVoiceBroadcast() { const broadcast = new VoiceBroadcast(this); this.broadcasts.push(broadcast); diff --git a/src/client/voice/VoiceBroadcast.js b/src/client/voice/VoiceBroadcast.js index 7dc4be002..9509ece7a 100644 --- a/src/client/voice/VoiceBroadcast.js +++ b/src/client/voice/VoiceBroadcast.js @@ -12,7 +12,7 @@ const ffmpegArguments = [ ]; /** - * A voice broadcast that can be played across multiple voice connections + * A voice broadcast can be played across multiple voice connections for improved shared-stream efficiency. * @extends {EventEmitter} */ class VoiceBroadcast extends EventEmitter {