Tone.js/Tone/effect/FeedbackDelay.ts
Yotam Mann f17249691d feat: updating all examples
now in the form Tone.Something instead of using `import { Something } from "tone"`. It makes the example runner on the docs page work much faster
2020-04-16 22:24:18 -04:00

73 lines
2 KiB
TypeScript

import { Delay } from "../core/context/Delay";
import { Param } from "../core/context/Param";
import { NormalRange, Time } from "../core/type/Units";
import { optionsFromArguments } from "../core/util/Defaults";
import { readOnly } from "../core/util/Interface";
import { FeedbackEffect, FeedbackEffectOptions } from "./FeedbackEffect";
interface FeedbackDelayOptions extends FeedbackEffectOptions {
delayTime: Time;
maxDelay: Time;
}
/**
* FeedbackDelay is a DelayNode in which part of output signal is fed back into the delay.
*
* @param delayTime The delay applied to the incoming signal.
* @param feedback The amount of the effected signal which is fed back through the delay.
* @example
* const feedbackDelay = new Tone.FeedbackDelay("8n", 0.5).toDestination();
* const tom = new Tone.MembraneSynth({
* octaves: 4,
* pitchDecay: 0.1
* }).connect(feedbackDelay);
* tom.triggerAttackRelease("A2", "32n");
* @category Effect
*/
export class FeedbackDelay extends FeedbackEffect<FeedbackDelayOptions> {
readonly name: string = "FeedbackDelay";
/**
* the delay node
*/
private _delayNode: Delay;
/**
* The delayTime of the FeedbackDelay.
*/
readonly delayTime: Param<"time">;
constructor(delayTime?: Time, feedback?: NormalRange);
constructor(options?: Partial<FeedbackDelayOptions>);
constructor() {
super(optionsFromArguments(FeedbackDelay.getDefaults(), arguments, ["delayTime", "feedback"]));
const options = optionsFromArguments(FeedbackDelay.getDefaults(), arguments, ["delayTime", "feedback"]);
this._delayNode = new Delay({
context: this.context,
delayTime: options.delayTime,
maxDelay: options.maxDelay,
});
this.delayTime = this._delayNode.delayTime;
// connect it up
this.connectEffect(this._delayNode);
readOnly(this, "delayTime");
}
static getDefaults(): FeedbackDelayOptions {
return Object.assign(FeedbackEffect.getDefaults(), {
delayTime: 0.25,
maxDelay: 1,
});
}
dispose(): this {
super.dispose();
this._delayNode.dispose();
this.delayTime.dispose();
return this;
}
}