Class Compressor

Compressor is a thin wrapper around the Web Audio DynamicsCompressorNode. Compression reduces the volume of loud sounds or amplifies quiet sounds by narrowing or "compressing" an audio signal's dynamic range. Read more on Wikipedia.

Example

const comp = new Tone.Compressor(-30, 3);

Hierarchy (view full)

Constructors

Properties

attack: Param<"time">

The amount of time (in seconds) to reduce the gain by 10dB.

Min

0

Max

1

context: BaseContext

The context belonging to the node.

debug: boolean = false

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

input: DynamicsCompressorNode = ...

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

knee: Param<"decibels">

A decibel value representing the range above the threshold where the curve smoothly transitions to the "ratio" portion.

Min

0

Max

40

name: string = "Compressor"

The name of the class

output: DynamicsCompressorNode = ...

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

ratio: Param<"positive">

The amount of dB change in input for a 1 dB change in output.

Min

1

Max

20

release: Param<"time">

The amount of time (in seconds) to increase the gain by 10dB.

Min

0

Max

1

threshold: Param<"decibels">

The decibel value above which the compression will start taking effect.

Min

-100

Max

0

version: string = version

The version number semver

Accessors

  • get blockTime(): number
  • The number of seconds of 1 processing block (128 samples)

    Returns number

    Example

    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): 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): void
  • Parameters

    • channelCountMode: ChannelCountMode

    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): void
  • Parameters

    • channelInterpretation: ChannelInterpretation

    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 numberOfInputs(): number
  • The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

    Returns number

    Example

    const node = new Tone.Gain();
    console.log(node.numberOfInputs);
  • get numberOfOutputs(): number
  • The number of outputs of the AudioNode.

    Returns number

    Example

    const node = new Tone.Gain();
    console.log(node.numberOfOutputs);
  • get reduction(): number
  • A read-only decibel value for metering purposes, representing the current amount of gain reduction that the compressor is applying to the signal. If fed no signal the value will be 0 (no gain reduction).

    Returns number

Methods

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

    Parameters

    Returns this

    Example

    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

    • outputNum: number = 0

      The output to connect from

    • inputNum: number = 0

      The input to connect to

    Returns this

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

    Parameters

    Returns this

    Example

    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);
  • Set multiple properties at once with an object.

    Parameters

    Returns this

    Example

    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;
  • Convert the incoming time to seconds. This is calculated against the current TransportClass bpm

    Parameters

    Returns number

    Example

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