Documentation
    Preparing search index...

    Class AbstractParam<TypeName>Abstract

    Abstract base class for Param and Signal

    Type Parameters

    Implemented by

    Index
    constructor
    convert maxValue minValue overridden units value
    cancelAndHoldAtTime cancelScheduledValues exponentialApproachValueAtTime exponentialRampTo exponentialRampToValueAtTime getValueAtTime linearRampTo linearRampToValueAtTime rampTo setRampPoint setTargetAtTime setValueAtTime setValueCurveAtTime targetRampTo
    convert: boolean

    If the value should be converted or not

    maxValue: number

    The maximum value of the output given the units

    minValue: number

    The minimum value of the output given the units

    overridden: boolean

    True if the signal value is being overridden by a connected signal. Internal use only.

    units: keyof UnitMap

    The unit type

    value: UnitMap[TypeName]

    The current value of the parameter. Setting this value is equivalent to setValueAtTime(value, context.currentTime)

    • This is similar to cancelScheduledValues except it holds the automated value at time until the next automated event.

      Parameters

      Returns this

      return Tone.Offline(() => {
      	const signal = new Tone.Signal(0).toDestination();
      	signal.linearRampTo(1, 0.5, 0);
      	signal.cancelAndHoldAtTime(0.3);
      }, 0.5, 1);

    • Cancels all scheduled parameter changes with times greater than or equal to startTime.

      Parameters

      Returns this

      return Tone.Offline(() => {
      	const signal = new Tone.Signal(0).toDestination();
      	signal.setValueAtTime(0.1, 0.1);
      	signal.setValueAtTime(0.2, 0.2);
      	signal.setValueAtTime(0.3, 0.3);
      	signal.setValueAtTime(0.4, 0.4);
      	// cancels the last two scheduled changes
      	signal.cancelScheduledValues(0.3);
      }, 0.5, 1);

    • Start exponentially approaching the target value at the given time. Since it is an exponential approach it will continue approaching after the ramp duration. The rampTime is the time that it takes to reach over 99% of the way towards the value. This methods is similar to setTargetAtTime except the third argument is a time instead of a 'timeConstant'

      Parameters

      • value: UnitMap[TypeName]

        The value to ramp to.

      • time: Time

        When the ramp should start.

      • rampTime: Time

        the time that it takes the value to ramp from it's current value

      Returns this

      const osc = new Tone.Oscillator().toDestination().start();
      // exponential approach over 4 seconds starting in 1 second
      osc.frequency.exponentialApproachValueAtTime("C4", "+1", 4);

    • Schedules an exponential continuous change in parameter value from the current time and current value to the given value over the duration of the rampTime.

      Parameters

      • value: UnitMap[TypeName]

        The value to ramp to.

      • rampTime: Time

        the time that it takes the value to ramp from it's current value

      • OptionalstartTime: Time

        When the ramp should start.

      Returns this

      const delay = new Tone.FeedbackDelay(0.5, 0.98).toDestination();
      // a short burst of noise through the feedback delay
      const noise = new Tone.Noise().connect(delay).start().stop("+0.1");
      // making the delay time shorter over time will also make the pitch rise
      delay.delayTime.exponentialRampTo(0.01, 20);

      return Tone.Offline(() => {
      	const signal = new Tone.Signal(.1).toDestination();
      	signal.exponentialRampTo(5, 0.3, 0.1);
      }, 0.5, 1);

    • Schedules an exponential continuous change in parameter value from the previous scheduled parameter value to the given value.

      Parameters

      Returns this

      return Tone.Offline(() => {
      	const signal = new Tone.Signal(1).toDestination();
      	// the ramp starts from the previously scheduled value, which must be positive
      	signal.setValueAtTime(1, 0.1);
      	signal.exponentialRampToValueAtTime(0, 0.4);
      }, 0.5, 1);

    • Get the signals value at the given time. Subsequent scheduling may invalidate the returned value.

      Parameters

      • time: Time

        When to get the value

      Returns UnitMap[TypeName]

      const signal = new Tone.Signal().toDestination();
      // ramp up to '8' over 3 seconds
      signal.rampTo(8, 3);
      // ramp back down to '0' over 3 seconds
      signal.rampTo(0, 3, "+3");
      setInterval(() => {
      	// check the value every 100 ms
      	console.log(signal.getValueAtTime(Tone.now()));
      }, 100);

    • Schedules an linear continuous change in parameter value from the current time and current value to the given value over the duration of the rampTime.

      Parameters

      • value: UnitMap[TypeName]

        The value to ramp to.

      • rampTime: Time

        the time that it takes the value to ramp from it's current value

      • OptionalstartTime: Time

        When the ramp should start.

      Returns this

      this

      const delay = new Tone.FeedbackDelay(0.5, 0.98).toDestination();
      // a short burst of noise through the feedback delay
      const noise = new Tone.Noise().connect(delay).start().stop("+0.1");
      // making the delay time shorter over time will also make the pitch rise
      delay.delayTime.linearRampTo(0.01, 20);

      return Tone.Offline(() => {
      	const signal = new Tone.Signal(1).toDestination();
      	signal.linearRampTo(0, 0.3, 0.1);
      }, 0.5, 1);

    • Schedules a linear continuous change in parameter value from the previous scheduled parameter value to the given value.

      Parameters

      Returns this

      return Tone.Offline(() => {
      	const signal = new Tone.Signal(0).toDestination();
      	// the ramp starts from the previously scheduled value
      	signal.setValueAtTime(0, 0.1);
      	signal.linearRampToValueAtTime(1, 0.4);
      }, 0.5, 1);

    • Ramps to the given value over the duration of the rampTime. Automatically selects the best ramp type (exponential or linear) depending on the units of the signal

      Parameters

      • value: UnitMap[TypeName]
      • rampTime: Time

        The time that it takes the value to ramp from it's current value

      • OptionalstartTime: Time

        When the ramp should start.

      Returns this

      const osc = new Tone.Oscillator().toDestination().start();
      // schedule it to ramp either linearly or exponentially depending on the units
      osc.frequency.rampTo("A2", 10);

      const osc = new Tone.Oscillator().toDestination().start();
      // schedule it to ramp starting at a specific time
      osc.frequency.rampTo("A2", 10, "+2");

    • Creates a schedule point with the current value at the current time. Automation methods like linearRampToValueAtTime and exponentialRampToValueAtTime require a starting automation value usually set by setValueAtTime. This method is useful since it will do a setValueAtTime with whatever the currently computed value at the given time is.

      Parameters

      • time: Time

        When to add a ramp point.

      Returns this

      const osc = new Tone.Oscillator().toDestination().start();
      // set the frequency to "G4" in exactly 1 second from now.
      osc.frequency.setRampPoint("+1");
      osc.frequency.linearRampToValueAtTime("C1", "+2");

    • Start exponentially approaching the target value at the given time with a rate having the given time constant.

      Parameters

      Returns this

    • Schedules a parameter value change at the given time.

      Parameters

      • value: UnitMap[TypeName]

        The value to set the signal.

      • time: Time

        The time when the change should occur.

      Returns this

      return Tone.Offline(() => {
      	const osc = new Tone.Oscillator(20).toDestination().start();
      	// set the frequency to 40 at exactly 0.25 seconds
      	osc.frequency.setValueAtTime(40, 0.25);
      }, 0.5, 1);

    • Sets an array of arbitrary parameter values starting at the given time for the given duration.

      Parameters

      • values: UnitMap[TypeName][]
      • startTime: Time
      • duration: Time
      • Optionalscaling: number

        If the values in the curve should be scaled by some value

      Returns this

      return Tone.Offline(() => {
      	const signal = new Tone.Signal(1).toDestination();
      	signal.setValueCurveAtTime([1, 0.2, 0.8, 0.1, 0], 0.2, 0.3);
      }, 0.5, 1);

    • Start exponentially approaching the target value at the given time. Since it is an exponential approach it will continue approaching after the ramp duration. The rampTime is the time that it takes to reach over 99% of the way towards the value.

      Parameters

      • value: UnitMap[TypeName]

        The value to ramp to.

      • rampTime: Time

        the time that it takes the value to ramp from it's current value

      • OptionalstartTime: Time

        When the ramp should start.

      Returns this

      

      return Tone.Offline(() => {
      	const signal = new Tone.Signal(1).toDestination();
      	signal.targetRampTo(0, 0.3, 0.1);
      }, 0.5, 1);

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods