voice: add documentation to VoiceBroadcast

This commit is contained in:
Amish Shah
2019-03-23 12:22:55 +00:00
parent 9b2bf03ff6
commit 3df56540e2
2 changed files with 10 additions and 0 deletions

View File

@@ -27,6 +27,10 @@ class VoiceBroadcast extends EventEmitter {
* @type {Client}
*/
this.client = client;
/**
* The dispatchers playing this broadcast
* @type {Set<StreamDispatcher>}
*/
this.dispatchers = new DispatcherSet(this);
this.player = new BroadcastAudioPlayer(this);
}

View File

@@ -29,6 +29,12 @@ class BroadcastDispatcher extends StreamDispatcher {
super._destroy(err, cb);
}
/**
* Set the bitrate of the current Opus encoder if using a compatible Opus stream.
* @param {number} value New bitrate, in kbps
* If set to 'auto', 48kbps will be used
* @returns {boolean} true if the bitrate has been successfully changed.
*/
setBitrate(value) {
if (!value || !this.streams.opus || !this.streams.opus.setBitrate) return false;
const bitrate = value === 'auto' ? 48 : value;