AudioEffectPitchShift

    Adds a pitch-shifting audio effect to an audio bus.

    AudioEffectPitchShift.swift:20
    class AudioEffectPitchShift

    Raises or lowers the pitch of original sound.

    Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.

    Superclasses

    Citizens in SwiftGodot

    Conformances

    • protocol CustomStringConvertible

      A type with a customized textual representation.

    • protocol Equatable

      A type that can be compared for value equality.

    • protocol Hashable

      A type that can be hashed into a Hasher to produce an integer hash value.

    • protocol Identifiable<ID>

      A class of types whose instances hold the value of an entity with stable identity.

    • protocol VariantRepresentable

      Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.

    • protocol VariantStorable

      Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

    Types

    Type members

    Instance members

    • var fftSize: AudioEffectPitchShift.FFTSize

      The size of the Fast Fourier transform buffer. Higher values smooth out the effect over time, but have greater latency. The effects of this higher latency are especially noticeable on sounds that have sudden amplitude changes.

    • var oversampling: Int32

      The oversampling factor to use. Higher values result in better quality, but are more demanding on the CPU and may cause audio cracking if the CPU can’t keep up.

    • var pitchScale: Double

      The pitch scale to use. 1.0 is the default pitch and plays sounds unaffected. pitchScale can range from 0.0 (infinitely low pitch, inaudible) to 16 (16 times higher than the initial pitch).