AKFMOscillatorBank

open class AKFMOscillatorBank : AKPolyphonicNode, AKComponent

Frequency Modulation Polyphonic Oscillator

  • Declaration

    Swift

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

    Declaration

    Swift

    public static let ComponentDescription: AudioComponentDescription
  • Waveform of the oscillator

    Declaration

    Swift

    open var waveform: AKTable? { get set }
  • Ramp Duration represents the speed at which parameters are allowed to change

    Declaration

    Swift

    @objc
    open dynamic var rampDuration: Double { get set }
  • This multiplied by the baseFrequency gives the carrier frequency.

    Declaration

    Swift

    @objc
    open dynamic var carrierMultiplier: Double { get set }
  • This multiplied by the baseFrequency gives the modulating frequency.

    Declaration

    Swift

    @objc
    open dynamic var modulatingMultiplier: Double { get set }
  • This multiplied by the modulating frequency gives the modulation amplitude.

    Declaration

    Swift

    @objc
    open dynamic var modulationIndex: Double { get set }
  • Attack duration in seconds

    Declaration

    Swift

    @objc
    open dynamic var attackDuration: Double { get set }
  • Decay duration in seconds

    Declaration

    Swift

    @objc
    open dynamic var decayDuration: Double { get set }
  • Sustain Level

    Declaration

    Swift

    @objc
    open dynamic var sustainLevel: Double { get set }
  • Release duration in seconds

    Declaration

    Swift

    @objc
    open dynamic var releaseDuration: Double { get set }
  • Pitch Bend as number of semitones

    Declaration

    Swift

    @objc
    open dynamic var pitchBend: Double { get set }
  • Vibrato Depth in semitones

    Declaration

    Swift

    @objc
    open dynamic var vibratoDepth: Double { get set }
  • Vibrato Rate in Hz

    Declaration

    Swift

    @objc
    open dynamic var vibratoRate: Double { get set }
  • Initialize the oscillator with defaults

    Declaration

    Swift

    public convenience override init()
  • Initialize this oscillator node

    Declaration

    Swift

    @objc
    public init(
        waveform: AKTable,
        carrierMultiplier: Double = 1,
        modulatingMultiplier: Double = 1,
        modulationIndex: Double = 1,
        attackDuration: Double = 0.1,
        decayDuration: Double = 0.1,
        sustainLevel: Double = 1,
        releaseDuration: Double = 0.1,
        pitchBend: Double = 0,
        vibratoDepth: Double = 0,
        vibratoRate: Double = 0)

    Parameters

    waveform

    The waveform of oscillation

    carrierMultiplier

    This multiplied by the baseFrequency gives the carrier frequency.

    modulatingMultiplier

    This multiplied by the baseFrequency gives the modulating frequency.

    modulationIndex

    This multiplied by the modulating frequency gives the modulation amplitude.

    attackDuration

    Attack duration in seconds

    decayDuration

    Decay duration in seconds

    sustainLevel

    Sustain Level

    releaseDuration

    Release duration in seconds

    pitchBend

    Change of pitch in semitones

    vibratoDepth

    Vibrato size in semitones

    vibratoRate

    Frequency of vibrato in Hz