AKThreePoleLowpassFilter

open class AKThreePoleLowpassFilter: AKNode, AKToggleable, AKComponent, AKInput

3-pole (18 db/oct slope) Low-Pass filter with resonance and tanh distortion.

  • Four letter unique description of the node

    Declaration

    Swift

    public static let ComponentDescription = AudioComponentDescription(effect: "lp18")
  • Ramp Time represents the speed at which parameters are allowed to change

    Declaration

    Swift

    @objc open dynamic var rampTime: Double = AKSettings.rampTime
  • Distortion amount. Zero gives a clean output. Greater than zero adds tanh distortion controlled by the filter parameters, in such a way that both low cutoff and high resonance increase the distortion amount.

    Declaration

    Swift

    @objc open dynamic var distortion: Double = 0.5
  • Filter cutoff frequency in Hertz.

    Declaration

    Swift

    @objc open dynamic var cutoffFrequency: Double = 1_500
  • Resonance. Usually a value in the range 0-1. A value of 1.0 will self oscillate at the cutoff frequency. Values slightly greater than 1 are possible for more sustained oscillation and an “overdrive” effect.

    Declaration

    Swift

    @objc open dynamic var resonance: Double = 0.5
  • Tells whether the node is processing (ie. started, playing, or active)

    Declaration

    Swift

    @objc open dynamic var isStarted: Bool
  • Initialize this filter node

    Declaration

    Swift

    public init(
            _ input: AKNode? = nil,
            distortion: Double = 0.5,
            cutoffFrequency: Double = 1_500,
            resonance: Double = 0.5)

    Parameters

    input

    Input node to process

    distortion

    Distortion amount. Zero gives a clean output. Greater than zero adds tanh distortion controlled by the filter parameters, in such a way that both low cutoff and high resonance increase the distortion amount.

    cutoffFrequency

    Filter cutoff frequency in Hertz.

    resonance

    Usually a value in the range 0-1. A value of 1.0 will self oscillate at the cutoff frequency. Values slightly greater than 1 are possible for more sustained oscillation and an “overdrive” effect.

  • 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()