AKDecimator

open class AKDecimator : AKNode, AKToggleable, AUEffect, AKInput

AudioKit version of Apple’s Decimator from the Distortion Audio Unit

  • Four letter unique description of the node

    Declaration

    Swift

    public static let ComponentDescription: AudioComponentDescription
  • Decimation (Normalized Value) ranges from 0 to 1 (Default: 0.5)

    Declaration

    Swift

    @objc
    open dynamic var decimation: Double { get set }
  • Rounding (Normalized Value) ranges from 0 to 1 (Default: 0)

    Declaration

    Swift

    @objc
    open dynamic var rounding: Double { get set }
  • mix

    Mix (Normalized Value) ranges from 0 to 1 (Default: 1)

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    @objc
    public init(
        _ input: AKNode? = nil,
        decimation: Double = 0.5,
        rounding: Double = 0,
        mix: Double = 1)

    Parameters

    input

    Input node to process

    decimation

    Decimation (Normalized Value) ranges from 0 to 1 (Default: 0.5)

    rounding

    Rounding (Normalized Value) ranges from 0 to 1 (Default: 0)

    mix

    Mix (Normalized Value) ranges from 0 to 1 (Default: 1)

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