mirror of
https://github.com/Tonejs/Tone.js
synced 2024-12-29 04:53:10 +00:00
101 lines
2.2 KiB
TypeScript
101 lines
2.2 KiB
TypeScript
import { Gain } from "../../core/context/Gain";
|
|
import { Param } from "../../core/context/Param";
|
|
import { InputNode, ToneAudioNode, ToneAudioNodeOptions } from "../../core/context/ToneAudioNode";
|
|
import { Decibels } from "../../core/type/Units";
|
|
import { optionsFromArguments } from "../../core/util/Defaults";
|
|
import { readOnly } from "../../core/util/Interface";
|
|
|
|
interface VolumeOptions extends ToneAudioNodeOptions {
|
|
volume: Decibels;
|
|
mute: boolean;
|
|
}
|
|
|
|
/**
|
|
* @class Volume is a simple volume node, useful for creating a volume fader.
|
|
*
|
|
* @extends {Tone.AudioNode}
|
|
* @constructor
|
|
* @param {Decibels} [volume=0] the initial volume
|
|
* @example
|
|
* var vol = new Volume(-12);
|
|
* instrument.chain(vol, Tone.Master);
|
|
*/
|
|
export class Volume extends ToneAudioNode<VolumeOptions> {
|
|
|
|
readonly name = "Volume";
|
|
|
|
/**
|
|
* the output node
|
|
*/
|
|
output: Gain<Decibels>;
|
|
|
|
/**
|
|
* Input and output are the same
|
|
*/
|
|
input: Gain;
|
|
|
|
/**
|
|
* The unmuted volume
|
|
*/
|
|
private _unmutedVolume: Decibels;
|
|
|
|
/**
|
|
* The volume control in decibels.
|
|
*/
|
|
volume: Param<Decibels>;
|
|
|
|
constructor(options?: Decibels | Partial<VolumeOptions>);
|
|
constructor() {
|
|
|
|
super(optionsFromArguments(Volume.getDefaults(), arguments, ["volume"]));
|
|
const options = optionsFromArguments(Volume.getDefaults(), arguments, ["volume"]);
|
|
|
|
this.input = this.output = new Gain({
|
|
context: this.context,
|
|
gain: options.volume,
|
|
units: "decibels",
|
|
});
|
|
this.volume = this.output.gain;
|
|
readOnly(this, "volume");
|
|
this._unmutedVolume = options.volume;
|
|
|
|
// set the mute initially
|
|
this.mute = options.mute;
|
|
}
|
|
|
|
static getDefaults(): VolumeOptions {
|
|
return Object.assign(ToneAudioNode.getDefaults(), {
|
|
mute: false,
|
|
volume: 0,
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Mute the output.
|
|
* @example
|
|
* //mute the output
|
|
* volume.mute = true;
|
|
*/
|
|
get mute(): boolean {
|
|
return this.volume.value === -Infinity;
|
|
}
|
|
set mute(mute: boolean) {
|
|
if (!this.mute && mute) {
|
|
this._unmutedVolume = this.volume.value;
|
|
// maybe it should ramp here?
|
|
this.volume.value = -Infinity;
|
|
} else if (this.mute && !mute) {
|
|
this.volume.value = this._unmutedVolume;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* clean up
|
|
*/
|
|
dispose(): this {
|
|
super.dispose();
|
|
this.input.dispose();
|
|
this.volume.dispose();
|
|
return this;
|
|
}
|
|
}
|