AKConvolution

open class AKConvolution : AKNode, AKToggleable, AKComponent, AKInput

This module will perform partitioned convolution on an input signal using an audio file as an impulse response.

  • Declaration

    Swift

    public typealias AKAudioUnitType = AKConvolutionAudioUnit
  • Four letter unique description of the node

    Declaration

    Swift

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

    Declaration

    Swift

    @objc
    open dynamic var isStarted: Bool { get }
  • Initialize this convolution node

    Declaration

    Swift

    @objc
    public init(_ input: AKNode? = nil,
                impulseResponseFileURL: URL,
                partitionLength: Int = 2_048)

    Parameters

    input

    Input node to process

    impulseResponseFileURL

    Location of the imulseResponse audio File

    partitionLength

    Partition length (in samples). Must be a power of 2. Lower values will add less latency, at the cost of requiring more CPU power.

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