More volume docs

This commit is contained in:
Amish Shah
2017-10-26 16:44:21 +01:00
parent b83e12634c
commit c8a75e4c29
2 changed files with 11 additions and 3 deletions

View File

@@ -168,6 +168,7 @@ class StreamDispatcher extends Writable {
*/ */
get bitrateEditable() { return this.streams.opus && this.streams.opus.setBitrate; } get bitrateEditable() { return this.streams.opus && this.streams.opus.setBitrate; }
// Volume
get volume() { get volume() {
return this.player.streams.volume ? this.player.streams.volume.volume : 1; return this.player.streams.volume ? this.player.streams.volume.volume : 1;
} }
@@ -177,6 +178,13 @@ class StreamDispatcher extends Writable {
this.player.streams.volume.setVolume(value); this.player.streams.volume.setVolume(value);
return true; return true;
} }
// Volume stubs for docs
/* eslint-disable no-empty-function*/
get volumeDecibels() {}
get volumeLogarithmic() {}
setVolumeDecibels() {}
setVolumeLogarithmic() {}
} }
VolumeInterface.applyToClass(StreamDispatcher); VolumeInterface.applyToClass(StreamDispatcher);

View File

@@ -18,7 +18,7 @@ class VolumeInterface extends EventEmitter {
} }
/** /**
* The current volume of the broadcast * The current volume of the stream
* @readonly * @readonly
* @type {number} * @type {number}
*/ */
@@ -27,7 +27,7 @@ class VolumeInterface extends EventEmitter {
} }
/** /**
* The current volume of the broadcast in decibels * The current volume of the stream in decibels
* @readonly * @readonly
* @type {number} * @type {number}
*/ */
@@ -36,7 +36,7 @@ class VolumeInterface extends EventEmitter {
} }
/** /**
* The current volume of the broadcast from a logarithmic scale * The current volume of the stream from a logarithmic scale
* @readonly * @readonly
* @type {number} * @type {number}
*/ */