Tone.js/Tone/core/Delay.js

define(["../core/Tone", "../core/Param", "../core/AudioNode"], function(Tone){

	"use strict";

	/**
	 *  @class Wrapper around Web Audio's native [DelayNode](http://webaudio.github.io/web-audio-api/#the-delaynode-interface).
	 *  @extends {Tone}
	 *  @param {Time=} delayTime The delay applied to the incoming signal.
	 *  @param {Time=} maxDelay The maximum delay time.
	 */
	Tone.Delay = function(){

		var options = Tone.defaults(arguments, ["delayTime", "maxDelay"], Tone.Delay);
		Tone.AudioNode.call(this, options);

		/**
		 * The maximum delay time initialized with the node
		 * @type {Number}
		 * @private
		 */
		this._maxDelay = Math.max(this.toSeconds(options.maxDelay), this.toSeconds(options.delayTime));
		
		/**
		 *  The native delay node
		 *  @type {DelayNode}
		 *  @private
		 */
		this._delayNode = this.input = this.output = this.context.createDelay(this._maxDelay);

		/**
		 *  The amount of time the incoming signal is
		 *  delayed.
		 *  @type {Time}
		 *  @signal
		 */
		this.delayTime = new Tone.Param({
			"param" : this._delayNode.delayTime,
			"units" : Tone.Type.Time,
			"value" : options.delayTime
		});

		this._readOnly("delayTime");
	};

	Tone.extend(Tone.Delay, Tone.AudioNode);

	/**
	 *  The defaults
	 *  @const
	 *  @type  {Object}
	 */
	Tone.Delay.defaults = {
		"maxDelay" : 1,
		"delayTime" : 0
	};

	/**
	 * The maximum delay time. This cannot be changed. The value is passed into the constructor.
	 * @memberof Tone.Delay#
	 * @type {Time}
	 * @name maxDelay
	 * @readOnly
	 */
	Object.defineProperty(Tone.Delay.prototype, "maxDelay", {
		get : function(){
			return this._maxDelay;
		}
	});

	/**
	 *  Clean up.
	 *  @return  {Tone.Delay}  this
	 */
	Tone.Delay.prototype.dispose = function(){
		Tone.AudioNode.prototype.dispose.call(this);
		this._delayNode.disconnect();
		this._delayNode = null;
		this._writable("delayTime");
		this.delayTime = null;
		return this;
	};

	return Tone.Delay;
});