AKRingModulator

open class AKRingModulator: AKNode, AKToggleable, AUEffect

AudioKit version of Apple’s Ring Modulator from the Distortion Audio Unit

  • Undocumented

    Declaration

    Swift

    open class AKRingModulator: AKNode, AKToggleable, AUEffect
  • Frequency1 (Hertz) ranges from 0.5 to 8000 (Default: 100)

    Declaration

    Swift

    open dynamic var frequency1: Double = 100
  • Frequency2 (Hertz) ranges from 0.5 to 8000 (Default: 100)

    Declaration

    Swift

    open dynamic var frequency2: Double = 100
  • Ring Mod Balance (Normalized Value) ranges from 0 to 1 (Default: 0.5)

    Declaration

    Swift

    open dynamic var balance: Double = 0.5
  • mix

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

    Declaration

    Swift

    open dynamic var mix: Double = 1
  • Tells whether the node is processing (ie. started, playing, or active)

    Declaration

    Swift

    open dynamic var isStarted = true
  • Initialize the ring modulator node

    • Parameters:
      • input: Input node to process
      • frequency1: Frequency1 (Hertz) ranges from 0.5 to 8000 (Default: 100)
      • frequency2: Frequency2 (Hertz) ranges from 0.5 to 8000 (Default: 100)
      • balance: Balance (Normalized Value) ranges from 0 to 1 (Default: 0.5)
      • mix: Mix (Normalized Value) ranges from 0 to 1 (Default: 1)

    Declaration

    Swift

    public init(
            _ input: AKNode?,
            frequency1: Double = 100,
            frequency2: Double = 100,
            balance: Double = 0.5,
            mix: Double = 1)

    Parameters

    input

    Input node to process

    frequency1

    Frequency1 (Hertz) ranges from 0.5 to 8000 (Default: 100)

    frequency2

    Frequency2 (Hertz) ranges from 0.5 to 8000 (Default: 100)

    balance

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

    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

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

    Declaration

    Swift

    open func stop()