AKOperationEffect

open class AKOperationEffect: AKNode, AKToggleable, AKComponent, AKInput

Operation-based effect

  • Four letter unique description of the node

    Declaration

    Swift

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

    Declaration

    Swift

    @objc open dynamic var isStarted: Bool
  • Parameters for changing internal operations

    Declaration

    Swift

    @objc open dynamic var parameters: [Double]
  • Initialize the generator for stereo (2 channels)

    Declaration

    Swift

    public convenience init(_ input: AKNode?,
                                numberOfChannels: Int,
                                operations: (AKStereoOperation, [AKOperation]) -> [AKOperation])

    Parameters

    input

    AKNode to use for processing

    numberOfChannels

    Only 2 channels are supported, but need to differentiate the initializer

    operations

    Array of operations [left, right]

  • Initialize the generator for stereo (2 channels)

    Declaration

    Swift

    public convenience init(_ input: AKNode?,
                                operation: (AKStereoOperation, [AKOperation]) -> AKComputedParameter)

    Parameters

    input

    AKNode to use for processing

    operation

    Operation to generate, can be mono or stereo

  • Initialize the effect with an input and a valid Sporth string

    Declaration

    Swift

    public init(_ input: AKNode?, sporth: String, customUgens: [AKCustomUgen] = [])

    Parameters

    input

    AKNode to use for processing

    sporth

    String of valid Sporth code

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