AKDrip

open class AKDrip: AKNode, AKComponent

Physical model of the sound of dripping water. When triggered, it will produce a droplet of water.

  • Four letter unique description of the node

    Declaration

    Swift

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

    Declaration

    Swift

    open dynamic var rampTime: Double = AKSettings.rampTime
  • The intensity of the dripping sound.

    Declaration

    Swift

    open dynamic var intensity: Double = 10
  • The damping factor. Maximum value is 2.0.

    Declaration

    Swift

    open dynamic var dampingFactor: Double = 0.2
  • The amount of energy to add back into the system.

    Declaration

    Swift

    open dynamic var energyReturn: Double = 0
  • Main resonant frequency.

    Declaration

    Swift

    open dynamic var mainResonantFrequency: Double = 450
  • The first resonant frequency.

    Declaration

    Swift

    open dynamic var firstResonantFrequency: Double = 600
  • The second resonant frequency.

    Declaration

    Swift

    open dynamic var secondResonantFrequency: Double = 750
  • Amplitude.

    Declaration

    Swift

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

    Declaration

    Swift

    open dynamic var isStarted: Bool
  • Initialize the drip with defaults

    Declaration

    Swift

    public convenience override init()
  • Initialize this drip node

    • Parameters:
      • intensity: The intensity of the dripping sound.
      • dampingFactor: The damping factor. Maximum value is 2.0.
      • energyReturn: The amount of energy to add back into the system.
      • mainResonantFrequency: Main resonant frequency.
      • firstResonantFrequency: The first resonant frequency.
      • secondResonantFrequency: The second resonant frequency.
      • amplitude: Amplitude.

    Declaration

    Swift

    public init(
            intensity: Double,
            dampingFactor: Double = 0.2,
            energyReturn: Double = 0,
            mainResonantFrequency: Double = 450,
            firstResonantFrequency: Double = 600,
            secondResonantFrequency: Double = 750,
            amplitude: Double = 0.3)

    Parameters

    intensity

    The intensity of the dripping sound.

    dampingFactor

    The damping factor. Maximum value is 2.0.

    energyReturn

    The amount of energy to add back into the system.

    mainResonantFrequency

    Main resonant frequency.

    firstResonantFrequency

    The first resonant frequency.

    secondResonantFrequency

    The second resonant frequency.

    amplitude

    Amplitude.

  • Trigger the sound with an optional set of parameters

    Declaration

    Swift

    open func trigger()
  • 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()