Documentation
    Preparing search index...

    Class Signal<TypeName>

    A signal is an audio-rate value. Tone.Signal is a core component of the library. Unlike a number, Signals can be scheduled with sample-level accuracy. Tone.Signal has all of the methods available to native Web Audio AudioParam as well as additional conveniences. Read more about working with signals here.

    const osc = new Tone.Oscillator().toDestination().start();
    // a scheduleable signal which can be connected to control an AudioParam or another Signal
    const signal = new Tone.Signal({
    	value: "C4",
    	units: "frequency"
    }).connect(osc.frequency);
    // the scheduled ramp controls the connected signal
    signal.rampTo("C2", 4, "+0.5");

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index
    constructor
    _constantSource _internalChannels _param context debug input name output override version
    blockTime channelCount channelCountMode channelInterpretation convert disposed maxValue minValue numberOfInputs numberOfOutputs overridden sampleTime units value
    _getPartialProperties apply cancelAndHoldAtTime cancelScheduledValues chain connect disconnect dispose exponentialApproachValueAtTime exponentialRampTo exponentialRampToValueAtTime fan get getValueAtTime immediate linearRampTo linearRampToValueAtTime log now rampTo set setRampPoint setTargetAtTime setValueAtTime setValueCurveAtTime targetRampTo toDestination toFrequency toMaster toSeconds toString toTicks getDefaults

    Protected_constantSource

    _constantSource: ToneConstantSource<TypeName>

    The constant source node which generates the signal

    Protected_internalChannels

    _internalChannels: OutputNode[]

    List all of the node that must be set to match the ChannelProperties

    Protected_param

    _param: Param<TypeName>
    context: BaseContext

    The context belonging to the node.

    debug: boolean

    Set this debug flag to log all events that happen in this class.

    input: InputNode

    The input node or nodes. If the object is a source, it does not have any input and this.input is undefined.

    name: string

    The name of the class

    output: OutputNode

    The output nodes. If the object is a sink, it does not have any output and this.output is undefined.

    override: boolean

    Indicates if the value should be overridden on connection.

    version: string

    The version number semver

    • get blockTime(): number

      The number of seconds of 1 processing block (128 samples)

      Returns number

      console.log(Tone.Destination.blockTime);
    • get channelCount(): number

      channelCount is the number of channels used when up-mixing and down-mixing connections to any inputs to the node. The default value is 2 except for specific nodes where its value is specially determined.

      Returns number

    • set channelCount(channelCount: number): void

      Parameters

      • channelCount: number

      Returns void

    • get channelCountMode(): ChannelCountMode

      channelCountMode determines how channels will be counted when up-mixing and down-mixing connections to any inputs to the node. The default value is "max". This attribute has no effect for nodes with no inputs.

      • "max" - computedNumberOfChannels is the maximum of the number of channels of all connections to an input. In this mode channelCount is ignored.
      • "clamped-max" - computedNumberOfChannels is determined as for "max" and then clamped to a maximum value of the given channelCount.
      • "explicit" - computedNumberOfChannels is the exact value as specified by the channelCount.

      Returns ChannelCountMode

    • set channelCountMode(channelCountMode: ChannelCountMode): void

      Parameters

      Returns void

    • get channelInterpretation(): ChannelInterpretation

      channelInterpretation determines how individual channels will be treated when up-mixing and down-mixing connections to any inputs to the node. The default value is "speakers".

      Returns ChannelInterpretation

    • set channelInterpretation(channelInterpretation: ChannelInterpretation): void

      Parameters

      Returns void

    • get convert(): boolean

      If the value should be converted or not

      Returns boolean

    • set convert(convert: boolean): void

      If the value should be converted or not

      Parameters

      • convert: boolean

      Returns void

    • get disposed(): boolean

      Indicates if the instance was disposed. 'Disposing' an instance means that all of the Web Audio nodes that were created for the instance are disconnected and freed for garbage collection.

      Returns boolean

    • get maxValue(): number

      The maximum value of the output given the units

      Returns number

    • get minValue(): number

      The minimum value of the output given the units

      Returns number

    • get numberOfInputs(): number

      The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

      Returns number

      const node = new Tone.Gain();
      console.log(node.numberOfInputs);
    • get numberOfOutputs(): number

      The number of outputs of the AudioNode.

      Returns number

      const node = new Tone.Gain();
      console.log(node.numberOfOutputs);
    • get overridden(): boolean

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

      Returns boolean

    • set overridden(overridden: boolean): void

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

      Parameters

      • overridden: boolean

      Returns void

    • get sampleTime(): number

      The duration in seconds of one sample.

      Returns number

    • get units(): keyof UnitMap

      The unit type

      Returns keyof UnitMap

    • get value(): UnitMap[TypeName]

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

      Returns UnitMap[TypeName]

    • set value(value: UnitMap[TypeName]): void

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

      Parameters

      Returns void

    Protected_getPartialProperties

    • Parameters

      • param: AudioParam | Param<"number">

      Returns this

      Param.apply.

    • 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);

    • Connect the output of this node to the rest of the nodes in series.

      Parameters

      Returns this

      const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/handdrum-loop.mp3");
      player.autostart = true;
      const filter = new Tone.AutoFilter(4).start();
      const distortion = new Tone.Distortion(0.5);
      // connect the player to the filter, distortion and then to the master output
      player.chain(filter, distortion, Tone.Destination);

    • connect the output of a ToneAudioNode to an AudioParam, AudioNode, or ToneAudioNode

      Parameters

      • destination: InputNode

        The output to connect to

      • OptionaloutputNum: number

        The output to connect from

      • OptionalinputNum: number

        The input to connect to

      Returns this

    • disconnect the output

      Parameters

      • Optionaldestination: InputNode
      • OptionaloutputNum: number
      • OptionalinputNum: number

      Returns this

    • Dispose and disconnect

      Returns this

    • 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);

    • connect the output of this node to the rest of the nodes in parallel.

      Parameters

      Returns this

      const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/conga-rhythm.mp3");
      player.autostart = true;
      const pitchShift = new Tone.PitchShift(4).toDestination();
      const filter = new Tone.Filter("G5").toDestination();
      // connect a node to the pitch shift and filter in parallel
      player.fan(pitchShift, filter);

    • Get the object's attributes.

      Returns SignalOptions

      const osc = new Tone.Oscillator();
      console.log(osc.get());

    • 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);

    • Return the current time of the Context clock without any lookAhead.

      Returns number

      setInterval(() => {
      	console.log(Tone.immediate());
      }, 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);

    • Prints the outputs to the console log for debugging purposes. Prints the contents only if either the object has a property called debug set to true, or a variable called TONE_DEBUG_CLASS is set to the name of the class.

      Parameters

      • ...args: any[]

      Returns void

      const osc = new Tone.Oscillator();
      // prints all logs originating from this oscillator
      osc.debug = true;
      // calls to start/stop will print in the console
      osc.start();

    • Return the current time of the Context clock plus the lookAhead.

      Returns number

      setInterval(() => {
      	console.log(Tone.now());
      }, 100);

    • 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");

    • Set multiple properties at once with an object.

      Parameters

      Returns this

      const filter = new Tone.Filter().toDestination();
      // set values using an object
      filter.set({
      	frequency: "C6",
      	type: "highpass"
      });
      const player = new Tone.Player("https://tonejs.github.io/audio/berklee/Analogsynth_octaves_highmid.mp3").connect(filter);
      player.autostart = true;

    • 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);

    • Connect the output to the context's destination node.

      Returns this

      const osc = new Tone.Oscillator("C2").start();
      osc.toDestination();

    • Convert the input to a frequency number

      Parameters

      Returns number

      const gain = new Tone.Gain();
      console.log(gain.toFrequency("4n"));

    • Connect the output to the context's destination node.

      Returns this

      toDestination

    • Convert the incoming time to seconds. This is calculated against the current TransportClass bpm

      Parameters

      Returns number

      const gain = new Tone.Gain();
      setInterval(() => console.log(gain.toSeconds("4n")), 100);
      // ramp the tempo to 60 bpm over 30 seconds
      Tone.getTransport().bpm.rampTo(60, 30);

    • Convert the class to a string

      Returns string

      const osc = new Tone.Oscillator();
      console.log(osc.toString());

    • Convert the input time into ticks

      Parameters

      Returns number

      const gain = new Tone.Gain();
      console.log(gain.toTicks("4n"));

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods