AKTanhDistortion

open class AKTanhDistortion : AKNode, AKToggleable, AKComponent, AKInput

Distortion using a modified hyperbolic tangent function.

  • Lower and upper bounds for Pregain

    Declaration

    Swift

    public static let pregainRange: ClosedRange<Double>
  • Lower and upper bounds for Postgain

    Declaration

    Swift

    public static let postgainRange: ClosedRange<Double>
  • Lower and upper bounds for Positive Shape Parameter

    Declaration

    Swift

    public static let positiveShapeParameterRange: ClosedRange<Double>
  • Lower and upper bounds for Negative Shape Parameter

    Declaration

    Swift

    public static let negativeShapeParameterRange: ClosedRange<Double>
  • Initial value for Pregain

    Declaration

    Swift

    public static let defaultPregain: Double
  • Initial value for Postgain

    Declaration

    Swift

    public static let defaultPostgain: Double
  • Initial value for Positive Shape Parameter

    Declaration

    Swift

    public static let defaultPositiveShapeParameter: Double
  • Initial value for Negative Shape Parameter

    Declaration

    Swift

    public static let defaultNegativeShapeParameter: Double
  • Ramp Duration represents the speed at which parameters are allowed to change

    Declaration

    Swift

    @objc
    open dynamic var rampDuration: Double { get set }
  • Determines the amount of gain applied to the signal before waveshaping. A value of 1 gives slight distortion.

    Declaration

    Swift

    @objc
    open dynamic var pregain: Double { get set }
  • Gain applied after waveshaping

    Declaration

    Swift

    @objc
    open dynamic var postgain: Double { get set }
  • Shape of the positive part of the signal. A value of 0 gets a flat clip.

    Declaration

    Swift

    @objc
    open dynamic var positiveShapeParameter: Double { get set }
  • Like the positive shape parameter, only for the negative part.

    Declaration

    Swift

    @objc
    open dynamic var negativeShapeParameter: Double { get set }
  • Tells whether the node is processing (ie. started, playing, or active)

    Declaration

    Swift

    @objc
    open dynamic var isStarted: Bool { get }
  • 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()