Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Compressor

Represents a Compressor.

beta

Hierarchy

Index

Constructors

constructor

Properties

attack

attack: number

The attack in milliseconds for this object.

gain

gain: number

The gain for this object.

Defaults to 1.0.

gainDecibels

gainDecibels: number

The dBFS level for this object.

Defaults to 0.0

Optional id

The identifier of this node.

input

input: [ObjectID, Channel][]

The audio input channels of this audio unit.

midiIn

midiIn: [ObjectID, Channel]

The midi input for this audio unit.

output

output: [ObjectID, Channel][]

The audio output channels of this audio unit.

pan

pan: number

The pan for this object.

Defaults to 0.0; -1.0 = left, 0.0 = centre, 1.0 = right.

ratio

ratio: number

The ratio for this object. >= 1.0

release

release: number

The release in milliseconds for this object.

sideChainEnabled

sideChainEnabled: boolean

Indicates whether or not the sidechain input is enabled. If this is set to true then inputs 2 and 3 can be used as sidechain inputs for this object.

threshold

threshold: number

The threshold in dB for this object.

Methods

connect

  • Connects this object's output to the specified destination object's input ("output" if the destination is a graph).

    Parameters

    • destination: AudioUnit | Graph

      The AudioUnit | Graph to which to connect.

    • Optional outputIndex: number

      An index specifying which output of this AudioUnit to connect to the destination.

    • Optional inputIndex: number

      An index describing which input of the destination you want to connect this AudioUnit to.

      Returns a reference to the destination AudioUnit object allowing you to chain multiple connect() calls. If the destination is a Graph object, connect() returns undefined.

    Returns AudioUnit | undefined

Generated using TypeDoc