AKPeakLimiter

open class AKPeakLimiter : AKNode, AKToggleable, AUEffect, AKInput

AudioKit version of Apple’s PeakLimiter Audio Unit

  • Four letter unique description of the node

    Declaration

    Swift

    public static let ComponentDescription: AudioComponentDescription
  • Attack Duration (Secs) ranges from 0.001 to 0.03 (Default: 0.012)

    Declaration

    Swift

    @objc
    open dynamic var attackDuration: Double { get set }
  • Decay Duration (Secs) ranges from 0.001 to 0.06 (Default: 0.024)

    Declaration

    Swift

    @objc
    open dynamic var decayDuration: Double { get set }
  • Pre Gain (dB) ranges from -40 to 40 (Default: 0)

    Declaration

    Swift

    @objc
    open dynamic var preGain: Double { get set }
  • Dry/Wet Mix (Default 1)

    Declaration

    Swift

    @objc
    open dynamic var dryWetMix: Double { get set }
  • Tells whether the node is processing (ie. started, playing, or active)

    Declaration

    Swift

    @objc
    open dynamic var isStarted: Bool
  • Initialize the peak limiter node

    Declaration

    Swift

    @objc
    public init(
        _ input: AKNode? = nil,
        attackDuration: Double = 0.012,
        decayDuration: Double = 0.024,
        preGain: Double = 0)

    Parameters

    input

    Input node to process

    attackDuration

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

    decayDuration

    Decay Duration (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 var inputNode: AVAudioNode { get }
  • Function to start, play, or activate the node, all do the same thing

    Declaration

    Swift

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

    Declaration

    Swift

    @objc
    open func stop()
  • Disconnect the node

    Declaration

    Swift

    override open func detach()