AKAmplitudeTracker

open class AKAmplitudeTracker: AKNode, AKToggleable, AKComponent

Performs a root-mean-square on a signal to get overall amplitude of a signal. The output signal looks similar to that of a classic VU meter.

  • Four letter unique description of the node

    Declaration

    Swift

    public static let ComponentDescription = AudioComponentDescription(effect: "rmsq")
  • Tells whether the node is processing (ie. started, playing, or active)

    Declaration

    Swift

    open dynamic var isStarted: Bool
  • Detected amplitude

    Declaration

    Swift

    open dynamic var amplitude: Double
  • Threshold amplitude

    Declaration

    Swift

    open dynamic var threshold: Double = 1
  • Initialize this amplitude tracker node

    • Parameters:
      • input: Input node to process
      • halfPowerPoint: Half-power point (in Hz) of internal lowpass filter.

    Declaration

    Swift

    public init(
            _ input: AKNode?,
            halfPowerPoint: Double = 10,
            threshold: Double = 1,
            thresholdCallback: @escaping AKThresholdCallback = { _ in })

    Parameters

    input

    Input node to process

    halfPowerPoint

    Half-power point (in Hz) of internal lowpass filter.

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