AKPeakLimiter

open class AKPeakLimiter: AKNode, AKToggleable, AUEffect

AudioKit version of Apple’s PeakLimiter Audio Unit

  • Undocumented

    Declaration

    Swift

    open class AKPeakLimiter: AKNode, AKToggleable, AUEffect
  • Attack Time (Secs) ranges from 0.001 to 0.03 (Default: 0.012)

    Declaration

    Swift

    open dynamic var attackTime: Double = 0.012
  • Decay Time (Secs) ranges from 0.001 to 0.06 (Default: 0.024)

    Declaration

    Swift

    open dynamic var decayTime: Double = 0.024
  • Pre Gain (dB) ranges from -40 to 40 (Default: 0)

    Declaration

    Swift

    open dynamic var preGain: Double = 0
  • 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 peak limiter node

    • Parameters:
      • input: Input node to process
      • attackTime: Attack Time (Secs) ranges from 0.001 to 0.03 (Default: 0.012)
      • decayTime: Decay Time (Secs) ranges from 0.001 to 0.06 (Default: 0.024)
      • preGain: Pre Gain (dB) ranges from -40 to 40 (Default: 0)

    Declaration

    Swift

    public init(
            _ input: AKNode?,
            attackTime: Double = 0.012,
            decayTime: Double = 0.024,
            preGain: Double = 0)

    Parameters

    input

    Input node to process

    attackTime

    Attack Time (Secs) ranges from 0.001 to 0.03 (Default: 0.012)

    decayTime

    Decay Time (Secs) ranges from 0.001 to 0.06 (Default: 0.024)

    preGain

    Pre Gain (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()