AKThreePoleLowpassFilter

open class AKThreePoleLowpassFilter : AKNode, AKToggleable, AKComponent, AKInput

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

  • Lower and upper bounds for Distortion

    Declaration

    Swift

    public static let distortionRange: ClosedRange<Double>
  • Lower and upper bounds for Cutoff Frequency

    Declaration

    Swift

    public static let cutoffFrequencyRange: ClosedRange<Double>
  • Lower and upper bounds for Resonance

    Declaration

    Swift

    public static let resonanceRange: ClosedRange<Double>
  • Initial value for Distortion

    Declaration

    Swift

    public static let defaultDistortion: Double
  • Initial value for Cutoff Frequency

    Declaration

    Swift

    public static let defaultCutoffFrequency: Double
  • Initial value for Resonance

    Declaration

    Swift

    public static let defaultResonance: Double
  • Ramp Duration represents the speed at which parameters are allowed to change

    Declaration

    Swift

    @objc
    open dynamic var rampDuration: Double { get set }
  • 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 { get set }
  • Filter cutoff frequency in Hertz.

    Declaration

    Swift

    @objc
    open dynamic var cutoffFrequency: Double { get set }
  • 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 { get set }
  • Tells whether the node is processing (ie. started, playing, or active)

    Declaration

    Swift

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

    Declaration

    Swift

    @objc
    public init(
        _ input: AKNode? = nil,
        distortion: Double = defaultDistortion,
        cutoffFrequency: Double = defaultCutoffFrequency,
        resonance: Double = defaultResonance
        )

    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

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