AKDynamicsProcessor

open class AKDynamicsProcessor: AKNode, AKToggleable, AUEffect

AudioKit version of Apple’s DynamicsProcessor Audio Unit

  • Undocumented

    Declaration

    Swift

    open class AKDynamicsProcessor: AKNode, AKToggleable, AUEffect
  • Threshold (dB) ranges from -40 to 20 (Default: -20)

    Declaration

    Swift

    open dynamic var threshold: Double = -20
  • Head Room (dB) ranges from 0.1 to 40.0 (Default: 5)

    Declaration

    Swift

    open dynamic var headRoom: Double = 5
  • Expansion Ratio (rate) ranges from 1 to 50.0 (Default: 2)

    Declaration

    Swift

    open dynamic var expansionRatio: Double = 2
  • Expansion Threshold (rate) ranges from 1 to 50.0 (Default: 2)

    Declaration

    Swift

    open dynamic var expansionThreshold: Double = 2
  • Attack Time (secs) ranges from 0.0001 to 0.2 (Default: 0.001)

    Declaration

    Swift

    open dynamic var attackTime: Double = 0.001
  • Release Time (secs) ranges from 0.01 to 3 (Default: 0.05)

    Declaration

    Swift

    open dynamic var releaseTime: Double = 0.05
  • Master Gain (dB) ranges from -40 to 40 (Default: 0)

    Declaration

    Swift

    open dynamic var masterGain: Double = 0
  • Compression Amount (dB) read only

    Declaration

    Swift

    open dynamic var compressionAmount: Double
  • Input Amplitude (dB) read only

    Declaration

    Swift

    open dynamic var inputAmplitude: Double
  • Output Amplitude (dB) read only

    Declaration

    Swift

    open dynamic var outputAmplitude: Double
  • Dry/Wet Mix (Default 100)

    Declaration

    Swift

    open dynamic var dryWetMix: Double = 100
  • Tells whether the node is processing (ie. started, playing, or active)

    Declaration

    Swift

    open dynamic var isStarted = true
  • Initialize the dynamics processor node

    • Parameters:
      • input: Input node to process
      • threshold: Threshold (dB) ranges from -40 to 20 (Default: -20)
      • headRoom: Head Room (dB) ranges from 0.1 to 40.0 (Default: 5)
      • expansionRatio: Expansion Ratio (rate) ranges from 1 to 50.0 (Default: 2)
      • expansionThreshold: Expansion Threshold (rate) ranges from 1 to 50.0 (Default: 2)
      • attackTime: Attack Time (secs) ranges from 0.0001 to 0.2 (Default: 0.001)
      • releaseTime: Release Time (secs) ranges from 0.01 to 3 (Default: 0.05)
      • masterGain: Master Gain (dB) ranges from -40 to 40 (Default: 0)
      • compressionAmount: Compression Amount (dB) ranges from -40 to 40 (Default: 0)
      • inputAmplitude: Input Amplitude (dB) ranges from -40 to 40 (Default: 0)
      • outputAmplitude: Output Amplitude (dB) ranges from -40 to 40 (Default: 0)

    Declaration

    Swift

    public init(
            _ input: AKNode?,
            threshold: Double = -20,
            headRoom: Double = 5,
            expansionRatio: Double = 2,
            expansionThreshold: Double = 2,
            attackTime: Double = 0.001,
            releaseTime: Double = 0.05,
            masterGain: Double = 0,
            compressionAmount: Double = 0,
            inputAmplitude: Double = 0,
            outputAmplitude: Double = 0)

    Parameters

    input

    Input node to process

    threshold

    Threshold (dB) ranges from -40 to 20 (Default: -20)

    headRoom

    Head Room (dB) ranges from 0.1 to 40.0 (Default: 5)

    expansionRatio

    Expansion Ratio (rate) ranges from 1 to 50.0 (Default: 2)

    expansionThreshold

    Expansion Threshold (rate) ranges from 1 to 50.0 (Default: 2)

    attackTime

    Attack Time (secs) ranges from 0.0001 to 0.2 (Default: 0.001)

    releaseTime

    Release Time (secs) ranges from 0.01 to 3 (Default: 0.05)

    masterGain

    Master Gain (dB) ranges from -40 to 40 (Default: 0)

    compressionAmount

    Compression Amount (dB) ranges from -40 to 40 (Default: 0)

    inputAmplitude

    Input Amplitude (dB) ranges from -40 to 40 (Default: 0)

    outputAmplitude

    Output Amplitude (dB) ranges from -40 to 40 (Default: 0)

  • Function to start, play, or activate the node, all do the same thing

    Declaration

    Swift

    open func start()
  • Function to stop or bypass the node, both are equivalent

    Declaration

    Swift

    open func stop()
  • Disconnect the node

    Declaration

    Swift

    override open func disconnect()