AKRingModulator

open class AKRingModulator : AKNode, AKToggleable, AUEffect, AKInput

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

  • Four letter unique description of the node

    Declaration

    Swift

    public static let ComponentDescription: AudioComponentDescription
  • Frequency1 (Hertz) ranges from 0.5 to 8000 (Default: 100)

    Declaration

    Swift

    @objc
    open dynamic var frequency1: Double { get set }
  • Frequency2 (Hertz) ranges from 0.5 to 8000 (Default: 100)

    Declaration

    Swift

    @objc
    open dynamic var frequency2: Double { get set }
  • Ring Mod Balance (Normalized Value) ranges from 0 to 1 (Default: 0.5)

    Declaration

    Swift

    @objc
    open dynamic var balance: 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 ring modulator node

    Declaration

    Swift

    @objc
    public init(
        _ input: AKNode? = nil,
        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

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