AKClipper

open class AKClipper: AKNode, AKToggleable, AKComponent

Clips a signal to a predefined limit, in a soft manner, using one of three methods.

  • Four letter unique description of the node

    Declaration

    Swift

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

    Declaration

    Swift

    open dynamic var rampTime: Double = AKSettings.rampTime
  • Threshold / limiting value.

    Declaration

    Swift

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

    Declaration

    Swift

    open dynamic var isStarted: Bool
  • Initialize this clipper node

    • Parameters:
      • input: Input node to process
      • limit: Threshold / limiting value.

    Declaration

    Swift

    public init(
            _ input: AKNode?,
            limit: Double = 1.0)

    Parameters

    input

    Input node to process

    limit

    Threshold / limiting value.

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